Cosmos DB Policy Cost Estimation

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

Calculate Estimated Cost of Cosmos DB Backup Policy

The HTTP POST request to the /policies/cosmosDb/estimateCost endpoint calculates the estimated monthly cost for protecting resources by a backup policy per Cosmos DB account.

SecurityBearer

Request

query Parameters

ResourceNameFilter	string or null Returns only costs for protecting a Cosmos DB account with the specified name. x-veeam-parameter-group: CostEstimationCosmosDbOptions
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 Azure regions where the backed-up resources reside.
tenantId required	string Specifies a Microsoft Azure ID assigned to a tenant to which the protected Azure resources belong.
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 Cosmos DB backup.
priority	integer <int64> Specifies the priority ordinal number of the backup policy.
	object or null (CosmosDbPolicyBackupItemsFromClient) Specifies information on Azure resources to protect by the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (CosmosDbPolicyExcludedItemsFromClient) Specifies Azure resources to exclude from the backup scope. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
continuousBackupType	string or null (PolicyCosmosDbBackupTier) Specifies the retention period for Cosmos DB continuous backup. Enum: "Continuous7Days" "Continuous30Days" x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
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.
backupWorkloads	Array of strings or null (PolicyCosmosDbBackupWorkload) Specifies kinds of the Cosmos DB accounts protected using the Backup to repository option. Enum: "PostgreSQL" "MongoDB"
	object or null (DailyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies daily schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (WeeklyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies weekly schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (MonthlyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies monthly schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (YearlySchedule) Specifies the yearly schedule settings for the backup policy.
	object or null (HealthCheckSchedule) [Applies if backup creation is enabled for the backup policy] Specifies the health check schedule settings.
defaultBackupAccountId	string or null <int64> /[Applies only to backup policies that have the Backup to repository option enabled] Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a default database account that is used to access all protected databases.
	object or null (CosmosDbProcessingCredentials) Specifies a list of credentials that will be used to connect to the databases of the specified Cosmos DB accounts.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/cosmosDb/estimateCost

Request samples

Payload
curl

application/json

{"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"
}
],
"cosmosDbAccounts": [{"id": "string"
}
],
"tagGroups": [{"name": "string",
"subscription": {"subscriptionId": "string"
},
"resourceGroup": {"id": "string"
},
"tags": [{"name": "string",
"value": "string"
}
]
}
]
},
"excludedItems": {"cosmosDbAccounts": [{"id": "string"
}
],
"tags": [{"name": "string",
"value": "string"
}
]
},
"continuousBackupType": "Continuous7Days",
"name": "string",
"description": "string",
"retrySettings": {"retryCount": 0
},
"policyNotificationSettings": {"recipient": "string",
"notifyOnSuccess": true,
"notifyOnWarning": true,
"notifyOnFailure": true
},
"isEnabled": true,
"backupWorkloads": ["PostgreSQL"
],
"backupType": "AllSubscriptions",
"dailySchedule": {"dailyType": "Everyday",
"selectedDays": ["Sunday"
],
"backupSchedule": {"hours": [0
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"weeklySchedule": {"startTime": 0,
"backupSchedule": {"selectedDays": ["Sunday"
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"monthlySchedule": {"startTime": 0,
"type": "First",
"dayOfWeek": "Sunday",
"dayOfMonth": 0,
"monthlyLastDay": true,
"backupSchedule": {"selectedMonths": ["January"
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"yearlySchedule": {"startTime": 0,
"month": "January",
"type": "First",
"dayOfWeek": "Sunday",
"dayOfMonth": 0,
"yearlyLastDay": true,
"retentionYearsCount": 0,
"targetRepositoryId": "string"
},
"healthCheckSchedule": {"healthCheckEnabled": true,
"localTime": "2019-08-24T14:15:22Z",
"dayNumberInMonth": "First",
"daysOfWeek": ["Sunday"
],
"dayOfMonth": 0,
"months": ["January"
]
},
"defaultBackupAccountId": "string",
"credentialsList": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"protectedItemHashId": "string",
"name": "string",
"continuousBackupCost": {"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"
}
]
},
"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"
}
]
},
"totalContinuousBackupCosts": {"pricePerMonth": {"value": 0,
"type": "Valid"
},
"warnings": [{"id": "string"
}
]
},
"totalBackupCosts": {"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": {"dataCompressionRatio": 0
},
"warningGroups": [{"type": "RetentionTooShortForCoolStorage",
"text": "string",
"warnings": [{"id": "string",
"protectedItemHashIds": ["string"
],
"schedules": ["Daily"
],
"text": "string"
}
]
}
],
"currencyIsoCode": "string"
}
}

Export Cost Estimation Report

The HTTP POST request to the /policies/cosmosDb/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

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 Azure regions where the backed-up resources reside.
tenantId required	string Specifies a Microsoft Azure ID assigned to a tenant to which the protected Azure resources belong.
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 Cosmos DB backup.
priority	integer <int64> Specifies the priority ordinal number of the backup policy.
	object or null (CosmosDbPolicyBackupItemsFromClient) Specifies information on Azure resources to protect by the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (CosmosDbPolicyExcludedItemsFromClient) Specifies Azure resources to exclude from the backup scope. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
continuousBackupType	string or null (PolicyCosmosDbBackupTier) Specifies the retention period for Cosmos DB continuous backup. Enum: "Continuous7Days" "Continuous30Days" x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
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.
backupWorkloads	Array of strings or null (PolicyCosmosDbBackupWorkload) Specifies kinds of the Cosmos DB accounts protected using the Backup to repository option. Enum: "PostgreSQL" "MongoDB"
	object or null (DailyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies daily schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (WeeklyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies weekly schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (MonthlyCosmosDbSchedule) /[Applies only to backup policies that have the Backup to repository option enabled] Specifies monthly schedule settings for the backup policy. x-veeam-namespace: Veeam.Azure.REST.Latest.Representation.PolicyCosmosDb
	object or null (YearlySchedule) Specifies the yearly schedule settings for the backup policy.
	object or null (HealthCheckSchedule) [Applies if backup creation is enabled for the backup policy] Specifies the health check schedule settings.
defaultBackupAccountId	string or null <int64> /[Applies only to backup policies that have the Backup to repository option enabled] Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a default database account that is used to access all protected databases.
	object or null (CosmosDbProcessingCredentials) Specifies a list of credentials that will be used to connect to the databases of the specified Cosmos DB accounts.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/cosmosDb/estimateCost/export

Request samples

Payload
curl

application/json

{"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"
}
],
"cosmosDbAccounts": [{"id": "string"
}
],
"tagGroups": [{"name": "string",
"subscription": {"subscriptionId": "string"
},
"resourceGroup": {"id": "string"
},
"tags": [{"name": "string",
"value": "string"
}
]
}
]
},
"excludedItems": {"cosmosDbAccounts": [{"id": "string"
}
],
"tags": [{"name": "string",
"value": "string"
}
]
},
"continuousBackupType": "Continuous7Days",
"name": "string",
"description": "string",
"retrySettings": {"retryCount": 0
},
"policyNotificationSettings": {"recipient": "string",
"notifyOnSuccess": true,
"notifyOnWarning": true,
"notifyOnFailure": true
},
"isEnabled": true,
"backupWorkloads": ["PostgreSQL"
],
"backupType": "AllSubscriptions",
"dailySchedule": {"dailyType": "Everyday",
"selectedDays": ["Sunday"
],
"backupSchedule": {"hours": [0
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"weeklySchedule": {"startTime": 0,
"backupSchedule": {"selectedDays": ["Sunday"
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"monthlySchedule": {"startTime": 0,
"type": "First",
"dayOfWeek": "Sunday",
"dayOfMonth": 0,
"monthlyLastDay": true,
"backupSchedule": {"selectedMonths": ["January"
],
"retention": {"timeRetentionDuration": 0,
"retentionDurationType": "Days"
},
"targetRepositoryId": "string"
}
},
"yearlySchedule": {"startTime": 0,
"month": "January",
"type": "First",
"dayOfWeek": "Sunday",
"dayOfMonth": 0,
"yearlyLastDay": true,
"retentionYearsCount": 0,
"targetRepositoryId": "string"
},
"healthCheckSchedule": {"healthCheckEnabled": true,
"localTime": "2019-08-24T14:15:22Z",
"dayNumberInMonth": "First",
"daysOfWeek": ["Sunday"
],
"dayOfMonth": 0,
"months": ["January"
]
},
"defaultBackupAccountId": "string",
"credentialsList": {"property1": "string",
"property2": "string"
}
}

Response samples

application/problem+json

{"extensions": { },
"status": 0,
"title": "string",
"detail": "string",
"type": "string"
}

Cosmos DB Policy Cost Estimation

Calculate Estimated Cost of Cosmos DB Backup Policy

query Parameters

Request Body schema: application/jsonrequired

Export Cost Estimation Report

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required