Restorable Gremlin Resources - List

Referenz

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Gibt eine Liste von Gremlin-Datenbank- und Graphenkombinationen zurück, die für das Konto zum angegebenen Zeitstempel und Speicherort vorhanden sind. Dies ist in Szenarios hilfreich, in denen überprüft werden soll, welche Ressourcen zu einer bestimmten Zeit (Zeitstempel) und an einem bestimmten Speicherort vorhanden sind. Für diese API ist die Berechtigung "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read" erforderlich.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources?api-version=2024-05-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources?api-version=2024-05-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Hierbei handelt es sich um die instanceId-GUID eines wiederherstellbaren Datenbankkontos.
location	path	True	string	Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort in Großbuchstaben.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
restoreLocation	query		string	Hierbei handelt es sich um den Speicherort, an dem sich die wiederherstellbaren Ressourcen befinden.
restoreTimestampInUtc	query		string	Hierbei handelt es sich um den Zeitstempel, zu dem die wiederherstellbaren Ressourcen vorhanden waren.

Antworten

Name	Typ	Beschreibung
200 OK	RestorableGremlinResourcesListResult	Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBRestorableGremlinResourceList

Sample Request

HTTP

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-05-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

Sample Response

Status code:: 200

{
  "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": []
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort vom Dienst.
ErrorResponse	Fehlerantwort.
RestorableGremlinResourcesGetResult	Bestimmte wiederherzustellende Datenbanken.
RestorableGremlinResourcesListResult	Die List-Vorgangsantwort, die die wiederherstellbaren Gremlin-Ressourcen enthält.

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

RestorableGremlinResourcesGetResult

Bestimmte wiederherzustellende Datenbanken.

Name	Typ	Beschreibung
databaseName	string	Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist.
graphNames	string[]	Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind.
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
name	string	Der Name der ARM-Ressource.
type	string	Der Typ der Azure-Ressource.