Resource model for restore in same account for Azure Cosmos DB
APPLIES TO:
NoSQL
MongoDB
Gremlin
Table
This article explains the resource model for the Azure Cosmos DB point-in-time same account restore feature. It explains the parameters that support the continuous backup and resources that can be restored. This feature is supported in Azure Cosmos DB API for NoSQL, API for Gremlin, API for Table, and API for MongoDB.
Restore operation parameters for deleted containers and databases in same account
The RestoreParameters
resource contains the restore operation details including the account identifier, the time to restore, and resources that need to be restored.
Property Name | Description |
---|---|
restoreSource |
The instanceId of the source account to initiate the restore operation. |
restoreTimestampInUtc |
Point in time in UTC to restore the account. |
Sample restore operation resources in Azure Resource Manager
The following JSON is a sample database account resource with continuous backup enabled:
{
"properties": {
"resource": {
"id": "<database-container-collection-graph-or-table-name>",
"restoreParameters": {
"restoreSource": "/subscriptions/<subscription-id>/providers/Microsoft.DocumentDB/locations/<location>/restorableDatabaseAccounts/<account-instance-id>/",
"restoreTimestampInUtc": "<timestamp>"
}
}
}
}
The following JSON is a sample MongoDB collection restore request in a subscription with an ID of 00000000-0000-0000-0000-000000000000
, an account with an instance ID of abcd1234-d1c0-4645-a699-abcd1234
, a collection named legacy-records-coll
, and the timestamp 2023-01-01T00:00:00Z
.
{
"properties": {
"resource": {
"id": "legacy-records-coll",
"restoreParameters": {
"restoreSource": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234",
"restoreTimestampInUtc": "2023-02-01T00:00:00Z"
}
}
}
}
Next steps
- Migrate an account from periodic backup to continuous backup.
- Manage permissions required to restore data with continuous backup mode.
- Restore deleted container and database in same account.
- Restorable SQL database resource model.
- Restorable SQL container resource model.