Modelo de recurso para o recurso de restauração pontual do Azure Cosmos DB

  • Artigo

APLICA-SE AO: NoSQL MongoDB Gremlin Table

Este artigo explica o modelo de recurso para o recurso de restauração pontual do Azure Cosmos DB. Ele explica os parâmetros que dão suporte a backup contínuo e aos recursos que podem ser restaurados. Esse recurso tem suporte 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 recurso da conta do banco de dados

O modelo de recurso da conta do banco de dados foi atualizado com algumas propriedades extra para dar suporte aos novos cenários de restauração. Essas propriedades são BackupPolicy, CreateMode e RestoreParameters.

BackupPolicy

Uma nova propriedade na política de backup no nível da conta, chamada Type no parâmetro backuppolicy, habilita backup contínuo e restauração pontual. Esse modo é chamado de backup contínuo. Você pode definir esse modo ao criar a conta ou ao migrar uma conta do modo periódico para contínuo. Depois que o modo contínuo está habilitado, todos os contêineres e bancos de dados criados nessa conta terão as funcionalidades de restauração pontual e backup contínuo habilitadas 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.

Observação

Atualmente, o recurso de restauração pontual está disponível para as contas do Azure Cosmos DB for NoSQL, API for MongoDB, de Tabela e Gremlin. Depois de criar uma conta com o modo contínuo, você não pode alterná-la para o modo periódico. A camada Continuous7Days está em versão prévia.

CreateMode

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

publicNetworkAccess

Essa 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 continuará com publicNetworkAccess como Enabled.

RestoreParameters

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

Nome da propriedade Descrição
restoreMode O modo de restauração deve ser PointInTime.
restoreSource A instanceId da conta de origem na qual a restauração será iniciada.
restoreTimestampInUtc Ponto no tempo em UTC para restauração da conta.
databasesToRestore Lista de objetos DatabaseRestoreResource para especificar quais bancos de dados e contêineres devem ser restaurados. Cada recurso representa um banco de dados individual e todas as coleções nesse banco de dados. Para obter mais informações, confira recursos do SQL restauráveis. Se o valor estiver vazio, a conta inteira será restaurada.
gremlinDatabasesToRestore Lista de objetos GremlinDatabaseRestoreResource para especificar quais bancos de dados e grafos devem ser restaurados. Cada recurso representa um banco de dados individual e todos os grafos nesse banco de dados. Para obter mais informações, confira recursos do Gremlin restauráveis. Se o valor estiver vazio, a conta inteira será restaurada.
restoreWithTtlDisabled valores de sinalizador booliano (true/false) para desabilitar o Time-To-Live na conta restaurada após a conclusão da restauração. (versão prévia)
tablesToRestore Lista de objetos TableRestoreResource para especificar quais tabelas devem ser restauradas. Cada recurso representa uma tabela sob esse banco de dados. Para obter mais informações, confira recursos de Tabela restauráveis. Se o valor estiver vazio, a conta inteira será restaurada.

Recurso de exemplo

O seguinte JSON é um exemplo de recurso de conta de banco de dados 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 as principais informações sobre recursos, incluindo:

  • Em que local os recursos podem ser restaurados
  • Locais dos quais os recursos podem ser restaurados
  • Carimbos de data/hora de quando operações-chave foram executadas nesses recursos.

Observação

Toda a API usada para enumerar esses recursos requer as seguintes permissões:

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

Conta de banco de dados restaurável

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

Nome da propriedade Descrição
ID O identificador exclusivo do recurso.
accountName O nome da conta de 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. Esse valor estará vazio se a conta estiver ativa.
apiType O tipo da API da conta do Azure Cosmos DB.
restorableLocations A lista de localizações de 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 ou migrada.
restorableLocations: deletionTime A hora, em UTC, em que a conta regional foi excluída. Esse 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 a camada de 30 dias, esse tempo pode ser no máximo 30 dias a partir de agora; para a camada de sete dias, esse tempo pode ser de até sete dias a partir de agora.

Para ver uma lista de todas as contas restauráveis, confira os artigos Contas de bancos de dados restauráveis – lista ou Contas de bancos de dados restauráveis – lista por localização.

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 você precisa descobrir quando esse evento ocorreu.

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que o banco de dados foi 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 do evento de banco de dados.
database As propriedades do banco de dados SQL no momento do evento,

Observação

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 de banco de dados
  • SystemOperation: evento de modificação de banco de dados disparado pelo sistema. Este evento não é iniciado pelo usuário

Para obter uma lista de todas as mutações de banco de dados, confira o artigo Bancos de dados NoSQL restauráveis – 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 ocorreram no contêiner SQL. Essas informações podem ajudar em cenários em que o contêiner foi modificado ou excluído e você precisa descobrir quando esse evento ocorreu.

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que esse evento de contêiner ocorreu.
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.

Observação

Os valores possíveis para operationType incluem:

  • Create: evento de criação do contêiner
  • Delete: evento de exclusão do contêiner
  • Replace: evento de modificação do contêiner
  • SystemOperation: evento de modificação de contêiner disparado pelo sistema. Este evento não é iniciado pelo usuário

Para obter uma lista de todas as mutações de contêiner no mesmo banco de dados, confira o artigo Contêineres NoSQL restauráveis – lista.

Recursos SQL restauráveis

Cada recurso representa um banco de dados individual e todos os contêineres nesse banco de dados.

Nome da propriedade Descrição
databaseName O nome do banco de dados SQL.
collectionNames A lista de contêineres SQL no banco de dados.

Para obter uma lista das combinações de banco de dados SQL e contêiner existentes na conta no carimbo de data/hora e na localização fornecidos, confira o artigo Recursos NoSQL restauráveis – 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 ocorreu.

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que o evento de banco de dados ocorreu.
ownerId O nome do banco de dados MongoDB.
ownerResourceId A ID do recurso do banco de dados MongoDB.
operationType O tipo de operação do evento de banco de dados.

Observação

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 de banco de dados
  • SystemOperation: evento de modificação de banco de dados disparado pelo sistema. Este evento não é iniciado pelo usuário

Para obter uma lista de todas as mutações de banco de dados, confira o artigo Bancos de dados MongoDB restauráveis – Lista.

Coleção do 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 do 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 ocorreu.

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que esse evento de coleção ocorreu.
ownerId O nome da coleção do MongoDB.
ownerResourceId A ID do recurso da coleção do MongoDB.
operationType O tipo de operação desse evento de coleção.

Observação

Os valores possíveis para operationType incluem:

  • Create: evento de criação da coleção
  • Delete: evento de exclusão da coleção
  • Replace: evento de modificação da coleção
  • SystemOperation: evento de modificação da coleção disparado pelo sistema. Este evento não é iniciado pelo usuário

Para obter uma lista de todas as mutações de contêiner no mesmo banco de dados, confira Recursos do MongoDB restauráveis – lista.

Recursos do MongoDB restauráveis

Cada recurso representa um banco de dados individual e todas as coleções nesse banco de dados.

Nome da propriedade Descrição
databaseName O nome do banco de dados MongoDB.
collectionNames A lista de coleções do MongoDB nesse banco de dados.

Para obter uma lista de todas as combinações de banco de dados e coleção do MongoDB existentes na conta no carimbo de data/hora e na localização fornecidos, confira Recursos do MongoDB restauráveis – lista.

Recursos restauráveis de grafo

Cada recurso representa um banco de dados individual e todos os grafos nesse banco de dados.

Nome da propriedade Descrição
gremlinDatabaseName O nome do banco de dados de grafo.
graphNames A lista de grafos nesse banco de dados.

Para obter uma lista de todas as combinações de banco de dados e grafos do Gremlin existentes na conta no carimbo de data/hora e na localização fornecidos, confira o artigo Recursos restauráveis de grafo – Lista.

Banco de dados de grafo restaurável

Cada recurso contém informações sobre um evento de mutação, como criação e exclusão, que ocorreram no banco de dados de grafo. 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 ocorreu.

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que o evento de banco de dados ocorreu.
ownerId O nome do banco de dados de grafo.
ownerResourceId A ID do recurso do banco de dados de grafo.
operationType O tipo de operação do evento de banco de dados.

Observação

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 de banco de dados
  • SystemOperation: evento de modificação de banco de dados disparado pelo sistema. Este evento não é iniciado pelo usuário.

Para obter um feed de eventos de todas as mutações no banco de dados do Gremlin, confira Bancos de dados de grafo restauráveis – lista.

Grafos restauráveis

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

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que esse evento de coleção ocorreu.
ownerId O nome da coleção de grafos.
ownerResourceId A ID do recurso da coleção de grafos.
operationType O tipo de operação desse evento de coleção.

Observação

Os valores possíveis para operationType incluem:

  • Create: evento de criação de grafo
  • Delete: evento de exclusão de grafo
  • Replace: evento de modificação de grafo
  • SystemOperation: evento de modificação da coleção disparado pelo sistema. Este evento não é iniciado pelo usuário.

Para obter uma lista de todas as mutações de contêiner no mesmo banco de dados, confira o artigo de grafo Grafos restauráveis – Lista.

Recursos restauráveis de tabela

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 for Table não especifica um banco de dados explícito.

Nome da propriedade Descrição
TableNames A lista de contêineres de Tabela nessa conta.

Para obter uma lista de tabelas existentes na conta no carimbo de data/hora e na localização fornecidos, confira o artigo Recursos restauráveis de Tabela – Lista.

Tabela restaurável

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

Nome da propriedade Descrição
eventTimestamp A hora, em UTC, em que o evento de banco de dados ocorreu.
ownerId O nome do banco de dados de Tabela.
ownerResourceId A ID do recurso do recurso de Tabela.
operationType O tipo de operação do evento de Tabela.

Observação

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 de Tabela
  • SystemOperation: evento de modificação de banco de dados disparado pelo sistema. Este evento não é iniciado pelo usuário

Para obter uma lista de todas as mutações de tabela no mesmo banco de dados, confira o artigo Tabela restaurável – Lista.

Próximas etapas