Restorable Sql Containers - List
Affichez le flux d’événements de toutes les mutations effectuées sur tous les conteneurs SQL Azure Cosmos DB sous une base de données spécifique. Cela aide dans le cas où un conteneur a été accidentellement supprimé. Cette API nécessite l’autorisation « 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}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
instance
|
path | True |
string |
GUID instanceId d’un compte de base de données restaurable. |
location
|
path | True |
string |
Région Cosmos DB, avec des espaces entre les mots et chaque mot en majuscule. |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
end
|
query |
string |
Heure de fin du flux des conteneurs Sql restaurables. |
|
restorable
|
query |
string |
ID de ressource de la base de données SQL. |
|
start
|
query |
string |
Heure de début du flux d’événements des conteneurs Sql restaurables. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
L’opération s’est terminée avec succès. |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
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\""
}
}
}
}
]
}
Définitions
Nom | Description |
---|---|
Client |
. |
Client |
Stratégie de chiffrement du client Cosmos DB. |
Cloud |
Réponse d’erreur du service. |
Composite |
|
Composite |
Ordre de tri pour les chemins composites. |
Computed |
Définition d’une propriété calculée |
Conflict |
Indique le mode de résolution des conflits. |
Conflict |
Stratégie de résolution des conflits pour le conteneur. |
Container |
Objet de ressource de conteneur SQL Cosmos DB |
Container |
Configuration de la clé de partition à utiliser pour partitionner les données en plusieurs partitions |
Create |
Énumérez pour indiquer le mode de création de compte. |
Data |
Type de données auquel le comportement d’indexation est appliqué. |
Error |
Réponse d’erreur. |
Excluded |
|
Included |
Chemins d’accès inclus dans l’indexation |
Indexes |
Index du chemin d’accès. |
Indexing |
Indique le mode d’indexation. |
Indexing |
Stratégie d’indexation Cosmos DB |
Index |
Indique le type d'index. |
Operation |
Enum indiquant le type d’opération de l’événement. |
Partition |
Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur |
Resource |
Ressource d’un événement de conteneur SQL Azure Cosmos DB |
Resource |
Paramètres pour indiquer les informations relatives à la restauration. |
Restorable |
Événement de conteneur SQL Azure Cosmos DB |
Restorable |
Réponse de l’opération List, qui contient les événements de conteneur SQL et leurs propriétés. |
Spatial |
|
Spatial |
Indique le type spatial de l’index. |
Unique |
Clé unique sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. |
Unique |
Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. |
ClientEncryptionIncludedPath
.
Nom | Type | Description |
---|---|---|
clientEncryptionKeyId |
string |
Identificateur de la clé de chiffrement client à utiliser pour chiffrer le chemin d’accès. |
encryptionAlgorithm |
string |
Algorithme de chiffrement qui sera utilisé. Par exemple - AEAD_AES_256_CBC_HMAC_SHA256. |
encryptionType |
string |
Type de chiffrement à effectuer. Par exemple - Déterministe, Aléatoire. |
path |
string |
Chemin qui doit être chiffré. |
ClientEncryptionPolicy
Stratégie de chiffrement du client Cosmos DB.
Nom | Type | Description |
---|---|---|
includedPaths |
Chemins d’accès de l’élément qui ont besoin d’un chiffrement avec des paramètres spécifiques au chemin d’accès. |
|
policyFormatVersion |
integer |
Version de la définition de la stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement des chemins de clé de partition et d’ID. |
CloudError
Réponse d’erreur du service.
Nom | Type | Description |
---|---|---|
error |
Réponse d’erreur. |
CompositePath
Nom | Type | Description |
---|---|---|
order |
Ordre de tri pour les chemins composites. |
|
path |
string |
Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) |
CompositePathSortOrder
Ordre de tri pour les chemins composites.
Nom | Type | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ComputedProperty
Définition d’une propriété calculée
Nom | Type | Description |
---|---|---|
name |
string |
Nom d’une propriété calculée, par exemple , « cp_lowerName » |
query |
string |
Requête qui évalue la valeur de la propriété calculée, par exemple - « SELECT VALUE LOWER(c.name) FROM c » |
ConflictResolutionMode
Indique le mode de résolution des conflits.
Nom | Type | Description |
---|---|---|
Custom |
string |
|
LastWriterWins |
string |
ConflictResolutionPolicy
Stratégie de résolution des conflits pour le conteneur.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
conflictResolutionPath |
string |
Chemin de résolution des conflits dans le cas du mode LastWriterWins. |
|
conflictResolutionProcedure |
string |
Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. |
|
mode | LastWriterWins |
Indique le mode de résolution des conflits. |
Container
Objet de ressource de conteneur SQL Cosmos DB
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
_etag |
string |
Propriété générée par le système représentant l’etag de ressource requis pour le contrôle d’accès concurrentiel optimiste. |
|
_rid |
string |
Propriété générée par le système. Un identificateur unique. |
|
_self |
string |
Propriété générée par le système qui spécifie le chemin d’accès adressable de la ressource de conteneur. |
|
_ts |
number |
Propriété générée par le système qui indique l’horodatage de la dernière mise à jour de la ressource. |
|
analyticalStorageTtl |
integer |
Durée de vie analytique. |
|
clientEncryptionPolicy |
Stratégie de chiffrement du client pour le conteneur. |
||
computedProperties |
Liste des propriétés calculées |
||
conflictResolutionPolicy |
Stratégie de résolution des conflits pour le conteneur. |
||
createMode | Default |
Énumérez pour indiquer le mode de création de ressource. |
|
defaultTtl |
integer |
Durée de vie par défaut |
|
id |
string |
Nom du conteneur SQL Cosmos DB |
|
indexingPolicy |
Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins de document dans le conteneur |
||
partitionKey |
Configuration de la clé de partition à utiliser pour partitionner les données en plusieurs partitions |
||
restoreParameters |
Paramètres pour indiquer les informations relatives à la restauration |
||
uniqueKeyPolicy |
Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. |
ContainerPartitionKey
Configuration de la clé de partition à utiliser pour partitionner les données en plusieurs partitions
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
kind | Hash |
Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur |
|
paths |
string[] |
Liste des chemins d’accès utilisant les données du conteneur qui peuvent être partitionnés |
|
systemKey |
boolean |
Indique si le conteneur utilise une clé de partition générée par le système |
|
version |
integer |
Indique la version de la définition de clé de partition |
CreateMode
Énumérez pour indiquer le mode de création de compte.
Nom | Type | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DataType
Type de données auquel le comportement d’indexation est appliqué.
Nom | Type | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Number |
string |
|
Point |
string |
|
Polygon |
string |
|
String |
string |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
message |
string |
Message d’erreur indiquant la raison de l’échec de l’opération. |
ExcludedPath
Nom | Type | Description |
---|---|---|
path |
string |
Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) |
IncludedPath
Chemins d’accès inclus dans l’indexation
Nom | Type | Description |
---|---|---|
indexes |
Indexes[] |
Liste des index pour ce chemin d’accès |
path |
string |
Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) |
Indexes
Index du chemin d’accès.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
dataType | String |
Type de données auquel le comportement d’indexation est appliqué. |
|
kind | Hash |
Indique le type d'index. |
|
precision |
integer |
Précision de l’index. -1 est une précision maximale. |
IndexingMode
Indique le mode d’indexation.
Nom | Type | Description |
---|---|---|
consistent |
string |
|
lazy |
string |
|
none |
string |
IndexingPolicy
Stratégie d’indexation Cosmos DB
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
automatic |
boolean |
Indique si la stratégie d’indexation est automatique |
|
compositeIndexes |
Liste des chemins d’accès composites |
||
excludedPaths |
Liste des chemins d’accès à exclure de l’indexation |
||
includedPaths |
Liste des chemins d’accès à inclure dans l’indexation |
||
indexingMode | consistent |
Indique le mode d’indexation. |
|
spatialIndexes |
Liste des spécificités spatiales |
IndexKind
Indique le type d'index.
Nom | Type | Description |
---|---|---|
Hash |
string |
|
Range |
string |
|
Spatial |
string |
OperationType
Enum indiquant le type d’opération de l’événement.
Nom | Type | Description |
---|---|---|
Create |
string |
|
Delete |
string |
|
Recreate |
string |
|
Replace |
string |
|
SystemOperation |
string |
PartitionKind
Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur
Nom | Type | Description |
---|---|---|
Hash |
string |
|
MultiHash |
string |
|
Range |
string |
Resource
Ressource d’un événement de conteneur SQL Azure Cosmos DB
Nom | Type | Description |
---|---|---|
_rid |
string |
Propriété générée par le système. Un identificateur unique. |
canUndelete |
string |
État de ce conteneur pour déterminer si ce conteneur peut être restauré dans le même compte. |
canUndeleteReason |
string |
Raison pour laquelle ce conteneur ne peut pas être restauré dans le même compte. |
container |
Objet de ressource de conteneur SQL Cosmos DB |
|
eventTimestamp |
string |
quand cet événement de conteneur s’est produit. |
operationType |
Type d’opération de cet événement de conteneur. |
|
ownerId |
string |
Nom de ce conteneur SQL. |
ownerResourceId |
string |
ID de ressource de ce conteneur SQL. |
ResourceRestoreParameters
Paramètres pour indiquer les informations relatives à la restauration.
Nom | Type | Description |
---|---|---|
restoreSource |
string |
ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
Heure à laquelle le compte doit être restauré (format ISO-8601). |
RestorableSqlContainerGetResult
Événement de conteneur SQL Azure Cosmos DB
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur de ressource unique de la ressource ARM. |
name |
string |
Nom de la ressource ARM. |
properties.resource |
Ressource d’un événement de conteneur SQL Azure Cosmos DB |
|
type |
string |
Type de ressource Azure. |
RestorableSqlContainersListResult
Réponse de l’opération List, qui contient les événements de conteneur SQL et leurs propriétés.
Nom | Type | Description |
---|---|---|
value |
Liste des événements de conteneur SQL et leurs propriétés. |
SpatialSpec
Nom | Type | Description |
---|---|---|
path |
string |
Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) |
types |
Liste du type spatial du chemin d’accès |
SpatialType
Indique le type spatial de l’index.
Nom | Type | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
UniqueKey
Clé unique sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB.
Nom | Type | Description |
---|---|---|
paths |
string[] |
La liste des chemins doit être unique pour chaque document dans le service Azure Cosmos DB |
UniqueKeyPolicy
Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB.
Nom | Type | Description |
---|---|---|
uniqueKeys |
Liste des clés uniques sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. |