Schemas

The following JSON schemas are used to represent resources in the/accounts/azure/service 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 Microsoft Azure environment: Global, Germany, China, USGovernment.

azureAccountPurpose

array[string]

Type of an account: Service, Repository.

accessTokenCache

string($byte)

The requested access token used for authentication.

displayableId

string

System ID of an account whose permission is used for authentication.

familyName

string

Last name of the user.

givenName

string

First name of the user.

identityProvider

string

Name of the identity provider used to manage identity information.

tenantId

string

Azure ID assigned to a tenant.

_links

array

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

accountOrigin

array[string]

Type of an account authentication: Device Authentication, Imported Certificate, Imported Secret.

expirationDate

string($date-time)

Date and time of account expiration.

accountState

array[string]

Status of an account creation: Created, Creating.

accountPurpose

array[string]

Type of an account: Service, Repository.

adGroupId

string

System 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.

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 generated for the Azure AD application.

certificatePassword

string

Password for the application certificate.

purpose

array[string]

Type of an account: Service, Repository.

SchemasListAdGroupRequestV2

Property

Type

Description

azureAuthentication

AzureAuthenticationResultV2

Information on authentication result.

SchemasDeviceCodeResultV2

Property

Type

Description

userCode

string

Code a user must input in their browser.

deviceCode

string

Code used by the application to check authentication status

verificationUrl

string

The URL the user should open in a browser to complete verification.

expiresOn

string($date-time)

Time in seconds before the deviceCode and userCode expire

interval

integer($int64)

Time interval in seconds the user should wait between polling requests.

message

string

Instructions for the user.

clientId

string

Azure ID assigned to an Azure AD application.

resource

string

Identifier for the used API resource.

SchemasAdGroupListingResultV2

Property

Type

Description

adGroups

AdGroupV2

Information on Azure AD group.

userAdPermissions

UserAdPermissionsV2

Specifies permissions for a user.

SchemasAdGroupV2

Property

Type

Description

id

string

Azure ID assigned to an Azure AD group.

displayName

string

Displayed name of an Azure AD group.

SchemasUserAdPermissionsV2

Property

Type

Description

userCanSetAdGroup

boolean

Defines whether a user has permission to create a new Azure AD group.

userCanRenewAdApp

boolean

Defines whether a user has permission to renew an Azure AD group.

SchemasDeviceLoginParametersV2

Property

Type

Description

azureEnvironment

array[string]

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

userCode

string

Code a user must input in a browser.

deviceCode

string

Code used by the application to check authentication status

verificationUrl

string

URL a user should open in a browser to complete verification.

expiresOn

string($date-time)

Time in seconds before the deviceCode and userCode expire

interval

integer($int64)

Time interval in seconds the user should wait between polling requests.

message

string

Instructions 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 an account: Service, Repository.

SchemasCreateServiceAccountInfoV2

Property

Type

Description

serviceAccount

AzureAccountInfoV2

Information on an Azure service account.

adGroupSettings

AdGroupSettingsV2

Specifies settings of an Azure AD group to which the service account belongs.

azureAuthenticationResult

AzureAuthenticationResultV2

Information on Azure account authentication.

SchemasAdGroupSettingsV2

Property

Type

Description

groupIdToAdd

string

Azure ID assigned to an Azure AD group to which a service account must be added.

groupNameToAdd

string

Name of an Azure AD group to which a service account must be added.

groupIdToRemove

string

Azure ID assigned to an Azure AD group from which a service account must be removed.

SchemasSaveAzureAccountInfoV2

Property

Type

Description

accountInfo

AzureAccountInfoV2

Information on the repository account.

clientLoginParameters

ClientLoginParametersV2

Information on client login settings.

SchemasSubscriptionsListingResultV2

Property

Type

Description

environment

array[string]

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

defaultTenantId

string

Azure ID assigned to the tenant associated with the subscription.

defaultTenantName

string

Name of the tenant associated with the subscription.

subscriptions

SubscriptionForServiceAccountV2

Information of the subscription to which a service account belongs.

requiredRolesHint

string

Specifies a hint for the user role.

SchemasSubscriptionForServiceAccountV2

Property

Type

Description

id

array[string]

Azure ID of the subscription to which the service account belongs.

name

string

Name of an Azure subscription.

tenantId

string

Azure ID assigned to the tenant associated with the subscription.

permissionsState

array[string]

Status of the permission: AvailableAll, AvailableSubset, Insufficient, Unknown.

missingPermissions

string

Specifies permissions that are missing in the current subscription.

I want to report a typo

There is a misspelling right here:

 

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