Restorable Sql Databases - List

  • Référence
Service:
Cosmos DB Resource Provider
API Version:
2023-11-15

Affichez le flux d’événements de toutes les mutations effectuées sur toutes les bases de données SQL Azure Cosmos DB sous le compte pouvant être restauré. Cela vous aide à récupérer l’heure de la suppression dans le cas où la base de données a été supprimée accidentellement. 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}/restorableSqlDatabases?api-version=2023-11-15

Paramètres URI

Nom Dans Obligatoire Type Description
instanceId
 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 majuscules.
subscriptionId
 path True

string

ID de l’abonnement cible.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

RestorableSqlDatabasesListResult

L’opération s’est terminée avec succès.
Other Status Codes

CloudError

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

CosmosDBRestorableSqlDatabaseList

Sample Request

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases?api-version=2023-11-15

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

Définitions

Nom Description
CloudError

Réponse d’erreur du service.
CreateMode

Énumérez pour indiquer le mode de création de compte.
Database

Objet de ressource de base de données SQL Cosmos DB
ErrorResponse

Réponse d’erreur.
OperationType

Enum indiquant le type d’opération de l’événement.
Resource

Ressource d’un événement de base de données SQL Azure Cosmos DB.
ResourceRestoreParameters

Paramètres pour indiquer les informations relatives à la restauration.
RestorableSqlDatabaseGetResult

Événement de base de données SQL Azure Cosmos DB.
RestorableSqlDatabasesListResult

Réponse de l’opération List, qui contient les événements de base de données SQL et leurs propriétés.

CloudError

Réponse d’erreur du service.

Nom Type Description
error

ErrorResponse

Réponse d’erreur.

CreateMode

Énumérez pour indiquer le mode de création de compte.

Nom Type Description
Default

string

Restore

string

Database

Objet de ressource de base de données SQL Cosmos DB

Nom Type Valeur par défaut Description
_colls

string

Propriété générée par le système qui a spécifié le chemin d’accès adressable de la ressource de collections.
_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 base de données.
_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.
_users

string

Propriété générée par le système qui spécifie le chemin d’accès adressable de la ressource users.
createMode

CreateMode

Default

Énumérez pour indiquer le mode de création de ressource.
id

string

Nom de la base de données SQL Cosmos DB
restoreParameters

ResourceRestoreParameters

Paramètres pour indiquer les informations relatives à la restauration

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.

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

Resource

Ressource d’un événement de base de données 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 cette base de données pour déterminer si cette base de données peut être restaurée dans le même compte.
canUndeleteReason

string

Raison pour laquelle cette base de données ne peut pas être restaurée dans le même compte.
database

Database

Objet de ressource de base de données SQL Cosmos DB
eventTimestamp

string

Heure à laquelle cet événement de base de données s’est produit.
operationType

OperationType

Type d’opération de cet événement de base de données.
ownerId

string

Nom de la base de données SQL.
ownerResourceId

string

ID de ressource de la base de données 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).

RestorableSqlDatabaseGetResult

Événement de base de données 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

Resource

Ressource d’un événement de base de données SQL Azure Cosmos DB.
type

string

Type de ressource Azure.

RestorableSqlDatabasesListResult

Réponse de l’opération List, qui contient les événements de base de données SQL et leurs propriétés.

Nom Type Description
value

RestorableSqlDatabaseGetResult[]

Liste des événements de base de données SQL et leurs propriétés.