Restorable Sql Containers - List

Referencia

Servicio:: Cosmos DB Resource Provider

Versión de la API:: 2024-11-15

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 el 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=2024-11-15

Con parámetros opcionales:

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 identificador URI

Nombre	En	Requerido	Tipo	Description
instanceId	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.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
endTime	query		string	Hora de finalización de la fuente de eventos de contenedores sql restaurables.
restorableSqlDatabaseRid	query		string	Identificador de recurso de la base de datos SQL.
startTime	query		string	Hora de inicio de la fuente de eventos de contenedores de Sql restaurables.

Respuestas

Nombre	Tipo	Description
200 OK	RestorableSqlContainersListResult	La operación se completó correctamente.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Ejemplos

CosmosDBRestorableSqlContainerList

Solicitud de ejemplo

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==

Respuesta de muestra

status code:: 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\""
          }
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Directiva de cifrado de cliente de Cosmos DB.
CloudError	Respuesta de error del servicio.
CompositePath
CompositePathSortOrder	Criterio de ordenación para rutas de acceso compuestas.
ComputedProperty	Definición de una propiedad calculada
ConflictResolutionMode	Indica el modo de resolución de conflictos.
ConflictResolutionPolicy	Directiva de resolución de conflictos para el contenedor.
Container	Objeto de recurso de contenedor de SQL de Cosmos DB
ContainerPartitionKey	Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones
CreateMode	Enumeración para indicar el modo de creación de la cuenta.
DataType	Tipo de datos al que se aplica el comportamiento de indexación.
DistanceFunction	Función de distancia que se va a usar para el cálculo de distancia entre vectores.
ErrorResponse	Respuesta de error.
ExcludedPath
IncludedPath	Rutas de acceso incluidas en la indexación
Indexes	Índices de la ruta de acceso.
IndexingMode	Indica el modo de indexación.
IndexingPolicy	Directiva de indexación de Cosmos DB
IndexKind	Indica el tipo de índice.
OperationType	Enumeración para indicar el tipo de operación del evento.
PartitionKind	Indica el tipo de algoritmo usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores.
Resource	Recurso de un evento de contenedor SQL de Azure Cosmos DB
ResourceRestoreParameters	Parámetros para indicar la información sobre la restauración.
RestorableSqlContainerGetResult	Un evento de contenedor SQL de Azure Cosmos DB
RestorableSqlContainersListResult	La respuesta de la operación List, que contiene los eventos del contenedor SQL y sus propiedades.
SpatialSpec
SpatialType	Indica el tipo espacial de índice.
UniqueKey	La clave única en que exige la restricción de unicidad en los documentos de la colección en el 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.
VectorDataType	Indica el tipo de datos de vector.
VectorEmbedding	Representa una inserción de vectores. Se usa una inserción de vectores para definir un campo vectorial en los documentos.
VectorEmbeddingPolicy	Directiva de inserción de vectores de Cosmos DB
VectorIndex
VectorIndexType	Tipo de índice del vector. Actualmente, se admiten flat, diskANN y quantizedFlat.

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	ClientEncryptionIncludedPath[]	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 identificador y clave de partición.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error.

CompositePath

Nombre	Tipo	Description
order	CompositePathSortOrder	Criterio de ordenación para rutas de acceso compuestas.
path	string	Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con 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	La 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	ConflictResolutionMode	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 denota la última marca de tiempo actualizada del recurso.
analyticalStorageTtl	integer		TTL analítico.
clientEncryptionPolicy	ClientEncryptionPolicy		Directiva de cifrado de cliente para el contenedor.
computedProperties	ComputedProperty[]		Lista de propiedades calculadas
conflictResolutionPolicy	ConflictResolutionPolicy		Directiva de resolución de conflictos para el contenedor.
createMode	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 de SQL de Cosmos DB
indexingPolicy	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	ContainerPartitionKey		Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones
restoreParameters	ResourceRestoreParameters		Parámetros para indicar la información sobre la restauración
uniqueKeyPolicy	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.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Directiva de inserción de vectores para el contenedor.

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	PartitionKind	Hash	Indica el tipo de algoritmo usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores.
paths	string[]		Lista de rutas de acceso con 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

DistanceFunction

Función de distancia que se va a usar para el cálculo de distancia entre vectores.

Nombre	Tipo	Description
cosine	string
dotproduct	string
euclidean	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. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*)

IncludedPath

Rutas de acceso incluidas 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. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*)

Indexes

Índices de la ruta de acceso.

Nombre	Tipo	Valor predeterminado	Description
dataType	DataType	String	Tipo de datos al que se aplica el comportamiento de indexación.
kind	IndexKind	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	CompositePath[]		Lista de la lista de rutas de acceso compuestas
excludedPaths	ExcludedPath[]		Lista de rutas de acceso que se van a excluir de la indexación
includedPaths	IncludedPath[]		Lista de rutas de acceso que se van a incluir en la indexación
indexingMode	IndexingMode	consistent	Indica el modo de indexación.
spatialIndexes	SpatialSpec[]		Lista de detalles espaciales
vectorIndexes	VectorIndex[]		Lista de rutas de acceso que se van a incluir en la indexación de vectores

IndexKind

Indica el tipo de índice.

Nombre	Tipo	Description
Hash	string
Range	string
Spatial	string

OperationType

Enumeración para indicar 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 usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores.

Nombre	Tipo	Description
Hash	string
MultiHash	string
Range	string

Resource

Recurso de un evento de contenedor 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	Container	Objeto de recurso de contenedor de SQL de Cosmos DB
eventTimestamp	string	cuando se produjo este evento de contenedor.
operationType	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).
restoreWithTtlDisabled	boolean	Especifica si la cuenta restaurada tendrá tiempoTo-Live deshabilitado tras la restauración correcta.

RestorableSqlContainerGetResult

Un evento de contenedor SQL de Azure Cosmos DB

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
name	string	Nombre del recurso de ARM.
properties.resource	Resource	Recurso de un evento de contenedor SQL de Azure Cosmos DB
type	string	Tipo de recurso de Azure.