Restorable Sql Containers - List
Muestre la fuente de eventos de todas las mutaciones realizadas en todos los contenedores de SQL de Azure Cosmos DB en una base de datos específica. Esto ayuda en un escenario en el que el contenedor se eliminó accidentalmente. Esta API requiere el permiso "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 de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
instance
|
path | True |
string |
GUID instanceId de una cuenta de base de datos restaurable. |
location
|
path | True |
string |
Región de Cosmos DB, con espacios entre palabras y cada palabra en mayúsculas. |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
end
|
query |
string |
Hora de finalización de la fuente de eventos de contenedores sql restaurables. |
|
restorable
|
query |
string |
Identificador de recurso de la instancia de SQL Database. |
|
start
|
query |
string |
Hora de inicio de la fuente de eventos de contenedores sql restaurables. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La operación se ha completado correctamente. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Ejemplos
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\""
}
}
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Client |
. |
Client |
Directiva de cifrado de cliente de Cosmos DB. |
Cloud |
Respuesta de error del servicio. |
Composite |
|
Composite |
Criterio de ordenación para rutas de acceso compuestas. |
Computed |
Definición de una propiedad calculada |
Conflict |
Indica el modo de resolución de conflictos. |
Conflict |
Directiva de resolución de conflictos para el contenedor. |
Container |
Objeto de recurso de contenedor de SQL de Cosmos DB |
Container |
Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones |
Create |
Enumeración para indicar el modo de creación de la cuenta. |
Data |
Tipo de datos al que se aplica el comportamiento de indexación. |
Error |
Respuesta de error. |
Excluded |
|
Included |
Rutas de acceso que se incluyen en la indexación |
Indexes |
Índices de la ruta de acceso. |
Indexing |
Indica el modo de indexación. |
Indexing |
Directiva de indexación de Cosmos DB |
Index |
Indica el tipo de índice. |
Operation |
Enumeración que indica el tipo de operación del evento. |
Partition |
Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. |
Resource |
Recurso de un evento de contenedor de SQL de Azure Cosmos DB. |
Resource |
Parámetros para indicar la información sobre la restauración. |
Restorable |
Evento de contenedor de SQL de Azure Cosmos DB. |
Restorable |
Respuesta de la operación de enumeración, que contiene los eventos de contenedor de SQL y sus propiedades. |
Spatial |
|
Spatial |
Indica el tipo espacial de índice. |
Unique |
Clave única en la que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. |
Unique |
Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. |
ClientEncryptionIncludedPath
.
Nombre | Tipo | Description |
---|---|---|
clientEncryptionKeyId |
string |
Identificador de la clave de cifrado de cliente que se va a usar para cifrar la ruta de acceso. |
encryptionAlgorithm |
string |
Algoritmo de cifrado que se usará. Por ejemplo, AEAD_AES_256_CBC_HMAC_SHA256. |
encryptionType |
string |
Tipo de cifrado que se va a realizar. Por ejemplo- Determinista, Aleatorio. |
path |
string |
Ruta de acceso que debe cifrarse. |
ClientEncryptionPolicy
Directiva de cifrado de cliente de Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
includedPaths |
Rutas de acceso del elemento que necesitan cifrado junto con la configuración específica de la ruta de acceso. |
|
policyFormatVersion |
integer |
Versión de la definición de directiva de cifrado de cliente. Las versiones admitidas son 1 y 2. La versión 2 admite el cifrado de ruta de acceso de clave de partición y identificador. |
CloudError
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
error |
Respuesta de error. |
CompositePath
Nombre | Tipo | Description |
---|---|---|
order |
Criterio de ordenación de las rutas de acceso compuestas. |
|
path |
string |
Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) |
CompositePathSortOrder
Criterio de ordenación para rutas de acceso compuestas.
Nombre | Tipo | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ComputedProperty
Definición de una propiedad calculada
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de una propiedad calculada, por ejemplo: "cp_lowerName" |
query |
string |
Consulta que evalúa el valor de la propiedad calculada, por ejemplo: "SELECT VALUE LOWER(c.name) FROM c" |
ConflictResolutionMode
Indica el modo de resolución de conflictos.
Nombre | Tipo | Description |
---|---|---|
Custom |
string |
|
LastWriterWins |
string |
ConflictResolutionPolicy
Directiva de resolución de conflictos para el contenedor.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
conflictResolutionPath |
string |
Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. |
|
conflictResolutionProcedure |
string |
Procedimiento para resolver conflictos en el caso del modo personalizado. |
|
mode | LastWriterWins |
Indica el modo de resolución de conflictos. |
Container
Objeto de recurso de contenedor de SQL de Cosmos DB
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
_etag |
string |
Propiedad generada por el sistema que representa la etag de recursos necesaria para el control de simultaneidad optimista. |
|
_rid |
string |
Propiedad generada por el sistema. Identificador único. |
|
_self |
string |
Propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de contenedor. |
|
_ts |
number |
Propiedad generada por el sistema que indica la última marca de tiempo actualizada del recurso. |
|
analyticalStorageTtl |
integer |
TTL analítico. |
|
clientEncryptionPolicy |
Directiva de cifrado de cliente para el contenedor. |
||
computedProperties |
Lista de propiedades calculadas |
||
conflictResolutionPolicy |
Directiva de resolución de conflictos para el contenedor. |
||
createMode | Default |
Enumeración para indicar el modo de creación de recursos. |
|
defaultTtl |
integer |
Período de vida predeterminado |
|
id |
string |
Nombre del contenedor sql de Cosmos DB |
|
indexingPolicy |
Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del contenedor. |
||
partitionKey |
Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones |
||
restoreParameters |
Parámetros para indicar la información sobre la restauración |
||
uniqueKeyPolicy |
Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. |
ContainerPartitionKey
Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
kind | Hash |
Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. |
|
paths |
string[] |
Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor |
|
systemKey |
boolean |
Indica si el contenedor usa una clave de partición generada por el sistema. |
|
version |
integer |
Indica la versión de la definición de clave de partición. |
CreateMode
Enumeración para indicar el modo de creación de la cuenta.
Nombre | Tipo | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DataType
Tipo de datos al que se aplica el comportamiento de indexación.
Nombre | Tipo | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Number |
string |
|
Point |
string |
|
Polygon |
string |
|
String |
string |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
ExcludedPath
Nombre | Tipo | Description |
---|---|---|
path |
string |
Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) |
IncludedPath
Rutas de acceso que se incluyen en la indexación
Nombre | Tipo | Description |
---|---|---|
indexes |
Indexes[] |
Lista de índices para esta ruta de acceso |
path |
string |
Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) |
Indexes
Índices de la ruta de acceso.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
dataType | String |
Tipo de datos al que se aplica el comportamiento de indexación. |
|
kind | Hash |
Indica el tipo de índice. |
|
precision |
integer |
Precisión del índice. -1 es la precisión máxima. |
IndexingMode
Indica el modo de indexación.
Nombre | Tipo | Description |
---|---|---|
consistent |
string |
|
lazy |
string |
|
none |
string |
IndexingPolicy
Directiva de indexación de Cosmos DB
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
automatic |
boolean |
Indica si la directiva de indexación es automática. |
|
compositeIndexes |
Lista de listas de rutas de acceso compuestas |
||
excludedPaths |
Lista de rutas de acceso que se van a excluir de la indexación |
||
includedPaths |
Lista de rutas de acceso que se van a incluir en la indexación |
||
indexingMode | consistent |
Indica el modo de indexación. |
|
spatialIndexes |
Lista de detalles espaciales |
IndexKind
Indica el tipo de índice.
Nombre | Tipo | Description |
---|---|---|
Hash |
string |
|
Range |
string |
|
Spatial |
string |
OperationType
Enumeración que indica el tipo de operación del evento.
Nombre | Tipo | Description |
---|---|---|
Create |
string |
|
Delete |
string |
|
Recreate |
string |
|
Replace |
string |
|
SystemOperation |
string |
PartitionKind
Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores.
Nombre | Tipo | Description |
---|---|---|
Hash |
string |
|
MultiHash |
string |
|
Range |
string |
Resource
Recurso de un evento de contenedor de SQL de Azure Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
_rid |
string |
Propiedad generada por el sistema. Identificador único. |
canUndelete |
string |
Estado de este contenedor para identificar si este contenedor se puede restaurar en la misma cuenta. |
canUndeleteReason |
string |
Motivo por el que este contenedor no se puede restaurar en la misma cuenta. |
container |
Objeto de recurso de contenedor de SQL de Cosmos DB |
|
eventTimestamp |
string |
Cuando se produjo este evento de contenedor. |
operationType |
Tipo de operación de este evento de contenedor. |
|
ownerId |
string |
Nombre de este contenedor de SQL. |
ownerResourceId |
string |
Identificador de recurso de este contenedor de SQL. |
ResourceRestoreParameters
Parámetros para indicar la información sobre la restauración.
Nombre | Tipo | Description |
---|---|---|
restoreSource |
string |
Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
Hora a la que se debe restaurar la cuenta (formato ISO-8601). |
RestorableSqlContainerGetResult
Evento de contenedor de SQL de Azure Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso único del recurso arm. |
name |
string |
Nombre del recurso de ARM. |
properties.resource |
Recurso de un evento de contenedor de SQL de Azure Cosmos DB. |
|
type |
string |
Tipo de recurso de Azure. |
RestorableSqlContainersListResult
Respuesta de la operación de enumeración, que contiene los eventos de contenedor de SQL y sus propiedades.
Nombre | Tipo | Description |
---|---|---|
value |
Lista de eventos de contenedor SQL y sus propiedades. |
SpatialSpec
Nombre | Tipo | Description |
---|---|---|
path |
string |
Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) |
types |
Lista del tipo espacial de la ruta de acceso |
SpatialType
Indica el tipo espacial de índice.
Nombre | Tipo | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
UniqueKey
Clave única en la que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
paths |
string[] |
La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. |
UniqueKeyPolicy
Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
uniqueKeys |
Lista de claves únicas en las que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. |