Schemas

The following JSON schemas are used to represent resources in the/accounts/azure/repository collection in the Veeam Backup for Microsoft Azure REST API. Properties included in schemas represent account details. Some of the properties can be used as parameters in POST and PUT requests as well as for query parameter values in GET requests.

SchemasAzureAccountV2

Property

Type

Description

accountId

string

System ID assigned to an Azure account in the Veeam Backup for Microsoft Azure REST API.

applicationId

string($uuid)

Azure ID of an Azure AD application connected to the Azure account.

name

string

Name of the Azure account in Veeam Backup for Microsoft Azure.

description

string

Description of the Azure account.

region

array[string]

Type of Microsoft Azure environment: Global, Germany, China, USGovernment.

tenantId

string

Azure ID of a tenant to which the Azure account belongs.

tenantName

string

Name of the tenant.

_links

array

A list of methods and operations available for the Azure account in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

accountOrigin

array[string]

Authentication type of the Azure account: Device Authentication, Imported Certificate, Imported Secret.

expirationDate

string($date-time)

Date and time of account expiration.

accountState

array[string]

State of Azure account creation: Created, Creating.

accountPurpose

array[string]

Type of the account: Service, Repository.

adGroupId

string

Azure ID assigned to an Azure AD Group where an account belongs.

cloudState

array[string]

Status of the account in Microsoft Azure environment: Unknown, Valid, Invalid.

adGroupName

string

Name of the Azure AD Group.

SchemasAzureAuthenticationResultV2

Property

Type

Description

authenticatedByCertificate

boolean

Defines whether the type of an authentication is a certificate.

azureEnvironment

string($uuid)

Type of a Microsoft Azure environment: Global, Germany, China, USGovernment.

azureAccountPurpose

array[string]

Type of a the Azure account: Service, Repository.

accessTokenCache

string($byte)

The requested access token used for authentication.

displayableId

string

System ID of an account whose permissions are used for authentication.

familyName

string

Last name of the user whose credentials are used to log in to the Microsoft Azure Cross-platform Command Line Interface (Azure CLI).

givenName

string

First name of the user whose credentials are used to log in to the Microsoft Azure Cross-platform Command Line Interface (Azure CLI).

identityProvider

string

Name of the identity provider used to manage identity information.

tenantId

string

Azure ID of a tenant to which the Azure account belongs.

_links

array

A list of methods and operations available for the Azure repository account in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

accountOrigin

array[string]

Authentication type of the Azure account: Device Authentication, Imported Certificate, Imported Secret.

expirationDate

string($date-time)

Date of the Azure account expiration.

accountState

array[string]

Status of an account creation: Created, Creating.

accountPurpose

array[string]

Type of the Azure account: Service, Repository.

adGroupId

string

Azure ID assigned to an Azure AD Group where an account belongs.

cloudState

array[string]

Status of an account: Unknown, Valid, Invalid.

adGroupName

string

Name of an Azure AD Group.

SchemasSaveAzureAccountInfoV2

Property

Type

Description

accountInfo

AzureAccountInfoV2

Information on the repository account.

clientLoginParameters

ClientLoginParametersV2

Information on client login settings.

SchemasClientLoginParametersV2

Property

Type

Description

azureEnvironment

array[string]

Type of Microsoft Azure environment: Global, Germany, China, USGovernment.

applicationId

string($uuid)

Azure ID assigned to an Azure AD application.

clientSecret

string

Secret line generated on the Azure portal.

tenantId

string($uuid)

Azure ID assigned to a tenant.

applicationCertificate

string

Specifies the certificate ID generated for the Azure AD application.

certificatePassword

string

Password used to encrypt the certificate, used while creating the certificate.

purpose

array[string]

Type of the Azure account: Service, Repository.

SchemasDeviceCodeResultV2

Property

Type

Description

userCode

string

Single-use verification code that must be provided to authenticate Veeam Backup for Microsoft Azure to the Azure CLI.

deviceCode

string

Verification code used to verify the session between the client and the authorization server.

verificationUrl

string

URL the user must open and enter the userCode in a browser to complete verification.

expiresOn

string($date-time)

Date and time when deviceCode and userCode expire

interval

integer($int64)

Time interval the user must wait between polling requests (in seconds).

message

string

Message describing the steps of the authentication for the user.

clientId

string

Azure ID assigned to an Azure AD application.

resource

string

Identifier for the used API resource.

SchemasDeviceLoginParametersV2

Property

Type

Description

azureEnvironment

array[string]

Type of Microsoft Azure environment: Global, Germany, China, USGovernment.

userCode

string

Single-use verification code that must be provided to authenticate Veeam Backup for Microsoft Azure to the Azure CLI.

deviceCode

string

Verification code used to verify the session between the client and the authorization server.

verificationUrl

string

URL the user must open and enter the userCode in a browser to complete verification.

expiresOn

string($date-time)

Date and time when deviceCode and userCode expire

interval

integer($int64)

Time interval the user must wait between polling requests (in seconds).

message

string

Message describing the steps of the authentication for the user.

clientId

string

Azure ID assigned to an Azure AD application.

resource

string

Identifier for the used API resource.

azureAccountPurpose

array[string]

Type of the account: Service, Repository.

SchemasCreateRepositoryAccountInfoV2

Property

Type

Description

repositoryAccount

AzureAccountInfoV2

Information on an Azure repository account.

azureAuthenticationResult

AzureAuthenticationResultV2

Information on Azure account authentication.

SchemasAzureAccountInfoV2

Property

Type

Description

name

string

Name of the repository account in Veeam Backup for Microsoft Azure.

description

string

Description of the account.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.