Partager via


Restorable Gremlin Resources - List

Retourne une liste de combinaisons de bases de données gremlin et de graphiques qui existent sur le compte à l’horodatage et à l’emplacement donnés. Cela permet dans les scénarios de valider les ressources qui existent au moment donné de l’horodatage et de l’emplacement. 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}/restorableGremlinResources?api-version=2024-11-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources?api-version=2024-11-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}

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.

restoreLocation
query

string

Emplacement où se trouvent les ressources pouvant être restaurées.

restoreTimestampInUtc
query

string

Horodatage lorsque les ressources restaurables existaient.

Réponses

Nom Type Description
200 OK

RestorableGremlinResourcesListResult

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

Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBRestorableGremlinResourceList

Exemple de requête

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

Exemple de réponse

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database1",
      "databaseName": "Database1",
      "graphNames": [
        "Graph1"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database2",
      "databaseName": "Database2",
      "graphNames": [
        "Graph1",
        "Graph2"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database3",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database3",
      "databaseName": "Database3",
      "graphNames": []
    }
  ]
}

Définitions

Nom Description
CloudError

Réponse d’erreur du service.

ErrorResponse

Réponse d’erreur.

RestorableGremlinResourcesGetResult

Bases de données spécifiques à restaurer.

RestorableGremlinResourcesListResult

Réponse de l’opération List, qui contient les ressources Gremlin restaurables.

CloudError

Réponse d’erreur du service.

Nom Type Description
error

ErrorResponse

Réponse d’erreur.

ErrorResponse

Réponse d’erreur.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

RestorableGremlinResourcesGetResult

Bases de données spécifiques à restaurer.

Nom Type Description
databaseName

string

Nom de la base de données gremlin disponible pour la restauration.

graphNames

string[]

Noms des graphiques disponibles pour la restauration.

id

string

Identificateur de ressource unique de la ressource ARM.

name

string

Nom de la ressource ARM.

type

string

Type de ressource Azure.

RestorableGremlinResourcesListResult

Réponse de l’opération List, qui contient les ressources Gremlin restaurables.

Nom Type Description
value

RestorableGremlinResourcesGetResult[]

Liste des ressources Gremlin restaurables, y compris les noms de base de données gremlin et de graphe.