Azure VM SLA-Based Backup Policies

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.

SecurityBearer
Request
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/virtualMachines
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Create SLA-Based Backup Policy

The HTTP POST request to the /policy/slaBased/virtualMachines endpoint creates a new SLA-based backup policy.

SecurityBearer
Request
Request Body schema: application/json
required
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 backupType parameter] Specifies Azure resources to protect by the backup policy.

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.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
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.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policy/slaBased/virtualMachines
Request samples
application/json
{
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
  • "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "priority": 0,
  • "excludedItemsCount": 0,
  • "tenantId": "string",
  • "_links": {},
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "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.

x-veeam-custom-response: true
SecurityBearer
Request
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.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/policy/slaBased/virtualMachines/export
Request samples
application/json
{
  • "policyName": "string",
  • "protectionPolicyIds": [
    ]
}
Response samples
application/problem+json
{
  • "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.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/policy/slaBased/virtualMachines/{policyId}
Request samples
curl -i -X GET \
  'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "priority": 0,
  • "excludedItemsCount": 0,
  • "tenantId": "string",
  • "_links": {},
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "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.

SecurityBearer
Request
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/json
required
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 backupType parameter] Specifies Azure resources to protect by the backup policy.

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.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
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.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/policy/slaBased/virtualMachines/{policyId}
Request samples
application/json
{
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
  • "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Response samples
application/problem+json
{
  • "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.

SecurityBearer
Request
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.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

delete/api/v8/policy/slaBased/virtualMachines/{policyId}
Request samples
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "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.

SecurityBearer
Request
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/virtualMachines/slaReport
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/policy/slaBased/virtualMachines/{policyId}/selectedItems
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/policy/slaBased/virtualMachines/{policyId}/regions
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/policy/slaBased/virtualMachines/{policyId}/excludedItems
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
Request Body schema: application/json
Array
string <uuid>

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to SLA-based backup policies in the specified order.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policy/slaBased/virtualMachines/orderPriorities
Request samples
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
Response samples
application/problem+json
{
  • "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.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/policy/slaBased/virtualMachines/{policyId}/enable
Request samples
curl -i -X POST \
  'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/enable' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "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.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to the policy in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/policy/slaBased/virtualMachines/{policyId}/disable
Request samples
curl -i -X POST \
  'https://123.123.123.123/api/v8/policy/slaBased/virtualMachines/{policyId}/disable' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "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.

SecurityBearer
Request
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
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/virtualMachines/protectedItems
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
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
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/virtualMachines/{policyId}/protectedItems
Request samples
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'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

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.

SecurityBearer
Request
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/json
required
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 backupType parameter] Specifies Azure resources to protect by the backup policy.

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.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
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.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policy/slaBased/virtualMachines/estimateCost
Request samples
application/json
{
  • "priority": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
  • "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ],
  • "metadata": {
    }
}

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.

x-veeam-custom-response: true
SecurityBearer
Request
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/json
required
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 backupType parameter] Specifies Azure resources to protect by the backup policy.

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.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
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.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policy/slaBased/virtualMachines/estimateCost/export
Request samples
application/json
{
  • "priority": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "slaPolicyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "snapshotSettings": {
    },
  • "slaPolicyTemplateId": "73daf31b-f31a-40dd-b109-5f0980ce57a1",
  • "storagePolicyTemplateId": "f3f86a0e-d99c-4ff1-84bf-5cef773966ef"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}