Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

File Share Policy Cost Estimation

The /policies/fileShares/estimateCost resource collection allows you to calculate the estimated monthly cost of using Microsoft Azure resources to protect Azure file shares. The estimated cost is available if you specified the backup schedule in backup policy settings.

Calculate Estimated Cost of File Share Backup Policy

The HTTP POST request to the /policies/fileShares/estimateCost endpoint calculates the estimated monthly cost for protecting resources by a backup policy per Azure file share.

SecurityBearer
Request
query Parameters
ResourceNameFilter
string or null

Returns only costs for protecting an Azure file share with the specified name.

x-veeam-parameter-group: CostEstimationFileShareOptions
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
backupType
required
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
isEnabled
required
boolean or null

Defines whether the policy is enabled.

name
required
string [ 1 .. 255 ] characters

Specifies a name of the backup policy.

required
Array of objects (PolicyRegionFromClient) non-empty

Specifies Azure regions where the protected resources reside.

tenantId
required
string

Specifies the Microsoft Azure ID assigned to a tenant for which the backup policy is created.

serviceAccountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions are used to perform backup of Azure file shares.

priority
integer <int64>

Specifies the priority ordinal number of the backup policy.

object or null (FileSharePolicyBackupItemsFromClient)

[Applies if the SelectedItems value is specified for the backupType parameter] Specifies information on Azure resources to protect by the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.FromClient
object or null (FileSharePolicyExcludedItemsFromClient)

Specifies Azure file shares to exclude from the backup scope.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.FromClient
description
string or null

Specifies a description of 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.

enableIndexing
boolean or null

Defines whether to perform indexing of the processed Azure file shares.

object or null (DailyFileShareSchedule)

Specifies daily schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
object or null (WeeklyFileShareSchedule)

Specifies weekly schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
object or null (MonthlyFileShareSchedule)

Specifies monthly schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/fileShares/estimateCost
Request samples
application/json
{
  • "priority": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "enableIndexing": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    }
}
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ],
  • "metadata": {
    }
}

Export Cost Estimation Report

The HTTP POST request to the /policies/fileShares/estimateCost/export endpoint exports the policy cost estimation 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.

Request Body schema: application/json
required
backupType
required
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
isEnabled
required
boolean or null

Defines whether the policy is enabled.

name
required
string [ 1 .. 255 ] characters

Specifies a name of the backup policy.

required
Array of objects (PolicyRegionFromClient) non-empty

Specifies Azure regions where the protected resources reside.

tenantId
required
string

Specifies the Microsoft Azure ID assigned to a tenant for which the backup policy is created.

serviceAccountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions are used to perform backup of Azure file shares.

priority
integer <int64>

Specifies the priority ordinal number of the backup policy.

object or null (FileSharePolicyBackupItemsFromClient)

[Applies if the SelectedItems value is specified for the backupType parameter] Specifies information on Azure resources to protect by the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.FromClient
object or null (FileSharePolicyExcludedItemsFromClient)

Specifies Azure file shares to exclude from the backup scope.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.FromClient
description
string or null

Specifies a description of 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.

enableIndexing
boolean or null

Defines whether to perform indexing of the processed Azure file shares.

object or null (DailyFileShareSchedule)

Specifies daily schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
object or null (WeeklyFileShareSchedule)

Specifies weekly schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
object or null (MonthlyFileShareSchedule)

Specifies monthly schedule settings for the backup policy.

x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.FileSharePolicies.Schedules
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/fileShares/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": {
    },
  • "isEnabled": true,
  • "enableIndexing": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    }
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}