Restorable Sql Containers - List

Mostrar o feed de eventos de todas as mutações efetuadas em todos os contentores SQL do Azure Cosmos DB numa base de dados específica. Isto ajuda num cenário em que o contentor foi eliminado acidentalmente. Esta API requer a permissão "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read"

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2023-11-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2023-11-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}

Parâmetros do URI

Name Em Necessário Tipo Description
instanceId
path True

string

O GUID instanceId de uma conta de base de dados recuperável.

location
path True

string

Região do Cosmos DB, com espaços entre palavras e cada palavra em maiúscula.

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar para esta operação.

endTime
query

string

Hora de fim do feed de eventos contentores sql restauráveis.

restorableSqlDatabaseRid
query

string

O ID do recurso da base de dados SQL.

startTime
query

string

Hora de início do feed de eventos contentores sql restauráveis.

Respostas

Name Tipo Description
200 OK

RestorableSqlContainersListResult

A operação foi concluída com êxito.

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Exemplos

CosmosDBRestorableSqlContainerList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2023-11-15&restorableSqlDatabaseRid=3fu-hg==

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00003e00-0000-0700-0000-5f85338a0000\""
          }
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "e85298a1-c631-4726-825e-a7ca092e9098",
      "properties": {
        "resource": {
          "_rid": "PrArcgAAAA==",
          "eventTimestamp": "2020-10-13T05:03:27Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Replace",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "defaultTtl": 12345,
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00004400-0000-0700-0000-5f85351f0000\""
          }
        }
      }
    }
  ]
}

Definições

Name Description
ClientEncryptionIncludedPath

.

ClientEncryptionPolicy

Política de encriptação de cliente do Cosmos DB.

CloudError

Uma resposta de erro do serviço.

CompositePath
CompositePathSortOrder

Sequência de ordenação para caminhos compostos.

ComputedProperty

A definição de uma propriedade calculada

ConflictResolutionMode

Indica o modo de resolução de conflitos.

ConflictResolutionPolicy

A política de resolução de conflitos para o contentor.

Container

Objeto de recurso de contentor SQL do Cosmos DB

ContainerPartitionKey

A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições

CreateMode

Enum para indicar o modo de criação da conta.

DataType

O tipo de dados ao qual o comportamento de indexação é aplicado.

ErrorResponse

Resposta a Erros.

ExcludedPath
IncludedPath

Os caminhos incluídos na indexação

Indexes

Os índices do caminho.

IndexingMode

Indica o modo de indexação.

IndexingPolicy

Política de indexação do Cosmos DB

IndexKind

Indica o tipo de índice.

OperationType

Enum para indicar o tipo de operação do evento.

PartitionKind

Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores

Resource

O recurso de um evento de contentor SQL do Azure Cosmos DB

ResourceRestoreParameters

Parâmetros para indicar as informações sobre o restauro.

RestorableSqlContainerGetResult

Um evento de contentor SQL do Azure Cosmos DB

RestorableSqlContainersListResult

A resposta da operação Lista, que contém os eventos de contentor SQL e as respetivas propriedades.

SpatialSpec
SpatialType

Indica o tipo espacial de índice.

UniqueKey

A chave exclusiva em que impõe a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB.

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço Azure Cosmos DB.

ClientEncryptionIncludedPath

.

Name Tipo Description
clientEncryptionKeyId

string

O identificador da Chave de Encriptação de Cliente a utilizar para encriptar o caminho.

encryptionAlgorithm

string

O algoritmo de encriptação que será utilizado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256.

encryptionType

string

O tipo de encriptação a executar. Por exemplo, Determinista, Aleatório.

path

string

Caminho que tem de ser encriptado.

ClientEncryptionPolicy

Política de encriptação de cliente do Cosmos DB.

Name Tipo Description
includedPaths

ClientEncryptionIncludedPath[]

Caminhos do item que precisam de encriptação juntamente com definições específicas do caminho.

policyFormatVersion

integer

Versão da definição da política de encriptação de cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de caminho de chave de partição e ID.

CloudError

Uma resposta de erro do serviço.

Name Tipo Description
error

ErrorResponse

Resposta a Erros.

CompositePath

Name Tipo Description
order

CompositePathSortOrder

Sequência de ordenação para caminhos compostos.

path

string

O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*)

CompositePathSortOrder

Sequência de ordenação para caminhos compostos.

Name Tipo Description
ascending

string

descending

string

ComputedProperty

A definição de uma propriedade calculada

Name Tipo Description
name

string

O nome de uma propriedade calculada, por exemplo - "cp_lowerName"

query

string

A consulta que avalia o valor da propriedade calculada, por exemplo : "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Indica o modo de resolução de conflitos.

Name Tipo Description
Custom

string

LastWriterWins

string

ConflictResolutionPolicy

A política de resolução de conflitos para o contentor.

Name Tipo Valor Predefinido Description
conflictResolutionPath

string

O caminho de resolução de conflitos no caso do modo LastWriterWins.

conflictResolutionProcedure

string

O procedimento para resolver conflitos no caso do modo personalizado.

mode

ConflictResolutionMode

LastWriterWins

Indica o modo de resolução de conflitos.

Container

Objeto de recurso de contentor SQL do Cosmos DB

Name Tipo Valor Predefinido Description
_etag

string

Uma propriedade gerada pelo sistema que representa o etag de recursos necessário para o controlo de simultaneidade otimista.

_rid

string

Uma propriedade gerada pelo sistema. Um identificador exclusivo.

_self

string

Uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de contentor.

_ts

number

Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.

analyticalStorageTtl

integer

TTL Analítico.

clientEncryptionPolicy

ClientEncryptionPolicy

A política de encriptação de cliente para o contentor.

computedProperties

ComputedProperty[]

Lista de propriedades calculadas

conflictResolutionPolicy

ConflictResolutionPolicy

A política de resolução de conflitos para o contentor.

createMode

CreateMode

Default

Enum para indicar o modo de criação de recursos.

defaultTtl

integer

Tempo de vida predefinido

id

string

Nome do contentor SQL do Cosmos DB

indexingPolicy

IndexingPolicy

A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos de documentos no contentor

partitionKey

ContainerPartitionKey

A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições

restoreParameters

ResourceRestoreParameters

Parâmetros para indicar as informações sobre o restauro

uniqueKeyPolicy

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço Azure Cosmos DB.

ContainerPartitionKey

A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições

Name Tipo Valor Predefinido Description
kind

PartitionKind

Hash

Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores

paths

string[]

Lista de caminhos que utilizam os dados no contentor que podem ser particionados

systemKey

boolean

Indica se o contentor está a utilizar uma chave de partição gerada pelo sistema

version

integer

Indica a versão da definição da chave de partição

CreateMode

Enum para indicar o modo de criação da conta.

Name Tipo Description
Default

string

Restore

string

DataType

O tipo de dados ao qual o comportamento de indexação é aplicado.

Name Tipo Description
LineString

string

MultiPolygon

string

Number

string

Point

string

Polygon

string

String

string

ErrorResponse

Resposta a Erros.

Name Tipo Description
code

string

Código de erro.

message

string

Mensagem de erro a indicar por que motivo a operação falhou.

ExcludedPath

Name Tipo Description
path

string

O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*)

IncludedPath

Os caminhos incluídos na indexação

Name Tipo Description
indexes

Indexes[]

Lista de índices para este caminho

path

string

O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*)

Indexes

Os índices do caminho.

Name Tipo Valor Predefinido Description
dataType

DataType

String

O tipo de dados ao qual o comportamento de indexação é aplicado.

kind

IndexKind

Hash

Indica o tipo de índice.

precision

integer

A precisão do índice. -1 é a precisão máxima.

IndexingMode

Indica o modo de indexação.

Name Tipo Description
consistent

string

lazy

string

none

string

IndexingPolicy

Política de indexação do Cosmos DB

Name Tipo Valor Predefinido Description
automatic

boolean

Indica se a política de indexação é automática

compositeIndexes

CompositePath[]

Lista de caminhos compostos

excludedPaths

ExcludedPath[]

Lista de caminhos a excluir da indexação

includedPaths

IncludedPath[]

Lista de caminhos a incluir na indexação

indexingMode

IndexingMode

consistent

Indica o modo de indexação.

spatialIndexes

SpatialSpec[]

Lista de especificações espaciais

IndexKind

Indica o tipo de índice.

Name Tipo Description
Hash

string

Range

string

Spatial

string

OperationType

Enum para indicar o tipo de operação do evento.

Name Tipo Description
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

PartitionKind

Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores

Name Tipo Description
Hash

string

MultiHash

string

Range

string

Resource

O recurso de um evento de contentor SQL do Azure Cosmos DB

Name Tipo Description
_rid

string

Uma propriedade gerada pelo sistema. Um identificador exclusivo.

canUndelete

string

Um estado deste contentor para identificar se este contentor é restabelecido na mesma conta.

canUndeleteReason

string

O motivo pelo qual este contentor não pode ser restaurado na mesma conta.

container

Container

Objeto de recurso de contentor SQL do Cosmos DB

eventTimestamp

string

O momento em que este evento de contentor aconteceu.

operationType

OperationType

O tipo de operação deste evento de contentor.

ownerId

string

O nome deste contentor SQL.

ownerResourceId

string

O ID de recurso deste contentor SQL.

ResourceRestoreParameters

Parâmetros para indicar as informações sobre o restauro.

Name Tipo Description
restoreSource

string

O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string

Hora para a qual a conta tem de ser restaurada (formato ISO-8601).

RestorableSqlContainerGetResult

Um evento de contentor SQL do Azure Cosmos DB

Name Tipo Description
id

string

O identificador de recurso exclusivo do recurso arm.

name

string

O nome do recurso arm.

properties.resource

Resource

O recurso de um evento de contentor SQL do Azure Cosmos DB

type

string

O tipo de recurso do Azure.

RestorableSqlContainersListResult

A resposta da operação Lista, que contém os eventos de contentor SQL e as respetivas propriedades.

Name Tipo Description
value

RestorableSqlContainerGetResult[]

Lista de eventos de contentor sqL e respetivas propriedades.

SpatialSpec

Name Tipo Description
path

string

O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*)

types

SpatialType[]

Lista do tipo espacial do caminho

SpatialType

Indica o tipo espacial de índice.

Name Tipo Description
LineString

string

MultiPolygon

string

Point

string

Polygon

string

UniqueKey

A chave exclusiva em que impõe a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB.

Name Tipo Description
paths

string[]

A lista de caminhos tem de ser exclusiva para cada documento no serviço Azure Cosmos DB

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço Azure Cosmos DB.

Name Tipo Description
uniqueKeys

UniqueKey[]

Lista de chaves exclusivas que impõem a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB.