- About Veeam Backup for Microsoft Azure REST API
- Overview
- How To
- Changelog
- Authorization
- Availability Sets
- Availability Zones
- Asynchronous Operations
- Azure Key Vaults
- Azure Network Security Groups
- Azure Regions
- Azure Resource Groups
- Service Accounts
- getGet Collection of Service Accounts
- getGet Service Account Data
- delRemove Service Account
- postVerify Service Account Permissions
- postExport Service Account Required Permissions
- postExport Permissions by Application
- postExport Permissions by Token
- postExport Collection of Service Accounts
- postGet List of Tenants by Token
- postGet List of Subscriptions by Application
- postGet List of Microsoft Entra Groups
- postValidate User
- postAdd Service Account Using Existing Application
- putEdit Service Account Created Using Existing Application
- putValidate Editing of Service Account Created Using Existing Application
- getGet Service Accounts Suitable for Worker Management
- putSpecify Service Account for Worker Management
- Azure SQL Elastic Pools
- Azure Storage Accounts
- Azure Subscriptions
- Azure Tags
- Microsoft Entra Tenants
- Azure Virtual Networks
- Azure VM Schedule-Based Backup Policies
- getGet Collection of Azure VM Schedule-Based Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delRemove Backup Policy
- getGet Resources Selected for Backup Policy
- getGet Azure Regions Specified in Policy Settings
- getGet Resources Excluded from Backup Policy
- postSet Backup Policy Priority
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postResets Backup Policy CBT
- postExport Backup Policies
- getGet Collection of Protected Items
- getGet Resources Protected by Backup Policy
- Azure VM SLA-Based Backup Policies
- getGet Collection of SLA-Based Backup Policies
- postCreate SLA-Based Backup Policy
- postExport Collection of SLA-Based Backup Policies
- getGet SLA-Based Backup Policy Data
- putModify SLA-Based Backup Policy
- delRemove SLA-Based Backup Policy
- getGet SLA Compliance Information
- getGet Resources Protected by SLA-Based Backup Policy
- getGet Azure Regions Specified in SLA-Based Backup Policy Settings
- getGet Resources Excluded from SLA-Based Backup Policy
- postSet SLA-Based Backup Policy Priority
- postEnable SLA-Based Backup Policy
- postDisable SLA-Based Backup Policy
- getGet Collection of Protected Items
- getGet Resources Protected by SLA-Based Backup Policy
- postCalculate Estimated Cost of SLA-Based Backup Policy
- postExport Estimation Cost Report
- Azure VM Policy Cost Estimation
- Azure VMs
- Azure VM Sizes
- Azure VMs Protected by Veeam Backup for Microsoft Azure
- getGet Collection of Protected Azure VMs
- getGet Protected Azure VM Data
- postExport Collection of Protected Azure VMs
- postRemove Backups of Protected Azure VM
- postRemove Snapshots of Protected Azure VM
- postRemove Backups of Protected Azure VMs
- postRemove Snapshots of Protected Azure VMs
- postRemove Manual Snapshots of Protected Azure VMs
- postRemove Manual Snapshots of Protected Azure VM
- Azure VM Restore Points
- getGet Azure VM Restore Points
- getGet Azure VM Restore Point Data
- delRemove Azure VM Restore Point
- postPerform Virtual Disk Restore
- postPerform Azure VM Restore
- postPerform Azure VM File-Level Restore
- postRetrieve Data from Archive
- postExtend Data Availability Period
- getGet Collection of Virtual Disk Snapshots
- postVirtual Disk Snapshots Rescan
- getGet Collection of Azure VM Snapshots
- Backup Repositories
- getGet Collection of Backup Repositories
- postAdd Backup Repository
- getGet Backup Repository Data
- putModify Backup Repository Settings
- delRemove Backup Repository
- postGet Backup Repository Metadata
- postVerify Backup Repository Password
- postExport Collection of Backup Repositories
- getValidate Repository Deletion
- Configuration
- Configuration Backup
- getGet Backup Appliance Statistics
- postCreate Configuration Backup
- getGet Configuration Backup Settings
- putModify Configuration Backup Settings
- postStart Configuration Backup Export
- getCheck Status of Configuration Backup Export
- postDownload Configuration Backup File
- getGet Configuration Backup Restore Points
- getGet Configuration Backup Restore Point Data
- delRemove Configuration Backup Restore Point
- Cosmos DB Accounts
- Cosmos DB Account Point-in-Time Restore Information
- Cosmos DB Accounts Protected by Veeam Backup for Microsoft Azure
- getGet Collection of Protected Cosmos DB Accounts
- getGet Protected Cosmos DB Account Data
- postExport Collection of Protected Cosmos DB Accounts
- postRemove Backups of Protected Cosmos DB Account
- postRemove Manual Backups of Protected Cosmos DB Account
- postRemove Continuous Backups of Protected Cosmos DB Account
- postPerform Cosmos DB Account Point-in-time Restore
- Cosmos DB Backup Policies
- getGet Collection of Cosmos DB Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delRemove Backup Policy
- getGet Resources Selected for Backup Policy
- getGet Azure Regions Specified in Policy Settings
- getGet Resources Excluded from Backup Policy
- postSet Backup Policy Priority
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postExport Backup Policies
- getGet Collection of Protected Items
- getGet Resources Protected by Backup Policy
- Cosmos DB Policy Cost Estimation
- Cosmos DB Restore Points
- File-Level Recovery
- File Share Backup Policies
- getGet Collection of File Share Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delRemove Backup Policy
- getGet Resources Selected for Backup Policy
- getGet Azure Regions Specified in Policy Settings
- getGet Resources Excluded from Backup Policy
- postSet Backup Policy Priority
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postExport Backup Policies
- getGet Collection of Protected Items
- getGet Resources Protected by Backup Policy
- File Share Policy Cost Estimation
- File Share Restore Points
- File Shares
- File Shares Protected by Veeam Backup for Microsoft Azure
- Job Sessions
- getGet Collection of Sessions
- getGet Retention Session Data
- getGet Backup Session Data
- getGet Health Check Session Data
- getGet Restore Session Data
- getGet SQL Restore Session Data
- getGet Azure VM File-Level Restore Session Data
- getGet File Share File-Level Restore Session Data
- getGet Virtual Network Configuration Restore Session Data
- getGet Session Data
- getGet Session Log Details
- postStop Session
- postExport Collection of Sessions
- getGet Cosmos DB Restore Session Data
- License
- License Agreements
- Overview
- Retention Settings
- Security Certificates
- SLA Details
- SLA Templates
- SMTP and Database Accounts
- Storage Templates
- SQL Backup Policies
- getGet Collection of SQL Backup Policies
- postCreate Backup Policy
- getGet Backup Policy Data
- putModify Backup Policy
- delRemove Backup Policy
- getGet Resources Selected for Backup Policy
- getGet Azure Regions Specified in Policy Settings
- getGet Resources Excluded from Backup Policy
- postSet Backup Policy Priority
- postCheck Configuration of Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postExport Backup Policies
- getGet Collection of Protected Items
- getGet Resources Protected by Backup Policy
- SQL Databases
- SQL Databases Protected by Veeam Backup for Microsoft Azure
- SQL Policy Cost Estimation
- SQL Restore Points
- SQL Servers
- SSO Settings
- System
- Users
- Virtual Network Configuration Backup Policy
- getGet Virtual Network Configuration Backup Policy
- putModify Virtual Network Configuration Backup Policy
- postStart Virtual Network Configuration Backup Policy
- postStop Virtual Network Configuration Backup Policy
- postEnable Virtual Network Configuration Backup Policy
- postDisable Virtual Network Configuration Backup Policy
- postExport Virtual Network Configuration Backup Policy
- Virtual Network Configuration Protected by Veeam Backup for Microsoft Azure
- Virtual Network Configuration Restore Points
- Workers
- getGet Collection of Worker Instances
- delRemove Worker Instance
- postExport Collection of Worker Instances
- getGet Worker Instance Statistics
- getGet Collection of Worker Configurations
- postAdd Worker Configuration
- getGet Worker Configuration Data
- putModify Worker Configuration
- delRemove Worker Configuration
- postExport Worker Configurations
- postSpecify Worker Location and Service Account
- getGet Collection of Worker Profiles
- postAdd Worker Profiles
- getGet Worker Profiles for Region
- putModify Worker Profiles
- delRemove Worker Profiles
- postExport Worker Profiles
- getGet Worker Custom Tags
- putModify Worker Custom Tags
The /policy/slaBased/virtualMachines
resource collection represents Azure VM SLA-based backup policies configured in Veeam Backup for Microsoft Azure.
Get Collection of SLA-Based Backup Policies
The HTTP GET request to the /policy/slaBased/virtualMachines
endpoint retrieves a list of SLA-based backup policies configured in Veeam Backup for Microsoft Azure.
query Parameters
PolicyName | string or null Returns an SLA-based backup policy with the specified name. x-veeam-parameter-group: VmProtectionPolicyQueryOptions |
VirtualMachineId | string or null Returns only backup policies that protect an Azure VM with the specified ID. x-veeam-parameter-group: VmProtectionPolicyQueryOptions |
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Bad Request
Unauthorized
Forbidden
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines?PolicyName=string&VirtualMachineId=string&Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "priority": 0,
- "excludedItemsCount": 0,
- "tenantId": "string",
- "_links": {
}, - "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "snapshotStatus": "Canceled",
- "backupStatus": "Canceled",
- "nextExecutionTime": "2019-08-24T14:15:22Z",
- "isBackupConfigured": true,
- "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
]
}
Create SLA-Based Backup Policy
The HTTP POST request to the /policy/slaBased/virtualMachines
endpoint creates a new SLA-based backup policy.
Request Body schema: application/jsonrequired
isEnabled required | boolean or null Defines whether the policy is enabled. |
name required | string [ 1 .. 255 ] characters Specifies a name for the backup policy. |
required | Array of objects (PolicyRegionFromClient) non-empty Specifies Azure regions where the resources that will be backed up reside. |
required | object (SnapshotSettings) Specifies cloud-native snapshot settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Representation.V2 |
tenantId required | string Specifies the tenant ID to which the resources protected by the policy belong. |
serviceAccountId required | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the service account whose permissions will be used to create backups of Azure resources. |
slaPolicyTemplateId required | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the SLA template that will be assigned to the policy. |
object or null (PolicyBackupItemsFromClient) [Applies if the SelectedItems value is specified for the | |
object or null (PolicyExcludedItemsFromClient) Specifies Azure tags to identify the resources that should be excluded from the backup scope. | |
description | string or null Specifies a description for the backup policy. |
object or null (RetrySettings) Specifies the retry settings for the backup policy. | |
object or null (PolicyNotificationSettings) Specifies the notification settings for the backup policy. | |
object or null Specifies email notifications for an SLA-based backup policy. | |
backupType | string or null (BackupTypeNullable) Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access. x-external-type: Veeam.Azure.REST.Latest.BackupType |
storagePolicyTemplateId | string or null <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the storage template that will be assigned to the policy. |
Created
Bad Request
Unauthorized
Forbidden
Client Error
- Payload
- curl
{- "tenantId": "string",
- "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "regions": [
- {
- "regionId": "string"
}
], - "selectedItems": {
- "subscriptions": [
- {
- "subscriptionId": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "resourceGroups": [
- {
- "id": "string"
}
], - "virtualMachines": [
- {
- "id": "string"
}
], - "tagGroups": [
- {
- "name": "string",
- "subscription": {
- "subscriptionId": "string"
}, - "resourceGroup": {
- "id": "string"
}, - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "excludedItems": {
- "virtualMachines": [
- {
- "id": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}, - "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
- 201
- 400
- 401
- 403
- 415
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "priority": 0,
- "excludedItemsCount": 0,
- "tenantId": "string",
- "_links": {
}, - "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "snapshotStatus": "Canceled",
- "backupStatus": "Canceled",
- "nextExecutionTime": "2019-08-24T14:15:22Z",
- "isBackupConfigured": true,
- "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Export Collection of SLA-Based Backup Policies
The HTTP POST request to the /policy/slaBased/virtualMachines/export
endpoint exports a list of SLA-based backup policies to a .CSV or an .XML file.
header Parameters
Accept | string or null Specifies a media type of representation of the exported data. The default value is text/csv media type. |
Request Body schema: application/json
policyName | string or null Exports only data on an SLA-based backup policy with the specified name. |
protectionPolicyIds | Array of strings or null Specifies a list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to SLA-based backup policies whose data will be exported. |
OK
Bad Request
Unauthorized
Forbidden
Conflict
- Payload
- curl
{- "policyName": "string",
- "protectionPolicyIds": [
- "string"
]
}
- 400
- 401
- 403
- 409
{- "extensions": { },
- "status": 0,
- "title": "string",
- "detail": "string",
- "type": "string"
}
Get SLA-Based Backup Policy Data
The HTTP GET request to the /policy/slaBased/virtualMachines/{policyId}
endpoint retrieves settings of an SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "priority": 0,
- "excludedItemsCount": 0,
- "tenantId": "string",
- "_links": {
}, - "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "snapshotStatus": "Canceled",
- "backupStatus": "Canceled",
- "nextExecutionTime": "2019-08-24T14:15:22Z",
- "isBackupConfigured": true,
- "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Modify SLA-Based Backup Policy
The HTTP PUT request to the /policy/slaBased/virtualMachines/{policyId}
endpoint updates settings of an SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
Request Body schema: application/jsonrequired
isEnabled required | boolean or null Defines whether to enable the policy. |
name required | string [ 1 .. 255 ] characters Specifies a name for the backup policy. |
required | Array of objects (PolicyRegionFromClient) non-empty Specifies a list of regions where the backed-up Azure VM reside. |
required | object (SnapshotSettings) Specifies cloud-native snapshot settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Representation.V2 |
tenantId | string or null Specifies the tenant ID to which the resources protected by the policy belong. |
serviceAccountId | string or null <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the service account whose permissions will be used to perform backups of Azure VMs. |
object or null (PolicyBackupItemsFromClient) [Applies if the SelectedItems value is specified for the | |
object or null (PolicyExcludedItemsFromClient) Specifies Azure tags to identify the resources that should be excluded from the backup scope. | |
description | string or null Specifies a description for the policy. |
object or null (RetrySettings) Specifies the retry settings for the backup policy. | |
object or null (PolicyNotificationSettings) Specifies the notification settings for the backup policy. | |
object (SlaPolicyNotificationSettings) Specifies email notifications for an SLA-based backup policy. | |
backupType | string or null (BackupTypeNullable) Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access. x-external-type: Veeam.Azure.REST.Latest.BackupType |
slaPolicyTemplateId | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the SLA template that will be assigned to the policy. |
storagePolicyTemplateId | string or null <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the storage template that will be assigned to the policy. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Client Error
- Payload
- curl
{- "tenantId": "string",
- "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "regions": [
- {
- "regionId": "string"
}
], - "selectedItems": {
- "subscriptions": [
- {
- "subscriptionId": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "resourceGroups": [
- {
- "id": "string"
}
], - "virtualMachines": [
- {
- "id": "string"
}
], - "tagGroups": [
- {
- "name": "string",
- "subscription": {
- "subscriptionId": "string"
}, - "resourceGroup": {
- "id": "string"
}, - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "excludedItems": {
- "virtualMachines": [
- {
- "id": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}, - "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
- 400
- 401
- 403
- 404
- 415
{- "extensions": { },
- "status": 0,
- "title": "string",
- "detail": "string",
- "type": "string"
}
Remove SLA-Based Backup Policy
The HTTP DELETE request to the /policy/slaBased/virtualMachines/{policyId}
endpoint removes a specific SLA-based backup policy from the Veeam Backup for Microsoft Azure configuration database.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the SLA-based backup policy in the Veeam Backup for Microsoft Azure REST API. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
- curl
curl -i -X DELETE \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 400
- 401
- 403
- 404
- 409
{- "detail": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "status": 0,
- "title": "string",
- "traceId": "string",
- "type": "string"
}
Get SLA Compliance Information
The HTTP GET request to the /policy/slaBased/virtualMachines/slaReport
endpoint retrieves a list of SLA-based backup policies configured in Veeam Backup for Microsoft Azure and their SLA compliance information.
query Parameters
PolicyName | string or null Returns an SLA-based backup policy with the specified name. x-veeam-parameter-group: VmProtectionPolicySlaQueryOptions |
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Bad Request
Unauthorized
Forbidden
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/slaReport?PolicyName=string&Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "priority": 0,
- "excludedItemsCount": 0,
- "_links": {
}, - "name": "string",
- "description": "string",
- "isEnabled": true,
- "snapshotSlaReport": {
- "status": "MetSla",
- "achievedSlaPercent": 0
}, - "backupSlaReport": {
- "status": "MetSla",
- "achievedSlaPercent": 0
}, - "archiveSlaReport": {
- "status": "MetSla",
- "achievedSlaPercent": 0
}
}
]
}
Get Resources Protected by SLA-Based Backup Policy
The HTTP GET request to the /policy/slaBased/virtualMachines/{policyId}/selectedItems
endpoint retrieves information on resources protected by the SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
query Parameters
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/selectedItems?Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
- 404
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "subscription": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "environment": "Global",
- "tenantId": "string",
- "tenantName": "string",
- "name": "string",
- "status": "Active",
- "availability": "Available",
- "workerResourceGroupName": "string",
}, - "tag": {
- "id": "string",
- "name": "string",
- "value": "string"
}, - "resourceGroup": {
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "azureEnvironment": "Global",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "tenantId": "string",
- "regionId": "string",
}, - "virtualMachine": {
- "id": "string",
- "azureId": "string",
- "name": "string",
- "azureEnvironment": "Global",
- "osType": "Windows",
- "regionDisplayName": "string",
- "regionName": "string",
- "totalSizeInGB": 0,
- "vmSize": "string",
- "dnsName": "string",
- "virtualNetwork": "string",
- "subnet": "string",
- "publicIP": "string",
- "privateIP": "string",
- "hasEphemeralOsDisk": true,
- "availabilityZone": "string",
- "isController": true,
- "isDeleted": true,
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "subscriptionName": "string",
- "tenantId": "string",
- "resourceGroupName": "string",
}, - "deletedItem": {
- "type": "Subscription",
- "name": "string",
- "id": "string",
- "tagValue": "string",
- "tagName": "string"
}, - "tagGroup": {
- "name": "string",
- "subscription": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "environment": "Global",
- "tenantId": "string",
- "tenantName": "string",
- "name": "string",
- "status": "Active",
- "availability": "Available",
- "workerResourceGroupName": "string",
}, - "resourceGroup": {
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "azureEnvironment": "Global",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "tenantId": "string",
- "regionId": "string",
}, - "tags": [
- {
- "id": "string",
- "name": "string",
- "value": "string"
}
]
}
}
]
}
Get Azure Regions Specified in SLA-Based Backup Policy Settings
The HTTP GET request to the /policy/slaBased/virtualMachines/{policyId}/regions
retrieves a list of Azure regions added to the SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
query Parameters
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/regions?Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
- 404
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "id": "string",
- "name": "string",
- "resourceId": "string"
}
]
}
Get Resources Excluded from SLA-Based Backup Policy
The HTTP GET request to the /policy/slaBased/virtualMachines/{policyId}/excludedItems
endpoint retrieves a list of Azure VMs excluded from the SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
query Parameters
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
NameSearchPattern | string or null Returns only those items of a resource collection whose names match the specified search pattern in the parameter value. x-veeam-parameter-group: PolicyExcludedItemOptions |
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/excludedItems?Offset=0&Limit=-1&NameSearchPattern=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 400
- 401
- 403
- 404
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "virtualMachine": {
- "id": "string",
- "azureId": "string",
- "name": "string",
- "azureEnvironment": "Global",
- "osType": "Windows",
- "regionDisplayName": "string",
- "regionName": "string",
- "totalSizeInGB": 0,
- "vmSize": "string",
- "dnsName": "string",
- "virtualNetwork": "string",
- "subnet": "string",
- "publicIP": "string",
- "privateIP": "string",
- "hasEphemeralOsDisk": true,
- "availabilityZone": "string",
- "isController": true,
- "isDeleted": true,
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "subscriptionName": "string",
- "tenantId": "string",
- "resourceGroupName": "string",
}, - "deletedItem": {
- "type": "Subscription",
- "name": "string",
- "id": "string",
- "tagValue": "string",
- "tagName": "string"
}, - "tag": {
- "id": "string",
- "name": "string",
- "value": "string"
}
}
]
}
Set SLA-Based Backup Policy Priority
The HTTP POST request to the /policy/slaBased/virtualMachines/orderPriorities
endpoint sets the priority order for SLA-based backup policies.
Request Body schema: application/json
Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to SLA-based backup policies in the specified order.
No Content
Bad Request
Unauthorized
Forbidden
Client Error
- Payload
- curl
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
- 400
- 401
- 403
- 415
{- "extensions": { },
- "status": 0,
- "title": "string",
- "detail": "string",
- "type": "string"
}
Enable SLA-Based Backup Policy
The HTTP POST request to the /policy/slaBased/virtualMachines/{policyId}/enable
endpoint enables the disabled SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X POST \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/enable' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 400
- 401
- 403
- 404
{- "detail": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "status": 0,
- "title": "string",
- "traceId": "string",
- "type": "string"
}
Disable SLA-Based Backup Policy
The HTTP POST request to the /policy/slaBased/virtualMachines/{policyId}/disable
endpoint disables the enabled SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
- curl
curl -i -X POST \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/disable' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 400
- 401
- 403
- 404
{- "detail": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "status": 0,
- "title": "string",
- "traceId": "string",
- "type": "string"
}
Get Collection of Protected Items
The HTTP GET request to the /policy/slaBased/virtualMachines/protectedItems
endpoint retrieves a list of Azure VMs that are protected by SLA-based backup policies configured in Veeam Backup for Microsoft Azure.
query Parameters
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Unauthorized
Forbidden
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/protectedItems?Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 401
- 403
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "resourceId": "string",
- "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}
]
}
Get Resources Protected by SLA-Based Backup Policy
The HTTP GET request to the /policy/slaBased/virtualMachines/{policyId}/protectedItems
endpoint retrieves a list of Azure VMs protected by the SLA-based backup policy with the specified ID.
path Parameters
policyId required | string <uuid> Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API. |
query Parameters
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
OK
Unauthorized
Forbidden
- curl
curl -i -X GET \ 'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/protectedItems?Offset=0&Limit=-1' \ -H 'Authorization: YOUR_API_KEY_HERE'
- 200
- 401
- 403
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "resourceId": "string",
- "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}
]
}
Calculate Estimated Cost of SLA-Based Backup Policy
The HTTP POST request to the /policy/slaBased/virtualMachines/estimateCost
endpoint calculates the estimated monthly cost for protecting specific Azure VMs by an SLA-based backup policy.
query Parameters
VirtualMachineNameFilter | string or null Returns only costs for protecting an Azure VM with the specified name. x-veeam-parameter-group: CostEstimationOptions |
Offset | integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Limit | integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties |
Request Body schema: application/jsonrequired
priority | integer <int64> Specifies the priority ordinal number of the the SLA-based backup policy. |
tenantId | string or null Specifies the tenant ID to which the resources protected by the policy belong. |
serviceAccountId | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to access Microsoft Azure resources. |
Array of objects or null (PolicyRegionFromClient) Specifies Azure regions where the protected resources reside. | |
object or null (PolicyBackupItemsFromClient) [Applies if the SelectedItems value is specified for the | |
object or null (PolicyExcludedItemsFromClient) Specifies Azure tags to identify the resources that should be excluded from the backup scope. | |
name | string or null Specifies the name of the policy. |
description | string or null Specifies the description of the policy. |
object or null (RetrySettings) Specifies the retry settings for the backup policy. | |
object or null (PolicyNotificationSettings) Specifies the notification settings for the backup policy. | |
object (SlaPolicyNotificationSettings) Specifies email notifications for an SLA-based backup policy. | |
isEnabled | boolean or null Defines whether the policy is enabled. |
backupType | string or null (BackupTypeNullable) Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access. x-external-type: Veeam.Azure.REST.Latest.BackupType |
object (SnapshotSettings) Specifies cloud-native snapshot settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Representation.V2 | |
slaPolicyTemplateId | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the SLA template assigned to the policy. |
storagePolicyTemplateId | string or null <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the storage template assigned to the policy. |
OK
Bad Request
Unauthorized
Forbidden
Client Error
- Payload
- curl
{- "priority": 0,
- "tenantId": "string",
- "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "regions": [
- {
- "regionId": "string"
}
], - "selectedItems": {
- "subscriptions": [
- {
- "subscriptionId": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "resourceGroups": [
- {
- "id": "string"
}
], - "virtualMachines": [
- {
- "id": "string"
}
], - "tagGroups": [
- {
- "name": "string",
- "subscription": {
- "subscriptionId": "string"
}, - "resourceGroup": {
- "id": "string"
}, - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "excludedItems": {
- "virtualMachines": [
- {
- "id": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}, - "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
- 200
- 400
- 401
- 403
- 415
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "_links": {
}, - "results": [
- {
- "protectedItemHashId": "string",
- "name": "string",
- "snapshotCost": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "meters": [
- {
- "resource": {
- "name": "string",
- "hashId": "string",
- "resourceId": "string",
- "sizeGB": 0
}, - "meterId": "e6fc0364-7430-4b9c-ab62-413ce7e2f3ee",
- "description": "string",
- "unitPrice": 0,
- "unit": "OneGb",
- "quantityUsed": 0
}
], - "warnings": [
- {
- "id": "string"
}
]
}, - "backupCost": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "meters": [
- {
- "resource": {
- "name": "string",
- "hashId": "string",
- "resourceId": "string",
- "sizeGB": 0
}, - "meterId": "e6fc0364-7430-4b9c-ab62-413ce7e2f3ee",
- "description": "string",
- "unitPrice": 0,
- "unit": "OneGb",
- "quantityUsed": 0
}
], - "warnings": [
- {
- "id": "string"
}
]
}, - "archiveCost": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "meters": [
- {
- "resource": {
- "name": "string",
- "hashId": "string",
- "resourceId": "string",
- "sizeGB": 0
}, - "meterId": "e6fc0364-7430-4b9c-ab62-413ce7e2f3ee",
- "description": "string",
- "unitPrice": 0,
- "unit": "OneGb",
- "quantityUsed": 0
}
], - "warnings": [
- {
- "id": "string"
}
]
}, - "trafficCost": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "meters": [
- {
- "resource": {
- "name": "string",
- "hashId": "string",
- "resourceId": "string",
- "sizeGB": 0
}, - "meterId": "e6fc0364-7430-4b9c-ab62-413ce7e2f3ee",
- "description": "string",
- "unitPrice": 0,
- "unit": "OneGb",
- "quantityUsed": 0
}
], - "warnings": [
- {
- "id": "string"
}
]
}, - "transactionCost": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "meters": [
- {
- "resource": {
- "name": "string",
- "hashId": "string",
- "resourceId": "string",
- "sizeGB": 0
}, - "meterId": "e6fc0364-7430-4b9c-ab62-413ce7e2f3ee",
- "description": "string",
- "unitPrice": 0,
- "unit": "OneGb",
- "quantityUsed": 0
}
], - "warnings": [
- {
- "id": "string"
}
]
}, - "totalPerMonth": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "warnings": [
- {
- "id": "string"
}
]
}
], - "metadata": {
- "totals": {
- "totalCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "totalSnapshotCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "totalBackupCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "totalArchiveCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "totalTrafficCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}, - "totalTransactionCosts": {
- "pricePerMonth": {
- "value": 0,
- "type": "Valid"
}, - "warnings": [
- {
- "id": "string"
}
]
}
}, - "assumptions": {
- "diskOccupiedSizeRatio": 0,
- "dailyChurnRatio": 0,
- "dataCompressionRatio": 0
}, - "warningGroups": [
- {
- "type": "RetentionTooShortForCoolStorage",
- "text": "string",
- "warnings": [
- {
- "id": "string",
- "protectedItemHashIds": [
- "string"
], - "schedules": [
- "Daily"
], - "text": "string"
}
]
}
], - "currencyIsoCode": "string"
}
}
Export Estimation Cost Report
The HTTP POST request to the /policy/slaBased/virtualMachines/estimateCost/export
endpoint exports the estimation cost report to a .CSV or an .XML file.
header Parameters
Accept | string or null Specifies a media type of representation of the exported data. The default value is text/csv media type. x-position: 2 |
Request Body schema: application/jsonrequired
priority | integer <int64> Specifies the priority ordinal number of the the SLA-based backup policy. |
tenantId | string or null Specifies the tenant ID to which the resources protected by the policy belong. |
serviceAccountId | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to access Microsoft Azure resources. |
Array of objects or null (PolicyRegionFromClient) Specifies Azure regions where the protected resources reside. | |
object or null (PolicyBackupItemsFromClient) [Applies if the SelectedItems value is specified for the | |
object or null (PolicyExcludedItemsFromClient) Specifies Azure tags to identify the resources that should be excluded from the backup scope. | |
name | string or null Specifies the name of the policy. |
description | string or null Specifies the description of the policy. |
object or null (RetrySettings) Specifies the retry settings for the backup policy. | |
object or null (PolicyNotificationSettings) Specifies the notification settings for the backup policy. | |
object (SlaPolicyNotificationSettings) Specifies email notifications for an SLA-based backup policy. | |
isEnabled | boolean or null Defines whether the policy is enabled. |
backupType | string or null (BackupTypeNullable) Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access. x-external-type: Veeam.Azure.REST.Latest.BackupType |
object (SnapshotSettings) Specifies cloud-native snapshot settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Representation.V2 | |
slaPolicyTemplateId | string <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the SLA template assigned to the policy. |
storagePolicyTemplateId | string or null <uuid> Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the storage template assigned to the policy. |
OK
Bad Request
Unauthorized
Forbidden
Client Error
- Payload
- curl
{- "priority": 0,
- "tenantId": "string",
- "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
- "regions": [
- {
- "regionId": "string"
}
], - "selectedItems": {
- "subscriptions": [
- {
- "subscriptionId": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "resourceGroups": [
- {
- "id": "string"
}
], - "virtualMachines": [
- {
- "id": "string"
}
], - "tagGroups": [
- {
- "name": "string",
- "subscription": {
- "subscriptionId": "string"
}, - "resourceGroup": {
- "id": "string"
}, - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}, - "excludedItems": {
- "virtualMachines": [
- {
- "id": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}, - "name": "string",
- "description": "string",
- "retrySettings": {
- "retryCount": 0
}, - "policyNotificationSettings": {
- "recipient": "string",
- "notifyOnSuccess": true,
- "notifyOnWarning": true,
- "notifyOnFailure": true
}, - "slaPolicyNotificationSettings": {
- "enableNotifications": true,
- "email": "string",
- "includeOnlyMissedSlaAndRemovedVms": true,
- "sendOnSpecificTime": "string"
}, - "isEnabled": true,
- "backupType": "AllSubscriptions",
- "snapshotSettings": {
- "additionalTags": [
- {
- "name": "string",
- "value": "string"
}
], - "copyOriginalTags": true,
- "applicationAwareSnapshot": true,
- "userScripts": {
- "windows": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}, - "linux": {
- "scriptsEnabled": true,
- "preScriptPath": "string",
- "preScriptArguments": "string",
- "postScriptPath": "string",
- "postScriptArguments": "string",
- "repositorySnapshotsOnly": true,
- "ignoreExitCodes": true,
- "ignoreMissingScripts": true
}
}
}, - "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
- "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
- 400
- 401
- 403
- 415
{- "extensions": { },
- "status": 0,
- "title": "string",
- "detail": "string",
- "type": "string"
}