Restorable Gremlin Databases - List

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

A visszaállítható fiók alatti összes Azure Cosmos DB Gremlin-adatbázisban végrehajtott összes mutáció eseménycsatornájának megjelenítése. Ez segít abban az esetben, ha az adatbázist véletlenül törölték a törlési idő lekéréséhez. Ehhez az API-hoz "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read" engedély szükséges

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
instanceId	path	True	string	Visszaállítható adatbázisfiók instanceId GUID azonosítója.
location	path	True	string	Cosmos DB-régió, a szavak és az egyes szavak közötti szóközök nagybetűvel.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	RestorableGremlinDatabasesListResult	A művelet sikeresen befejeződött.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Példák

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-05-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-05-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

Sample Response

Status code:: 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."
        }
      }
    }
  ]
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
ErrorResponse	Hibaválasz.
OperationType	Szám az esemény művelettípusának jelzéséhez.
Resource	Egy Azure Cosmos DB Gremlin-adatbázisesemény erőforrása
RestorableGremlinDatabaseGetResult	Azure Cosmos DB Gremlin-adatbázisesemény
RestorableGremlinDatabasesListResult	A Lista művelet válasza, amely tartalmazza a Gremlin-adatbázis eseményeit és tulajdonságait.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	ErrorResponse	Hibaválasz.

ErrorResponse

Hibaválasz.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

OperationType

Szám az esemény művelettípusának jelzéséhez.

Name	Típus	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

Egy Azure Cosmos DB Gremlin-adatbázisesemény erőforrása

Name	Típus	Description
_rid	string	Rendszer által létrehozott tulajdonság. Egyedi azonosító.
canUndelete	string	Az adatbázis állapota annak megállapításához, hogy az adatbázis visszaállítható-e ugyanabban a fiókban.
canUndeleteReason	string	Ez az oka annak, hogy az adatbázis nem állítható vissza ugyanabban a fiókban.
eventTimestamp	string	Az adatbázis-esemény bekövetkezésének időpontja.
operationType	OperationType	Az adatbázisesemény művelettípusa.
ownerId	string	A Gremlin-adatbázis neve.
ownerResourceId	string	A Gremlin-adatbázis erőforrás-azonosítója.

RestorableGremlinDatabaseGetResult

Azure Cosmos DB Gremlin-adatbázisesemény

Name	Típus	Description
id	string	Az ARM-erőforrás egyedi azonosítója.
name	string	Az ARM-erőforrás neve.
properties.resource	Resource	Egy Azure Cosmos DB Gremlin-adatbázisesemény erőforrása
type	string	Az Azure-erőforrás típusa.