Restorable Sql Containers - List

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2024-11-15

Mostrar o feed de eventos de todas as mutações feitas em todos os contêineres de SQL do Azure Cosmos DB em um banco de dados específico. Isso ajuda no cenário em que o contêiner foi excluído acidentalmente. Essa 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=2024-11-15

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instanceId	path	True	string	O GUID instanceId de uma conta de banco de dados restaurável.
location	path	True	string	Região do Cosmos DB, com espaços entre palavras e cada palavra maiúscula.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.
endTime	query		string	Hora de término do feed de eventos de contêineres sql restauráveis.
restorableSqlDatabaseRid	query		string	A ID do recurso do banco de dados SQL.
startTime	query		string	Hora de início do feed de eventos de contêineres sql restauráveis.

Respostas

Nome	Tipo	Description
200 OK	RestorableSqlContainersListResult	A operação foi concluída com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBRestorableSqlContainerList

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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

Nome	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Política de criptografia de cliente do Cosmos DB.
CloudError	Uma resposta de erro do serviço.
CompositePath
CompositePathSortOrder	Ordem de classificação para caminhos compostos.
ComputedProperty	A definição de uma propriedade computada
ConflictResolutionMode	Indica o modo de resolução de conflitos.
ConflictResolutionPolicy	A política de resolução de conflitos para o contêiner.
Container	Objeto de recurso de contêiner do SQL do Cosmos DB
ContainerPartitionKey	A configuração da chave de partição a ser usada para particionar dados em várias partições
CreateMode	Enumerar para indicar o modo de criação da conta.
DataType	O tipo de dados ao qual o comportamento de indexação é aplicado.
DistanceFunction	A função de distância a ser usada para cálculo de distância entre vetores.
ErrorResponse	Resposta de erro.
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	Enumerar para indicar o tipo de operação do evento.
PartitionKind	Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner
Resource	O recurso de um evento de contêiner do SQL do Azure Cosmos DB
ResourceRestoreParameters	Parâmetros para indicar as informações sobre a restauração.
RestorableSqlContainerGetResult	Um evento de contêiner do SQL do Azure Cosmos DB
RestorableSqlContainersListResult	A resposta da operação Lista, que contém os eventos de contêiner sql e suas propriedades.
SpatialSpec
SpatialType	Indica o tipo espacial de índice.
UniqueKey	A chave exclusiva que impõe a restrição de exclusividade em documentos na coleção no serviço do 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 do Azure Cosmos DB.
VectorDataType	Indica o tipo de dados do vetor.
VectorEmbedding	Representa uma inserção de vetor. Uma inserção de vetor é usada para definir um campo de vetor nos documentos.
VectorEmbeddingPolicy	Política de Inserção de Vetor do Cosmos DB
VectorIndex
VectorIndexType	O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat.

ClientEncryptionIncludedPath

Nome	Tipo	Description
clientEncryptionKeyId	string	O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho.
encryptionAlgorithm	string	O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória.
path	string	Caminho que precisa ser criptografado.

ClientEncryptionPolicy

Política de criptografia de cliente do Cosmos DB.

Nome	Tipo	Description
includedPaths	ClientEncryptionIncludedPath[]	Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho.
policyFormatVersion	integer	Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro.

CompositePath

Nome	Tipo	Description
order	CompositePathSortOrder	Ordem de classificação para caminhos compostos.
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

CompositePathSortOrder

Ordem de classificação para caminhos compostos.

Nome	Tipo	Description
ascending	string
descending	string

ComputedProperty

A definição de uma propriedade computada

Nome	Tipo	Description
name	string	O nome de uma propriedade computada, por exemplo: "cp_lowerName"
query	string	A consulta que avalia o valor da propriedade computada, por exemplo : "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Indica o modo de resolução de conflitos.

Nome	Tipo	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

A política de resolução de conflitos para o contêiner.

Nome	Tipo	Valor padrão	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 contêiner do SQL do Cosmos DB

Nome	Tipo	Valor padrão	Description
_etag	string		Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle 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 contêiner.
_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 criptografia do cliente para o contêiner.
computedProperties	ComputedProperty[]		Lista de propriedades computadas
conflictResolutionPolicy	ConflictResolutionPolicy		A política de resolução de conflitos para o contêiner.
createMode	CreateMode	Default	Enumerar para indicar o modo de criação de recursos.
defaultTtl	integer		Tempo de vida padrão
id	string		Nome do contêiner do SQL do Cosmos DB
indexingPolicy	IndexingPolicy		A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento dentro do contêiner
partitionKey	ContainerPartitionKey		A configuração da chave de partição a ser usada para particionar dados em várias partições
restoreParameters	ResourceRestoreParameters		Parâmetros para indicar as informações sobre a restauração
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 do Azure Cosmos DB.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		A política de inserção de vetor para o contêiner.

ContainerPartitionKey

A configuração da chave de partição a ser usada para particionar dados em várias partições

Nome	Tipo	Valor padrão	Description
kind	PartitionKind	Hash	Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner
paths	string[]		Lista de caminhos usando quais dados dentro do contêiner podem ser particionados
systemKey	boolean		Indica se o contêiner está usando uma chave de partição gerada pelo sistema
version	integer		Indica a versão da definição da chave de partição

CreateMode

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

Nome	Tipo	Description
Default	string
Restore	string

DataType

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

Nome	Tipo	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

DistanceFunction

A função de distância a ser usada para cálculo de distância entre vetores.

Nome	Tipo	Description
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ExcludedPath

Nome	Tipo	Description
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

IncludedPath

Os caminhos incluídos na indexação

Nome	Tipo	Description
indexes	Indexes[]	Lista de índices para este caminho
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

Indexes

Os índices do caminho.

Nome	Tipo	Valor padrão	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 é precisão máxima.

IndexingMode

Indica o modo de indexação.

Nome	Tipo	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Política de indexação do Cosmos DB

Nome	Tipo	Valor padrão	Description
automatic	boolean		Indica se a política de indexação é automática
compositeIndexes	CompositePath[]		Lista de lista de caminhos compostos
excludedPaths	ExcludedPath[]		Lista de caminhos a serem excluídos da indexação
includedPaths	IncludedPath[]		Lista de caminhos a serem incluídos na indexação
indexingMode	IndexingMode	consistent	Indica o modo de indexação.
spatialIndexes	SpatialSpec[]		Lista de especificidades espaciais
vectorIndexes	VectorIndex[]		Lista de caminhos a serem incluídos na indexação de vetor

IndexKind

Indica o tipo de índice.

Nome	Tipo	Description
Hash	string
Range	string
Spatial	string

OperationType

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

Nome	Tipo	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner

Nome	Tipo	Description
Hash	string
MultiHash	string
Range	string

Resource

O recurso de um evento de contêiner do SQL do Azure Cosmos DB

Nome	Tipo	Description
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
canUndelete	string	Um estado desse contêiner para identificar se esse contêiner é restaurável na mesma conta.
canUndeleteReason	string	O motivo pelo qual esse contêiner não pode ser restaurado na mesma conta.
container	Container	Objeto de recurso de contêiner do SQL do Cosmos DB
eventTimestamp	string	Quando esse evento de contêiner aconteceu.
operationType	OperationType	O tipo de operação desse evento de contêiner.
ownerId	string	O nome desse contêiner SQL.
ownerResourceId	string	A ID do recurso desse contêiner do SQL.

ResourceRestoreParameters

Parâmetros para indicar as informações sobre a restauração.

Nome	Tipo	Description
restoreSource	string	A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).
restoreWithTtlDisabled	boolean	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.

RestorableSqlContainerGetResult

Um evento de contêiner do SQL do Azure Cosmos DB

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso do ARM.
name	string	O nome do recurso do ARM.
properties.resource	Resource	O recurso de um evento de contêiner do SQL do Azure Cosmos DB
type	string	O tipo de recurso do Azure.