Modelo de recursos da funcionalidade de restauro para um ponto anterior no tempo do Azure Cosmos DB

  • Artigo

APLICA-SE A: NoSQL MongoDB Gremlin Tabela

Este artigo explica o modelo de recursos da funcionalidade de restauro para um ponto anterior no tempo do Azure Cosmos DB. Ele explica os parâmetros que suportam o backup contínuo e os recursos que podem ser restaurados. Esse recurso é suportado na API do Azure Cosmos DB para SQL, na API do Azure Cosmos DB para Gremlin, na API de Tabela e na API do Azure Cosmos DB para MongoDB.

Modelo de recursos da conta de banco de dados

O modelo de recursos da conta de banco de dados é atualizado com algumas propriedades extras para dar suporte aos novos cenários de restauração. Essas propriedades são BackupPolicy, CreateModee RestoreParameters.

Política de backup

Uma nova propriedade na política de backup no nível da conta nomeada Type sob o parâmetro permite backup backuppolicy contínuo e restauração point-in-time. Esse modo é conhecido como backup contínuo. Você pode definir esse modo ao criar a conta ou ao migrar uma conta do modo periódico para o modo contínuo. Depois que o modo contínuo estiver habilitado, todos os contêineres e bancos de dados criados nessa conta terão a restauração point-in-time e o backup contínuo habilitados por padrão. A camada de backup contínuo pode ser definida como Continuous7Days ou Continuous30Days. Por padrão, se nenhuma camada for fornecida, Continuous30Days será aplicada na conta.

Nota

Atualmente, o recurso de restauração point-in-time está disponível para contas do Azure Cosmos DB para NoSQL, API para MongoDB, Table e Gremlin. Depois de criar uma conta com o modo contínuo, não é possível alterná-la para um modo periódico. A Continuous7Days camada está em pré-visualização.

CreateMode

Esta propriedade indica como a conta foi criada. Os valores possíveis são Default e Restore. Para executar uma restauração, defina esse valor como Restore e forneça os valores apropriados na RestoreParameters propriedade.

publicNetworkAccess

Esta propriedade precisa ser definida como 'Desabilitada' para restaurar a conta sem acesso à rede pública. Se essa propriedade não for fornecida, a restauração da conta prosseguirá com publicNetworkAccess como Enabled.

RestoreParameters

O RestoreParameters recurso contém os detalhes da operação de restauração, incluindo o ID da conta, o tempo de restauração e os recursos que precisam ser restaurados.

Nome de Propriedade Description
restoreMode O modo de restauração deve ser PointInTime.
restoreSource O instanceId da conta de origem a partir da qual a restauração será iniciada.
restoreTimestampInUtc Ponto no tempo em UTC para restaurar a conta.
databasesToRestore Lista de objetos para especificar quais bancos de DatabaseRestoreResource dados e contêineres devem ser restaurados. Cada recurso representa um único banco de dados e todas as coleções sob esse banco de dados. Para obter mais informações, consulte Recursos SQL restauráveis. Se esse valor estiver vazio, toda a conta será restaurada.
gremlinDatabasesToRestore Lista de objetos para especificar quais bancos de GremlinDatabaseRestoreResource dados e gráficos devem ser restaurados. Cada recurso representa um único banco de dados e todos os gráficos sob esse banco de dados. Para obter mais informações, consulte Recursos Gremlin restauráveis. Se esse valor estiver vazio, toda a conta será restaurada.
restoreWithTtlDisabled valores de sinalizador booleano (true/false) para desativar o Time-To-Live na conta restaurada após a conclusão da restauração. (pré-visualização)
tablesToRestore Lista de TableRestoreResource objetos para especificar quais tabelas devem ser restauradas. Cada recurso representa uma tabela sob esse banco de dados. Para obter mais informações, consulte Recursos de tabela restauráveis. Se esse valor estiver vazio, toda a conta será restaurada.

Recurso de exemplo

O JSON a seguir é um recurso de conta de banco de dados de exemplo com backup contínuo habilitado:

{
  "location": "westus",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "locations": [
      {
        "failoverPriority": "0",
        "locationName": "southcentralus",
        "isZoneRedundant": "false"
      }
    ],
    "createMode": "Restore",
    "publicNetworkAccess":"Disabled",
    "restoreParameters": {
      "restoreMode": "PointInTime",
      "restoreWithTtlDisabled" : "true",
      "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
      "restoreTimestampInUtc": "2020-06-11T22:05:09Z",
      "databasesToRestore": [
        {
          "databaseName": "db1",
          "collectionNames": [
            "collection1",
            "collection2"
          ]
        },
        {
          "databaseName": "db2",
          "collectionNames": [
            "collection3",
            "collection4"
          ]
        }
      ]
    },
    "backupPolicy": {
      "type": "Continuous"
      ...
    }
  }
}

Recursos restauráveis

Um conjunto de novos recursos e APIs está disponível para ajudá-lo a descobrir informações críticas sobre recursos, que incluem:

  • Onde os recursos podem ser restaurados
  • Locais onde os recursos podem ser restaurados a partir de
  • Carimbos de data/hora quando as principais operações foram executadas nesses recursos.

Nota

Todas as APIs usadas para enumerar esses recursos exigem as seguintes permissões:

  • Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read
  • Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read

Conta de banco de dados restaurável

Este recurso contém uma instância de conta de banco de dados que pode ser restaurada. A conta de banco de dados pode ser uma conta excluída ou uma conta ativa. Ele contém informações que permitem localizar a conta do banco de dados de origem que você deseja restaurar.

Nome de Propriedade Description
ID O identificador exclusivo do recurso.
accountName O nome da conta do banco de dados global.
creationTime A hora em UTC em que a conta foi criada ou migrada.
deletionTime A hora em UTC em que a conta foi excluída. Este valor fica vazio se a conta estiver ativa.
apiType O tipo de API da conta do Azure Cosmos DB.
restorableLocations A lista de locais onde a conta existia.
restorableLocations: locationName O nome da região da conta regional.
restorableLocations: regionalDatabaseAccountInstanceId O GUID da conta regional.
restorableLocations: creationTime A hora em UTC em que a conta regional foi criada r migrou.
restorableLocations: deletionTime A hora em UTC em que a conta regional foi excluída. Este valor estará vazio se a conta regional estiver ativa.
OldestRestorableTimeStamp A primeira hora em UTC para a qual a restauração pode ser executada. Para o nível de 30 dias, este tempo pode ser máximo de 30 dias a partir de agora, para o nível de sete dias, este tempo pode ser de até sete dias a partir de agora.

Para obter uma lista de todas as contas restauráveis, consulte Contas de banco de dados restauráveis - lista ou Contas de banco de dados restauráveis - lista por artigos de local .

Banco de dados SQL restaurável

Cada recurso contém informações de um evento de mutação, como criação e exclusão que ocorreram no Banco de dados SQL. Essas informações podem ajudar em cenários em que o banco de dados foi excluído acidentalmente e se você precisar descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que o banco de dados é criado ou excluído.
ownerId O nome do banco de dados SQL.
ownerResourceId A ID do recurso do banco de dados SQL,
operationType O tipo de operação deste evento de banco de dados.
database As propriedades do banco de dados SQL no momento do evento,

Nota

Os valores possíveis para operationType incluem:

  • Create: evento de criação de banco de dados
  • Delete: evento de exclusão de banco de dados
  • Replace: evento de modificação do banco de dados
  • SystemOperation: evento de modificação do banco de dados acionado pelo sistema. Este evento não é iniciado pelo utilizador

Para obter uma lista de todas as mutações de banco de dados, consulte Bancos de dados NoSQL restauráveis - artigo Lista .

Contêiner SQL restaurável

Cada recurso contém informações de um evento de mutação, como criação e exclusão que ocorreu no contêiner SQL. Essas informações podem ajudar em cenários em que o contêiner foi modificado ou excluído e se você precisar descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que esse evento de contêiner aconteceu.
ownerId O nome do contêiner SQL.
ownerResourceId A ID do recurso do contêiner SQL.
operationType O tipo de operação deste evento de contêiner.
container As propriedades do contêiner SQL no momento do evento.

Nota

Os valores possíveis para operationType incluem:

  • Create: evento de criação de contêiner
  • Delete: evento de exclusão de contêiner
  • Replace: evento de modificação do recipiente
  • SystemOperation: evento de modificação do recipiente acionado pelo sistema. Este evento não é iniciado pelo utilizador

Para obter uma lista de todas as mutações de contêiner no mesmo banco de dados, consulte Recipientes NoSQL restauráveis - artigo Lista .

Recursos SQL restauráveis

Cada recurso representa um único banco de dados e todos os contêineres sob esse banco de dados.

Nome de Propriedade Description
databaseName O nome do banco de dados SQL.
collectionNames A lista de contêineres SQL sob este banco de dados.

Para obter uma lista do banco de dados SQL e do combo de contêiner que existem na conta no carimbo de data/hora e no local determinados, consulte Recursos NoSQL restauráveis - Artigo de lista .

Banco de dados MongoDB restaurável

Cada recurso contém informações de um evento de mutação, como criação e exclusão que ocorreram no banco de dados MongoDB. Essas informações podem ajudar no cenário em que o banco de dados foi excluído acidentalmente e o usuário precisa descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que esse evento de banco de dados aconteceu.
ownerId O nome do banco de dados MongoDB.
ownerResourceId O ID do recurso do banco de dados MongoDB.
operationType O tipo de operação deste evento de banco de dados.

Nota

Os valores possíveis para operationType incluem:

  • Create: evento de criação de banco de dados
  • Delete: evento de exclusão de banco de dados
  • Replace: evento de modificação do banco de dados
  • SystemOperation: evento de modificação do banco de dados acionado pelo sistema. Este evento não é iniciado pelo utilizador

Para obter uma lista de todas as mutações do banco de dados, consulte Restorable Mongodb Databases - List article.

Coleção MongoDB restaurável

Cada recurso contém informações de um evento de mutação, como criação e exclusão que ocorreram na Coleção MongoDB. Essas informações podem ajudar em cenários em que a coleção foi modificada ou excluída, e o usuário precisa descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que este evento de recolha aconteceu.
ownerId O nome da coleção MongoDB.
ownerResourceId O ID do recurso da coleção MongoDB.
operationType O tipo de operação deste evento de coleção.

Nota

Os valores possíveis para operationType incluem:

  • Create: evento de criação de coleção
  • Delete: evento de exclusão de coleção
  • Replace: evento de modificação da coleção
  • SystemOperation: evento de modificação da coleção acionado pelo sistema. Este evento não é iniciado pelo utilizador

Para obter uma lista de todas as mutações de contêiner sob o mesmo banco de dados, consulte Recursos restauráveis do MongoDB - lista.

Recursos restauráveis do MongoDB

Cada recurso representa um único banco de dados e todas as coleções sob esse banco de dados.

Nome de Propriedade Description
databaseName O nome do banco de dados MongoDB.
collectionNames A lista de coleções MongoDB sob este banco de dados.

Para obter uma lista de todas as combinações de banco de dados e coleção do MongoDB que existem na conta no carimbo de data/hora e no local determinados, consulte Recursos restauráveis do MongoDB - lista.

Recursos do Gráfico Restaurável

Cada recurso representa um único banco de dados e todos os gráficos sob esse banco de dados.

Nome de Propriedade Description
gremlinDatabaseName O nome do banco de dados Graph.
graphNames A lista de gráficos sob este banco de dados.

Para obter uma lista de todos os bancos de dados Gremlin e combinações de gráficos que existem na conta no carimbo de data/hora e local determinados, consulte o artigo Recursos de gráfico restauráveis - Lista .

Banco de dados de gráficos restauráveis

Cada recurso contém informações sobre um evento de mutação, como uma criação e exclusão que ocorreram no banco de dados do Graph. Essas informações podem ajudar no cenário em que o banco de dados foi excluído acidentalmente e o usuário precisa descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que esse evento de banco de dados aconteceu.
ownerId O nome do banco de dados Graph.
ownerResourceId A ID do recurso do banco de dados Graph.
operationType O tipo de operação deste evento de banco de dados.

Nota

Os valores possíveis para operationType incluem:

  • Create: evento de criação de banco de dados
  • Delete: evento de exclusão de banco de dados
  • Replace: evento de modificação do banco de dados
  • SystemOperation: evento de modificação do banco de dados acionado pelo sistema. Esse evento não é iniciado pelo usuário.

Para obter um feed de eventos de todas as mutações no banco de dados Gremlin, consulte Bancos de dados gráficos restauráveis - lista.

Gráficos restauráveis

Cada recurso contém informações de um evento de mutação, como criação e exclusão que ocorreu no gráfico. Essas informações podem ajudar em cenários em que o gráfico foi modificado ou excluído, e se você precisar descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que este evento de recolha aconteceu.
ownerId O nome da coleção Graph.
ownerResourceId A ID do recurso da coleção Graph.
operationType O tipo de operação deste evento de coleção.

Nota

Os valores possíveis para operationType incluem:

  • Create: Evento de criação de gráfico
  • Delete: Evento de exclusão de gráfico
  • Replace: Evento de modificação do gráfico
  • SystemOperation: evento de modificação da coleção acionado pelo sistema. Esse evento não é iniciado pelo usuário.

Para obter uma lista de todas as mutações de contêiner no mesmo banco de dados, consulte o gráfico Gráficos restauráveis - Artigo de lista .

Recursos da tabela restaurável

Lista todas as Tabelas restauráveis do Azure Cosmos DB disponíveis para uma conta de banco de dados específica em um determinado momento e local. Observe que a API para Tabela não especifica um banco de dados explícito.

Nome de Propriedade Description
TableNames A lista de contêineres de tabela sob esta conta.

Para obter uma lista de tabelas que existem na conta no carimbo de data/hora e local determinados, consulte Recursos de tabela restauráveis - artigo Lista .

Mesa Restaurável

Cada recurso contém informações de um evento de mutação, como criação e exclusão, que ocorreu na Tabela. Essas informações podem ajudar em cenários em que a tabela foi modificada ou excluída e se você precisar descobrir quando esse evento aconteceu.

Nome de Propriedade Description
eventTimestamp A hora em UTC em que esse evento de banco de dados aconteceu.
ownerId O nome do banco de dados Tabela.
ownerResourceId A ID do recurso Tabela.
operationType O tipo de operação deste evento Table.

Nota

Os valores possíveis para operationType incluem:

  • Create: Evento de criação de tabela
  • Delete: Evento de exclusão de tabela
  • Replace: Evento de modificação da tabela
  • SystemOperation: evento de modificação do banco de dados acionado pelo sistema. Este evento não é iniciado pelo utilizador

Para obter uma lista de todas as mutações de tabela no mesmo banco de dados, consulte Tabela restaurável - Artigo de lista .

Próximos passos