Restorable Gremlin Databases - List

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Zeigen Sie den Ereignisfeed aller Mutationen an, die auf allen Azure Cosmos DB Gremlin-Datenbanken unter dem wiederherstellbaren Konto vorgenommen wurden. Dies hilft in Szenarien, in denen die Datenbank versehentlich gelöscht wurde, um die Löschzeit zu erhalten. 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}/restorableGremlinDatabases?api-version=2024-11-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instanceId-GUID eines wiederhergestellten Datenbankkontos.
location	path	True	string	Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort mit Großbuchstaben.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	RestorableGremlinDatabasesListResult	Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBRestorableGremlinDatabaseList

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_restorable_gremlin_database_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="2296c272-5d55-40d9-bc05-4d56dc2d7588",
    )

    response = client.restorable_gremlin_databases.list(
        location="WestUS",
        instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableGremlinDatabaseList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableGremlinDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
ErrorResponse	Fehlerantwort.
OperationType	Aufzählung, um den Vorgangstyp des Ereignisses anzugeben.
Resource	Die Ressource eines Azure Cosmos DB Gremlin-Datenbankereignisses
RestorableGremlinDatabaseGetResult	Ein Azure Cosmos DB Gremlin-Datenbankereignis
RestorableGremlinDatabasesListResult	Die Antwort auf den Listenvorgang, die die Gremlin-Datenbankereignisse und deren Eigenschaften enthält.

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

ErrorResponse

Fehlerantwort.

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

OperationType

Aufzählung, um den Vorgangstyp des Ereignisses anzugeben.

Name	Typ	Beschreibung
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

Die Ressource eines Azure Cosmos DB Gremlin-Datenbankereignisses

Name	Typ	Beschreibung
_rid	string	Eine vom System generierte Eigenschaft. Ein eindeutiger Bezeichner.
canUndelete	string	Ein Status dieser Datenbank, der identifiziert, ob diese Datenbank in demselben Konto wiederhergestellt werden kann.
canUndeleteReason	string	Der Grund, warum diese Datenbank nicht in demselben Konto wiederhergestellt werden kann.
eventTimestamp	string	Der Zeitpunkt, zu dem dieses Datenbankereignis aufgetreten ist.
operationType	OperationType	Der Vorgangstyp dieses Datenbankereignisses.
ownerId	string	Der Name dieser Gremlin-Datenbank.
ownerResourceId	string	Die Ressourcen-ID dieser Gremlin-Datenbank.

RestorableGremlinDatabaseGetResult

Ein Azure Cosmos DB Gremlin-Datenbankereignis

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
name	string	Der Name der ARM-Ressource.
properties.resource	Resource	Die Ressource eines Azure Cosmos DB Gremlin-Datenbankereignisses
type	string	Der Typ der Azure-Ressource.