Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Azure Service Accounts

The /AzureServiceAccounts resource collection represents Microsoft Azure service accounts that are required to use the Azure archiver appliance when transferring backed-up data between different instances of Azure Blob Storage or to Azure Blob Storage Archive during backup copy jobs.

Get Azure Service Accounts

Returns a list of existing Microsoft Azure service accounts.

SecurityBearer
Request
query Parameters
displayName
string

Specifies a name of Microsoft Entra application associated with Microsoft Azure service account. To filter objects, you can use * and ? wildcard characters.

description
string

Specifies a description of Microsoft Azure service account.

Responses
200

OK

default

Operation failure response.

get/v8/AzureServiceAccounts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Azure Service Account
Adds a new Microsoft Azure service account.


x-codegen-request-body-name:  data
SecurityBearer 
Request 
Request Body schema: application/json
required
applicationName
string
Specifies a name of the Microsoft Entra application associated with Microsoft Azure service account.


 
description
string
Specifies a description of Microsoft Azure service account.


 
applicationId
string <uuid> 
Specifies the ID of the Microsoft Entra application.


 
azureEnvironment
string (AzureStorageEndpoint) 
Specifies a Microsoft Entra region.


 Enum: "Global" "Germany" "China" "Government"  
azureTenantId
string
Specifies the identification number of a Microsoft 365 organization in Microsoft Entra.


 
applicationCertificate
string <byte> 
Specifies the Base64 string of an SSL certificate that you want to use to access the Microsoft Entra application.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationSecret
string
Specifies an application secret for connecting to Microsoft Entra.


 
userCode
string
Specifies the code that you must copy and then specify on Microsoft Identity platform.


 
subscriptionIds
Array of strings
Specifies an array of subscriptions associated with a user account that was used to sign in to Microsoft Entra. For more information on how to get these parameters, see Get Subscriptions.


 
Responses 
200
OK


default
Operation failure response.


post/v8/AzureServiceAccounts
Request samples 
application/json
{
  • "applicationName": "string",
  • "description": "string",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "azureEnvironment": "Global",
  • "azureTenantId": "string",
  • "applicationCertificate": "string",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationSecret": "string",
  • "userCode": "string",
  • "subscriptionIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Azure",
  • "displayName": "string",
  • "description": "string",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "applicationCertificateThumbprint": "string",
  • "azureEnvironment": "Global",
  • "azureTenantId": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}
Get Azure Service Account Properties by Account ID
Returns a list of properties for Microsoft Azure service account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Azure",
  • "displayName": "string",
  • "description": "string",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "applicationCertificateThumbprint": "string",
  • "azureEnvironment": "Global",
  • "azureTenantId": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}
Edit Azure Service Account
Modifies properties of Microsoft Azure service account with the specified ID.


x-codegen-request-body-name:  data
SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
Request Body schema: application/json
required
description
string
Specifies a new description of Microsoft Azure service account.


 
applicationCertificate
string <byte> 
Specifies the Base64 string of an SSL certificate that you want to use to access the Microsoft Entra application.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationSecret
string
Specifies an application secret for connecting to Microsoft Entra.


 
userCode
string
Specifies the code that you must copy and then specify on Microsoft Identity platform.


 
subscriptionIds
Array of strings
Specifies an array of subscriptions associated with a user account that was used to sign in to Microsoft Entra. For more information on how to get these parameters, see Get Subscriptions.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/AzureServiceAccounts/{id}
Request samples 
application/json
{
  • "description": "string",
  • "applicationCertificate": "string",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationSecret": "string",
  • "userCode": "string",
  • "subscriptionIds": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Azure Service Account
Removes Microsoft Azure service account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/AzureServiceAccounts/{id}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Device Code
Allows you to obtain a device code to sign in to Microsoft Identity platform.


x-codegen-request-body-name:  requestData
SecurityBearer 
Request 
Request Body schema: application/json
required
azureEnvironment
string (AzureStorageEndpoint) 
Specifies a Microsoft Entra region.


 Enum: "Global" "Germany" "China" "Government"  
azureTenantId
string
Specifies the Microsoft 365 organization ID in Microsoft Entra.


 
Responses 
200
OK


default
Operation failure response.


post/v8/AzureServiceAccounts/DeviceCode
Request samples 
application/json
{
  • "azureEnvironment": "Global",
  • "azureTenantId": "string"
}
Response samples 
application/json
{
  • "userCode": "string",
  • "verificationUri": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "message": "string"
}
Get Subscriptions
Returns Microsoft Azure subscriptions associated with Microsoft Azure service account with the specified ID.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
query Parameters
subscriptionName
string
Specifies a name of the Microsoft Azure subscription.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Subscription by ID
Returns information about Microsoft Azure subscription with the specified ID.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}
Request samples 
Response samples 
application/json
{
  • "subscriptionId": "string",
  • "displayName": "string"
}
Get Resource Groups
Returns a list of resource groups that will be associated with the Azure archiver appliance.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
query Parameters
locationName
string
Specifies the Microsoft Entra region name. For more information on how to get this parameter, see Get Locations.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Resource Group by Name
Returns information about a resource group with the specified name.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
resourceGroupName
required
string
Specifies the resource group name. For more information on how to get this parameter, see Get Resource Groups.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "location": "string"
}
Get Locations
Returns a list of Microsoft Entra regions.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/Locations
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Location by Name
Returns information about a Microsoft Entra region with the specified name.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
locationName
required
string
Specifies the Microsoft Entra region name. For more information on how to get this parameter, see Get Locations.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/Locations/{locationName}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "displayName": "string"
}
Get Virtual Machine Sizes
Returns a list of Azure archiver appliances. The Azure archiver appliance is a small auxiliary machine in Microsoft Entra that is deployed and configured automatically by Veeam Backup for Microsoft 365.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
locationName
required
string
Specifies the Microsoft Entra region name. For more information on how to get this parameter, see Get Locations.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/Locations/{locationName}/VirtualMachineSizes
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Virtual Machine Size by Name
Returns information about the Azure archiver appliance with the specified name. The Azure archiver appliance is a small auxiliary machine in Microsoft Entra that is deployed and configured automatically by Veeam Backup for Microsoft 365.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
locationName
required
string
Specifies the Microsoft Entra region name. For more information on how to get this parameter, see Get Locations.


 
vmSizeName
required
string
Specifies the Azure archiver appliance name. For more information on how to get this parameter, see Get Virtual Machine Sizes.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/Locations/{locationName}/VirtualMachineSizes/{vmSizeName}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "coresCount": "string",
  • "memoryMB": 0,
  • "osDiskSizeMB": 0,
  • "resourceDiskSizeMB": 0
}
Get Virtual Networks
Returns a list of available virtual networks to which the Azure archiver appliance will be connected.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
resourceGroupName
required
string
Specifies the resource group name. For more information on how to get this parameter, see Get Resource Groups.


 
query Parameters
locationName
string
Specifies the Microsoft Entra region name. For more information on how to get this parameter, see Get Locations.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Virtual Network by Name
Returns information about a virtual network with the specified name.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
resourceGroupName
required
string
Specifies the resource group name. For more information on how to get this parameter, see Get Resource Groups.


 
virtualNetworkName
required
string
Specifies the virtual network name. For more information on how to get this parameter, see Get Virtual Networks.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks/{virtualNetworkName}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "location": "string",
  • "addressSpaces": [
    ]
}
Get Subnets
Returns a list of subnets within a virtual network with the specified name.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
resourceGroupName
required
string
Specifies the resource group name. For more information on how to get this parameter, see Get Resource Groups.


 
virtualNetworkName
required
string
Specifies the virtual network name. For more information on how to get this parameter, see Get Virtual Networks.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks/{virtualNetworkName}/Subnets
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Subnet by Name
Returns information about a subnet with the specified name within a virtual network with the specified name.


SecurityBearer 
Request 
path Parameters
serviceAccountId
required
string <uuid> 
Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Get Azure Service Accounts.


 
subscriptionId
required
string
Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Get Subscriptions.


 
resourceGroupName
required
string
Specifies the resource group name. For more information on how to get this parameter, see Get Resource Groups.


 
virtualNetworkName
required
string
Specifies the virtual network name. For more information on how to get this parameter, see Get Virtual Networks.


 
subnetName
required
string
Specifies the subnet name. For more information on how to get this parameter, see Get Subnets.


 
Responses 
200
OK


default
Operation failure response.


get/v8/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks/{virtualNetworkName}/Subnets/{subnetName}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "addressPrefix": "string"
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201