Skip to content

Latest commit

 

History

History
1000 lines (815 loc) · 43.7 KB

how-to-restore-in-account-continuous-backup.md

File metadata and controls

1000 lines (815 loc) · 43.7 KB
Raw
title titleSuffix description author ms.author ms.reviewer ms.service ms.custom ms.topic ms.date zone_pivot_groups
Restore a container or database to the same, existing account
Azure Cosmos DB
Restore a deleted container or database to the same, existing Azure Cosmos DB account by using the Azure portal, the Azure CLI, Azure PowerShell, or an Azure Resource Manager template in continuous backup mod.
kanshiG
govindk
mjbrown
cosmos-db
build-2023, devx-track-azurecli, devx-track-azurepowershell, devx-track-arm-template
how-to
03/21/2024
azure-cosmos-db-apis-nosql-mongodb-gremlin-table

Restore a deleted container or database to the same Azure Cosmos DB account

[!INCLUDENoSQL, MongoDB, Gremlin, Table]

The Azure Cosmos DB point-in-time same-account restore feature helps you recover from an accidental deletion of a container or database. This feature restores the deleted database or container to the same, existing account in any region in which backups exist. Continuous backup mode allows you to restore to any point of time within the last 30 days.

Prerequisites

  • An Azure subscription. If you don't have an Azure subscription, create a free Azure account before you begin.
  • An Azure Cosmos DB account. You can choose one of the following options for an Azure Cosmos DB account:

Restore a deleted container or database

Use the Azure portal, the Azure CLI, Azure PowerShell, or an Azure Resource Manager template to restore a deleted container or database in the same, existing account.

Azure portal

Use the Azure portal to restore a deleted container or database. Child containers are also restored.

  1. Go to the Azure portal.

  2. Go to your Azure Cosmos DB account, and then go to the Point In Time Restore page.

    [!NOTE] The restore page in Azure portal is populated only if you have the Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read permission. To learn more about this permission, see Backup and restore permissions.

  3. Select the Restore to same account tab.

    :::image type="content" source="media/how-to-restore-in-account-continuous-backup.md\in-account-switch.png" lightbox="media/how-to-restore-in-account-continuous-backup.md\in-account-switch.png" alt-text="Screenshot of the options to restore a database or container to the same account.":::

  4. For Database, enter a search query to filter the event feed for relevant deletion events for a container or a database.

    :::image type="content" source="media/how-to-restore-in-account-continuous-backup.md/event-filter.png" lightbox="media/how-to-restore-in-account-continuous-backup.md/event-filter.png" alt-text="Screenshot of the event filter showing deletion events for containers and databases.":::

  5. Next, specify Start and End values to create a time window to use to filter deletion events.

    :::image type="content" source="media/how-to-restore-in-account-continuous-backup.md/date-filter.png" lightbox="media/how-to-restore-in-account-continuous-backup.md/date-filter.png" alt-text="Screenshot of the start and end date filters further filtering down deletion events.":::

    [!NOTE] The Start filter is limited to at most 30 days before the present date.

  6. Select Refresh to update the list of events for different resource types with your filters applied.

  7. Verify the time, and then select Restore to start restoration of the selected resource that was previously deleted.

    :::image type="content" source="media/how-to-restore-in-account-continuous-backup.md/restore-confirmation.png" lightbox="media/how-to-restore-in-account-continuous-backup.md/restore-confirmation.png" alt-text="Screenshot of the confirmation dialog prior to a restore operation.":::

    [!IMPORTANT] No more than three restore operations can be active at any time on the same account. Deleting the source account while a restore operation is in progress might result in the failure of the restore operation.

    [!NOTE] The event feed displays resources as Not restorable. The feed provides more information about why the resource can't be restored. In most cases, you must restore the parent database before you can restore any of the database's child containers.

  8. After you initiate a restore operation, track the operation by using the notifications area of the Azure portal. The notification provides the status of the resource that's being restored. While restore is in progress, the status of the container is Creating. After the restore operation completes, the status changes to Online.

Azure CLI

Use the Azure CLI to restore a deleted container or database. Child containers are also restored.

Important

The Azure CLI version 2.58.0 or later is required to access the in-account restore command.

:::zone pivot="api-nosql"

  1. Retrieve a list of all live and deleted restorable database accounts by using az cosmosdb restorable-database-account list:

    az cosmosdb restorable-database-account list \
    --account-name <name-of-account>

    [
  {
    "accountName": "deleted-account-1",
    "apiType": "Sql",
    "creationTime": "2020-08-02T22:23:00.095870+00:00",
    "deletionTime": "2020-08-02T22:26:13.483175+00:00",
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234",
    "location": "West US",
    "name": "abcd1234-d1c0-4645-a699-abcd1234",
    "restorableLocations": [
      {
        "locationName": "West US"
      },
      {
        "locationName": "East US"
      }
    ]
  }
]

  2. Use az cosmosdb sql restorable-database list to list all restorable versions of databases for live accounts:

    az cosmosdb sql restorable-database list \
    --instance-id <instance-id-of-account> \
    --location <location>

    [!NOTE] Listing all the restorable database deletion events allows you to choose the right database in a scenario in which the actual time of existence is unknown. If the event feed contains the Delete operation type in its response, then it’s a deleted database, and it can be restored within the same account. The restore time stamp can be set to any time stamp before the deletion time stamp and within the retention window.

  3. Use az cosmosdb sql restorable-container list to list all the versions of restorable containers within a specific database:

    az cosmosdb sql restorable-container list \
    --instance-id <instance-id-of-account> \
    --database-rid <owner-resource-id-of-database> \
    --location <location>

    [!NOTE] Listing all the restorable database deletion events allows you to choose the right container in a scenario in which the actual time of existence is unknown. If the event feed contains the Delete operation type in its response, then it’s a deleted container, and it can be restored within the same account. The restore time stamp can be set to any time stamp before the deletion time stamp and within the retention window.

  4. Initiate a restore operation for a deleted database by using az cosmosdb sql database restore. The restore timestamp is optional, if it isn't provided last deleted instance of database is restored.

    az cosmosdb sql database restore \
     --resource-group <resource-group-name> \ 
     --account-name <account-name> \  
     --name <database-name> \
     --restore-timestamp <timestamp> \
     --disable-ttl True

  5. Initiate a restore operation for a deleted container by using az cosmosdb sql container restore. The restore timestamp is optional, if it isn't provided last deleted instance of container is restored.

    az cosmosdb sql container restore \
     --resource-group <resource-group-name> \ 
     --account-name <account-name> \  
     --database-name <database-name> \
     --name <container-name> \
     --restore-timestamp <timestamp> \
     --disable-ttl True

:::zone-end

:::zone pivot="api-mongodb"

  1. Retrieve a list of all live and deleted restorable database accounts by using az cosmosdb restorable-database-account list:

    az cosmosdb restorable-database-account list \
    --account-name <name-of-account>

    [
  {
    "accountName": "deleted-account-1",
    "apiType": "Sql",
    "creationTime": "2020-08-02T22:23:00.095870+00:00",
    "deletionTime": "2020-08-02T22:26:13.483175+00:00",
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234",
    "location": "West US",
    "name": "abcd1234-d1c0-4645-a699-abcd1234",
    "restorableLocations": [
      {
        "locationName": "West US"
      },
      {
        "locationName": "East US"
      }
    ]
  }
]

  2. Use az cosmosdb mongodb restorable-database list to list all restorable versions of databases for live accounts:

    az cosmosdb mongodb restorable-database list \
    --instance-id <instance-id-of-account> \
    --location <location>

  3. Use az cosmosdb mongodb restorable-collection list to list all the versions of restorable collections within a specific database:

    az cosmosdb mongodb restorable-collection list \
    --instance-id <instance-id-of-account> \
    --database-rid <owner-resource-id-of-database> \
    --location <location>

  4. Initiate a restore operation for a deleted database by using az cosmosdb mongodb database restore. The restore timestamp is optional, if it not provided last deleted instance of database is restored.

    az cosmosdb mongodb database restore \
     --resource-group <resource-group-name> \ 
     --account-name <account-name> \  
     --name <database-name> \
     --restore-timestamp <timestamp>
     --disable-ttl True

  5. Initiate a restore operation for a deleted collection by using az cosmosdb mongodb collection restore,restore timestamp is optional, if it isn't provided last deleted instance of collection is restored.

    az cosmosdb mongodb collection restore \
     --resource-group <resource-group-name> \ 
     --account-name <account-name> \   
     --database-name <database-name> \
     --name <container-name> \
     --restore-timestamp <timestamp> \
     --disable-ttl True

:::zone-end

:::zone pivot="api-gremlin"

  1. Retrieve a list of all live and deleted restorable database accounts by using az cosmosdb restorable-database-account list:

    az cosmosdb restorable-database-account list \
    --account-name <name-of-account>

    [
  {
    "accountName": "deleted-account-1",
    "apiType": "Sql",
    "creationTime": "2020-08-02T22:23:00.095870+00:00",
    "deletionTime": "2020-08-02T22:26:13.483175+00:00",
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234",
    "location": "West US",
    "name": "abcd1234-d1c0-4645-a699-abcd1234",
    "restorableLocations": [
      {
        "locationName": "West US"
      },
      {
        "locationName": "East US"
      }
    ]
  }
]

  2. Use az cosmosdb gremlin restorable-database list to list all restorable versions of databases for live accounts:

    az cosmosdb gremlin restorable-database list \
    --instance-id <instance-id-of-account> \
    --location <location>

  3. Use az cosmosdb gremlin restorable-graph list to list all the versions of restorable graphs within a specific database:

    az cosmosdb gremlin restorable-graph list \
    --instance-id <instance-id-of-account> \
    --database-rid <owner-resource-id-of-database> \
    --location <location>

  4. Initiate a restore operation for a deleted database by using az cosmosdb gremlin database restore. The restore timestamp is optional, if it isn't provided last deleted instance of database is restored.

    az cosmosdb gremlin database restore \
    --resource-group <resource-group-name> \ 
    --account-name <account-name> \  
    --name <database-name> \ 
    --restore-timestamp <timestamp> \
    --disable-ttl True

  5. Initiate a restore operation for a deleted graph by using az cosmosdb gremlin graph restore. The restore timestamp is optional, if it isn't provided last deleted instance of graph is restored.

    az cosmosdb gremlin graph restore \
    --resource-group <resource-group-name> \ 
    --account-name <account-name> \  
    --database-name <database-name> \ 
    --name <graph-name> \ 
    --restore-timestamp <timestamp> \
    --disable-ttl True

:::zone-end

:::zone pivot="api-table"

  1. Retrieve a list of all live and deleted restorable database accounts by using az cosmosdb restorable-database-account list:

    az cosmosdb restorable-database-account list \
    --account-name <name-of-account>

    [
  {
    "accountName": "deleted-account-1",
    "apiType": "Sql",
    "creationTime": "2020-08-02T22:23:00.095870+00:00",
    "deletionTime": "2020-08-02T22:26:13.483175+00:00",
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234",
    "location": "West US",
    "name": "abcd1234-d1c0-4645-a699-abcd1234",
    "restorableLocations": [
      {
        "locationName": "West US"
      },
      {
        "locationName": "East US"
      }
    ]
  }
]

  2. Use az cosmosdb table restorable-table list to list all restorable versions of tables for live accounts:

    az cosmosdb table restorable-table list \
    --instance-id <instance-id-of-account> \
    --location <location>

  3. Initiate a restore operation for a deleted table by using az cosmosdb table restore. The restore timestamp is optional, if it isn't provided last deleted instance of table is restored.

    az cosmosdb table restore \
     --resource-group <resource-group-name> \
     --account-name <account-name> \
     --table-name <table-name> \
     --restore-timestamp <timestamp> \
     --disable-ttl True

:::zone-end

Azure PowerShell

Use Azure PowerShell to restore a deleted container or database. Child containers and databases are also restored.

Important

The Az.Cosmos DB module for Azure PowerShell version 1.14.1 or later is required to access the in-account restore cmdlets.

:::zone pivot="api-nosql"

  1. Retrieve a list of all live and deleted restorable database accounts by using the [Get-AzCosmosDBRestorableDatabaseAccount](/powershell/module/az.cosmosdb/get-azCosmos DBrestorabledatabaseaccount) cmdlet:

    Get-AzCosmosDBRestorableDatabaseAccount

    Id                        : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234
DatabaseAccountInstanceId : abcd1234-d1c0-4645-a699-abcd1234
Location                  : West US
DatabaseAccountName       : deleted-account-1
CreationTime              : 8/2/2020 10:23:00 PM
DeletionTime              : 8/2/2020 10:26:13 PM
ApiType                   : Sql
RestorableLocations       : {West US, East US}

    [!NOTE] The account has CreationTime or DeletionTime fields. These fields also exist for regions. These times allow you to choose the correct region and a valid time range to use when you restore a resource.

  2. Use the Get-AzCosmosDBSqlRestorableDatabase cmdlet to list all restorable versions of databases for live accounts:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    Location = "<location>"
}
Get-AzCosmosDBSqlRestorableDatabase @parameters

    [!NOTE] Listing all the restorable database deletion events allows you to choose the right database in a scenario where the actual time of existence is unknown. If the event feed contains the Delete operation type in its response, then it’s a deleted database and it can be restored within the same account. The restore timestamp can be set to any timestamp before the deletion timestamp and within the retention window.

  3. Use the Get-AzCosmosDBSqlRestorableContainer cmdlet to list all the versions of restorable containers within a specific database:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    DatabaseRId = "<owner-resource-id-of-database>"
    Location = "<location>"
}
Get-AzCosmosDBSqlRestorableContainer @parameters

    [!NOTE] Listing all the restorable database deletion events allows you allows you to choose the right container in a scenario where the actual time of existence is unknown. If the event feed contains the Delete operation type in its response, then it’s a deleted container and it can be restored within the same account. The restore timestamp can be set to any timestamp before the deletion timestamp and within the retention window.

  4. Initiate a restore operation for a deleted database by using the Restore-AzCosmos DBSqlDatabase cmdlet. Restore timestamp is optional. In absence of this timestamp last deleted instance of database is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    Name = "<database-name>"
    RestoreTimestampInUtc = "<timestamp>"
}
Restore-AzCosmos DBSqlDatabase @parameters

  5. Initiate a restore operation for a deleted container by using the Restore-AzCosmos DBSqlContainer cmdlet. Restore timestamp is optional. In absence of this timestamp last deleted instance of container is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    DatabaseName = "<database-name>"
    Name = "<container-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl= $true
}
Restore-AzCosmos DBSqlContainer @parameters

:::zone-end

:::zone pivot="api-mongodb"

  1. Retrieve a list of all live and deleted restorable database accounts by using the Get-AzCosmosDBRestorableDatabaseAccount cmdlet:

    Get-AzCosmosDBRestorableDatabaseAccount

    Id                        : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234
DatabaseAccountInstanceId : abcd1234-d1c0-4645-a699-abcd1234
Location                  : West US
DatabaseAccountName       : deleted-account-1
CreationTime              : 8/2/2020 10:23:00 PM
DeletionTime              : 8/2/2020 10:26:13 PM
ApiType                   : Sql
RestorableLocations       : {West US, East US}

    [!NOTE] The account has CreationTime or DeletionTime fields. These fields also exist for regions. These times allow you to choose the correct region and a valid time range to use when you restore a resource.

  2. Use Get-AzCosmosDBMongoDBRestorableDatabase to list all restorable versions of databases for live accounts:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    Location = "<location>"
}
Get-AzCosmosDBMongoDBRestorableDatabase @parameters

  3. Use the Get-AzCosmosDBMongoDBRestorableCollection cmdlet to list all the versions of restorable collections within a specific database. Restore timestamp is optional. In absence of this timestamp last deleted instance of collection is restored.

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    DatabaseRId = "<owner-resource-id-of-database>"
    Location = "<location>"
}
Get-AzCosmosDBMongoDBRestorableCollection @parameters

  4. Initiate a restore operation for a deleted database by using the Restore-AzCosmos DBMongoDBDatabase cmdlet:

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    Name = "<database-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl=$true 
}
Restore-AzCosmos DBMongoDBDatabase @parameters

  5. Initiate a restore operation for a deleted collection by using the Restore-AzCosmos DBMongoDBCollection cmdlet. Restore timestamp is optional, if not provided last deleted instance of collection is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    DatabaseName = "<database-name>"
    Name = "<collection-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl=$true 
}
Restore-AzCosmos DBMongoDBCollection @parameters 

:::zone-end

:::zone pivot="api-gremlin"

  1. Retrieve a list of all live and deleted restorable database accounts by using the Get-AzCosmosDBRestorableDatabaseAccount cmdlet:

    Get-AzCosmosDBRestorableDatabaseAccount

    Id                        : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234
DatabaseAccountInstanceId : abcd1234-d1c0-4645-a699-abcd1234
Location                  : West US
DatabaseAccountName       : deleted-account-1
CreationTime              : 8/2/2020 10:23:00 PM
DeletionTime              : 8/2/2020 10:26:13 PM
ApiType                   : Sql
RestorableLocations       : {West US, East US}

    [!NOTE] The account has CreationTime or DeletionTime fields. These fields also exist for regions. These times allow you to choose the correct region and a valid time range to use when you restore a resource.

  2. Use the Get-AzCosmosDBGremlinRestorableDatabase cmdlet to list all restorable versions of databases for live accounts:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    Location = "<location>"
}
Get-AzCosmosDBGremlinRestorableDatabase @parameters

  3. Use the Get-AzCosmosDBGremlinRestorableGraph cmdlet to list all versions of restorable graphs that are in a specific database:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    DatabaseRId = "<owner-resource-id-of-database>"
    Location = "<location>"
}
Get-AzCosmosDBGremlinRestorableGraph @parameters

  4. Initiate a restore operation for a deleted database by using the Restore-AzCosmos DBGremlinDatabase cmdlet, restore timestamp is optional, if not provided last deleted instance of database is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    Name = "<database-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl=$true 
}
Restore-AzCosmos DBGremlinDatabase @parameters

  5. Initiate a restore operation for a deleted graph by using the Restore-AzCosmos DBGremlinGraph cmdlet,restore timestamp is optional, if not provided last deleted instance of graph is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    DatabaseName = "<database-name>"
    Name = "<graph-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl=$true 
}
Restore-AzCosmos DBGremlinGraph @parameters

:::zone-end

:::zone pivot="api-table"

  1. Retrieve a list of all live and deleted restorable database accounts by using the [Get-AzCosmosDBRestorableDatabaseAccount](/powershell/module/az.cosmosdb/get-azCosmos DBrestorabledatabaseaccount) cmdlet:

    Get-AzCosmosDBRestorableDatabaseAccount

    Id                        : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/abcd1234-d1c0-4645-a699-abcd1234
DatabaseAccountInstanceId : abcd1234-d1c0-4645-a699-abcd1234
Location                  : West US
DatabaseAccountName       : deleted-account-1
CreationTime              : 8/2/2020 10:23:00 PM
DeletionTime              : 8/2/2020 10:26:13 PM
ApiType                   : Sql
RestorableLocations       : {West US, East US}

    [!NOTE] The account has CreationTime or DeletionTime fields. These fields also exist for regions. These times allow you to choose the correct region and a valid time range to use when you restore a resource.

  2. Use the [Get-AzCosmosDBTableRestorableTable](/powershell/module/az.cosmosdb/get-azCosmos DBtablerestorabletable) cmdlet to list all restorable versions of tables for live accounts:

    $parameters = @{
    DatabaseAccountInstanceId = "<instance-id-of-account>"
    Location = "<location>"
}
Get-AzCosmosDBTableRestorableTable @parameters

  3. Initiate a restore operation for a deleted table by using the Restore-AzCosmos DBTable cmdlet,restore timestamp is optional, if not provided last deleted instance of table is restored.

    $parameters = @{
    ResourceGroupName = "<resource-group-name>"
    AccountName = "<account-name>"
    Name = "<table-name>"
    RestoreTimestampInUtc = "<timestamp>"
    DisableTtl=$true 
}
Restore-AzCosmos DBTable @parameters

:::zone-end

Azure Resource Manager template

You can restore deleted containers and databases by using an Azure Resource Manager template.

:::zone pivot="api-nosql"

  1. Create or locate an Azure Cosmos DB resource in your template. Here's a generic example of a resource:

    {
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "name": "msdocs-example-arm",
      "type": "Microsoft.DocumentDB/databaseAccounts",
      "apiVersion": "2022-02-15-preview",
      "location": "West US",
      "properties": {
        "locations": [
          {
            "locationName": "West US"
          }
        ],
        "backupPolicy": {
          "type": "Continuous"
        },
        "databaseAccountOfferType": "Standard"
      }
    }
  ]
}

  2. To update the Azure Cosmos DB resource in your template:

    • Set properties.createMode to restore.
    • Define a properties.restoreParameters object.
    • Set properties.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
    • Set properties.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
    {
  "properties": {
    "name": "<name-of-database-or-container>",
    "restoreParameters": {
      "restoreSource": "<source-account-instance-id>",
      "restoreTimestampInUtc": "<timestamp>",
      "restoreWithTtlDisabled": "true" 
    },
    "createMode": "Restore"
  }
}

To restore an sql container, update the following template as follows:

  • Set resources.name to <accountname>/databasename>/<containername>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id container name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "resources":[{
            "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
            "apiVersion": "2023-11-15",
            "name": "<accountname>/<databasename>/<containername>",
            "properties": {
                "resource": {
                    "id": "<containername>",
                    "restoreParameters": {
                        "restoreSource": "/subscriptions/<subscriptionid>/providers/Microsoft.DocumentDB/locations/<lowercaselocationwithoutspace>/restorableDatabaseAccounts/<databaseaccountinstanceId>",
                        "restoreTimestampInUtc": "<restore timestamp is utc iso format>"
                    },
                    "createMode": "Restore"
                }
            }
        }
    ]
}

To restore an sql database, update following template as follows:

  • Set resources.name to <accountname>/databasename>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id database name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", 
            "apiVersion": "2023-11-15", 
            "name": "<account name>/<database name>", 
            "properties": { 
                "resource": { 
                    "id": "<database name>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionId>/providers/Microsoft.DocumentDB/locations/<location>/restorableDatabaseAccounts/<databaseaccountinstanceid>", 
                        "restoreTimestampInUtc": "restore timestamp" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
}
{
  "properties": {
    "name": "<name-of-database-or-collection>",
    "restoreParameters": {
      "restoreSource": "<source-account-instance-id>",
      "restoreTimestampInUtc": "<timestamp>",
      "restoreWithTtlDisabled": "true" 
    },
    "createMode": "Restore"
    }
}

:::zone-end

:::zone pivot="api-mongodb"

To restore a mongo collection, update the following template as follows:

  • Set resources.name to <accountname>/databasename>/<collectionname>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id collection name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/ mongoDBDatabases/collections", 
            "apiVersion": "2023-11-15", 
            "name": "<accountname>/<databasename>/<collectionname>", 
            "properties": { 
                "resource": { 
                    "id": "<collectionname>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionid>/providers/Microsoft.DocumentDB/locations/<lowercaselocationwithoutspace>/restorableDatabaseAccounts/<databaseaccountinstanceId>", 
                        "restoreTimestampInUtc": "<restore timestamp is utc iso format>" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
}

To restore a mongo database, update the following template as follows:

  • Set resources.name to <accountname>/databasename>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id database name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/mongoDBDatabases", 
            "apiVersion": "2023-11-15", 
            "name": "<account name>/<database name>", 
            "properties": { 
                "resource": { 
                    "id": "<database name>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionId>/providers/Microsoft.DocumentDB/locations/<location>/restorableDatabaseAccounts/<databaseaccountinstanceid>", 
                        "restoreTimestampInUtc": "restore timestamp" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
} 
{
  "properties": {
    "name": "<name-of-database-or-graph>",
    "restoreParameters": {
      "restoreSource": "<source-account-instance-id>",
      "restoreTimestampInUtc": "<timestamp>",
      "restoreWithTtlDisabled": "true" 
      },
    "createMode": "Restore"
    }
}

:::zone-end

:::zone pivot="api-gremlin"

To restore a gremlin graph, update the following template as follows:

  • Set resources.name to <accountname>/databasename>/<graphname>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id graph name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs", 
            "apiVersion": "2023-11-15", 
            "name": "<accountname>/<databasename>/<graphname>", 
            "properties": { 
                "resource": { 
                    "id": "<graphname>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionid>/providers/Microsoft.DocumentDB/locations/<lowercaselocationwithoutspace>/restorableDatabaseAccounts/<databaseaccountinstanceId>", 
                        "restoreTimestampInUtc": "<restore timestamp is utc iso format>" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
}

To restore a gremlin database, update the following template as follows:

  • Set resources.name to <accountname>/databasename>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id database name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", 
            "apiVersion": "2023-11-15", 
            "name": "<account name>/<database name>", 
            "properties": { 
                "resource": { 
                    "id": "<database name>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionId>/providers/Microsoft.DocumentDB/locations/<location>/restorableDatabaseAccounts/<databaseaccountinstanceid>", 
                        "restoreTimestampInUtc": "restore timestamp" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
}

:::zone-end

:::zone pivot="api-table"

{
  "properties": {
  "name": "<name-of-table>",
  "restoreParameters": {
    "restoreSource": "<source-account-instance-id>",
    "restoreTimestampInUtc": "<timestamp>", 
    "restoreWithTtlDisabled": "true" 
    },
    "createMode": "Restore"
    }
}

To restore a table, update the following template as follows:

  • Set resources.name to <accountname>/tablename>
  • Set resources.properties.resource.createMode to restore.
  • Set resources.properties.resource.restoreParameters.id table name.
  • Set resources.properties.resource.restoreParameters.restoreTimestampInUtc to a UTC time stamp.
  • Set resources.properties.resource.restoreParameters.restoreSource to the instance identifier of the account that is the source of the restore operation.
{ 
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", 
    "contentVersion": "1.0.0.0", 
    "resources": [ 
        { 
            "type": "Microsoft.DocumentDB/databaseAccounts/tables", 
            "apiVersion": "2023-11-15", 
            "name": "<account name>/<table name>", 
            "properties": { 
                "resource": { 
                    "id": "<table name>", 
                    "restoreParameters": { 
                        "restoreSource": "/subscriptions/<subscriptionId>/providers/Microsoft.DocumentDB/locations/<location>/restorableDatabaseAccounts/<databaseaccountinstanceid>", 
                        "restoreTimestampInUtc": "restore timestamp" 
                    }, 
                    "createMode": "Restore" 
                } 
            } 
        } 
    ] 
}

:::zone-end

Note

Use az cosmosdb restorable-database-account list to retrieve a list of instance identifiers for all live and deleted restorable database accounts.

  1. Deploy the template by using az deployment group create:

    az deployment group create \
    --resource-group <resource-group-name> \
    --template-file <template-filename>

Track the status of a restore operation

When a point-in-time restore is initiated for a deleted container or database, the operation is identified as an InAccount restore operation on the resource.

Azure portal

To get a list of restore operations for a specific resource, filter the activity log of the account by using the InAccount Restore Deleted search filter and a time filter. The list that's returns includes the UserPrincipalName field, which identifies the user who initiated the restore operation. For more information about how to access activity logs, see Audit point-in-time restore actions.

Azure CLI

Currently, to get the activity log of the account, you must use the Azure portal. Use the InAccount Restore Deleted search filter and a time filter.

Azure PowerShell

Currently, to get the activity log of the account, you must use the Azure portal. Use the InAccount Restore Deleted search filter and a time filter.

Azure Resource Manager template

Currently, to get the activity log of the account, you must use the Azure portal. Use the InAccount Restore Deleted search filter and a time filter.

Next steps