Restorable Sql Containers - List
Mostrar o feed de eventos de todas as mutações feitas em todos os contêineres 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. 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=2024-11-15
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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
instance
|
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 em maiúsculas. |
subscription
|
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. |
end
|
query |
string |
Hora de término do feed de eventos de contêineres Sql restauráveis. |
|
restorable
|
query |
string |
A ID do recurso do banco de dados SQL. |
|
start
|
query |
string |
Hora de início do feed de eventos de contêineres Sql restauráveis. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A operação foi concluída com êxito. |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Segurança
azure_auth
Azure Ative Directory OAuth2 Flow
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Personificar a sua conta de utilizador |
Exemplos
CosmosDBRestorableSqlContainerList
Pedido de amostra
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 da amostra
{
"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 |
---|---|
Client |
. |
Client |
Política de criptografia do cliente Cosmos DB. |
Cloud |
Uma resposta de erro do serviço. |
Composite |
|
Composite |
Ordem de classificação para caminhos compostos. |
Computed |
A definição de uma propriedade computada |
Conflict |
Indica o modo de resolução de conflitos. |
Conflict |
A política de resolução de conflitos para o contêiner. |
Container |
Objeto de recurso de contêiner SQL do Cosmos DB |
Container |
A configuração da chave de partição a ser usada para particionar dados em várias partições |
Create |
Enum para indicar o modo de criação da conta. |
Data |
O tipo de dados ao qual o comportamento de indexação é aplicado. |
Distance |
A função de distância a ser usada para o cálculo de distância entre vetores. |
Error |
Resposta de erro. |
Excluded |
|
Included |
Os caminhos incluídos na indexação |
Indexes |
Os índices para o caminho. |
Indexing |
Indica o modo de indexação. |
Indexing |
Política de indexação do Cosmos DB |
Index |
Indica o tipo de índice. |
Operation |
Enum para indicar o tipo de operação do evento. |
Partition |
Indica o tipo de algoritmo usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas para criação de contêiner |
Resource |
O recurso de um evento de contêiner SQL do Azure Cosmos DB |
Resource |
Parâmetros para indicar as informações sobre a restauração. |
Restorable |
Um evento de contêiner SQL do Azure Cosmos DB |
Restorable |
A resposta da operação List, que contém os eventos de contêiner SQL e suas propriedades. |
Spatial |
|
Spatial |
Indica o tipo espacial de índice. |
Unique |
A chave exclusiva que impõe a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB. |
Unique |
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. |
Vector |
Indica o tipo de dados do vetor. |
Vector |
Representa uma incorporação vetorial. Uma incorporação vetorial é usada para definir um campo vetorial nos documentos. |
Vector |
Política de incorporação vetorial do Cosmos DB |
Vector |
|
Vector |
O tipo de índice do vetor. Atualmente, flat, diskANN e quantizedFlat são suportados. |
ClientEncryptionIncludedPath
.
Name | Tipo | Description |
---|---|---|
clientEncryptionKeyId |
string |
O identificador da chave de criptografia do cliente a ser usada para criptografar o caminho. |
encryptionAlgorithm |
string |
O algoritmo de encriptação que será usado. Ex: - AEAD_AES_256_CBC_HMAC_SHA256. |
encryptionType |
string |
O tipo de criptografia a ser executada. Ex: - determinístico, randomizado. |
path |
string |
Caminho que precisa ser criptografado. |
ClientEncryptionPolicy
Política de criptografia do cliente Cosmos DB.
Name | Tipo | Description |
---|---|---|
includedPaths |
Caminhos do item que precisam de criptografia junto com configurações específicas de caminho. |
|
policyFormatVersion |
integer |
Versão da definição da política de criptografia do cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de id e caminho de chave de partição. |
CloudError
Uma resposta de erro do serviço.
Name | Tipo | Description |
---|---|---|
error |
Resposta de erro. |
CompositePath
Name | Tipo | Description |
---|---|---|
order |
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.
Name | Tipo | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ComputedProperty
A definição de uma propriedade computada
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 contêiner.
Name | Tipo | Default value | 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 | LastWriterWins |
Indica o modo de resolução de conflitos. |
Container
Objeto de recurso de contêiner SQL do Cosmos DB
Name | Tipo | Default value | 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 único. |
|
_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 carimbo de data/hora da última atualização do recurso. |
|
analyticalStorageTtl |
integer |
TTL analítico. |
|
clientEncryptionPolicy |
A política de criptografia do cliente para o contêiner. |
||
computedProperties |
Lista de propriedades computadas |
||
conflictResolutionPolicy |
A política de resolução de conflitos para o contêiner. |
||
createMode | Default |
Enum para indicar o modo de criação de recursos. |
|
defaultTtl |
integer |
Tempo de vida padrão |
|
id |
string |
Nome do contêiner SQL do Cosmos DB |
|
indexingPolicy |
A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do contêiner |
||
partitionKey |
A configuração da chave de partição a ser usada para particionar dados em várias partições |
||
restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
||
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. |
||
vectorEmbeddingPolicy |
A política de incorporação de vetores para o contêiner. |
ContainerPartitionKey
A configuração da chave de partição a ser usada para particionar dados em várias partições
Name | Tipo | Default value | Description |
---|---|---|---|
kind | Hash |
Indica o tipo de algoritmo usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas 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 de 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 |
DistanceFunction
A função de distância a ser usada para o cálculo de distância entre vetores.
Name | Tipo | Description |
---|---|---|
cosine |
string |
|
dotproduct |
string |
|
euclidean |
string |
ErrorResponse
Resposta de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
message |
string |
Mensagem de erro indicando por que a operação falhou. |
ExcludedPath
Name | 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
Name | 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 para o caminho.
Name | Tipo | Default value | Description |
---|---|---|---|
dataType | String |
O tipo de dados ao qual o comportamento de indexação é aplicado. |
|
kind | 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 | Default value | Description |
---|---|---|---|
automatic |
boolean |
Indica se a política de indexação é automática |
|
compositeIndexes |
Lista de caminhos compostos |
||
excludedPaths |
Lista de caminhos a excluir da indexação |
||
includedPaths |
Lista de caminhos a incluir na indexação |
||
indexingMode | consistent |
Indica o modo de indexação. |
|
spatialIndexes |
Lista de especificidades espaciais |
||
vectorIndexes |
Lista de caminhos a serem incluídos na indexação vetorial |
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 usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas para criação de contêiner
Name | Tipo | Description |
---|---|---|
Hash |
string |
|
MultiHash |
string |
|
Range |
string |
Resource
O recurso de um evento de contêiner SQL do Azure Cosmos DB
Name | Tipo | Description |
---|---|---|
_rid |
string |
Uma propriedade gerada pelo sistema. Um identificador único. |
canUndelete |
string |
Um estado desse contêiner para identificar se ele é restaurável na mesma conta. |
canUndeleteReason |
string |
A razão pela qual este recipiente não pode ser restaurado na mesma conta. |
container |
Objeto de recurso de contêiner SQL do Cosmos DB |
|
eventTimestamp |
string |
O momento em que este evento de contêiner aconteceu. |
operationType |
O tipo de operação deste evento de contêiner. |
|
ownerId |
string |
O nome desse contêiner SQL. |
ownerResourceId |
string |
A ID do recurso deste contêiner SQL. |
ResourceRestoreParameters
Parâmetros para indicar as informações sobre a restauração.
Name | Tipo | Description |
---|---|---|
restoreSource |
string |
A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601). |
restoreWithTtlDisabled |
boolean |
Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. |
RestorableSqlContainerGetResult
Um evento de contêiner 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 |
O recurso de um evento de contêiner SQL do Azure Cosmos DB |
|
type |
string |
O tipo de recurso do Azure. |
RestorableSqlContainersListResult
A resposta da operação List, que contém os eventos de contêiner SQL e suas propriedades.
Name | Tipo | Description |
---|---|---|
value |
Lista de eventos de contêiner SQL e suas propriedades. |
SpatialSpec
Name | 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/*) |
types |
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 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 deve 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 |
Lista de chaves exclusivas que impõe restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB. |
VectorDataType
Indica o tipo de dados do vetor.
Name | Tipo | Description |
---|---|---|
float32 |
string |
|
int8 |
string |
|
uint8 |
string |
VectorEmbedding
Representa uma incorporação vetorial. Uma incorporação vetorial é usada para definir um campo vetorial nos documentos.
Name | Tipo | Description |
---|---|---|
dataType |
Indica o tipo de dados do vetor. |
|
dimensions |
integer |
O número de dimensões no vetor. |
distanceFunction |
A função de distância a ser usada para o cálculo de distância entre vetores. |
|
path |
string |
O caminho para o campo de vetor no documento. |
VectorEmbeddingPolicy
Política de incorporação vetorial do Cosmos DB
Name | Tipo | Description |
---|---|---|
vectorEmbeddings |
Lista de incorporações vetoriais |
VectorIndex
Name | Tipo | Description |
---|---|---|
path |
string |
O caminho para o campo de vetor no documento. |
type |
O tipo de índice do vetor. Atualmente, flat, diskANN e quantizedFlat são suportados. |
VectorIndexType
O tipo de índice do vetor. Atualmente, flat, diskANN e quantizedFlat são suportados.
Name | Tipo | Description |
---|---|---|
diskANN |
string |
|
flat |
string |
|
quantizedFlat |
string |