Restorable Database Accounts - List

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Listet alle wiederherstellbaren Azure Cosmos DB-Datenbankkonten auf, die unter dem Abonnement verfügbar sind. Für diesen Aufruf ist die Berechtigung "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read" erforderlich.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts?api-version=2024-11-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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	RestorableDatabaseAccountsListResult	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

CosmosDBRestorableDatabaseAccountNoLocationList

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/restorableDatabaseAccounts?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_database_account_no_location_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="subid",
    )

    response = client.restorable_database_accounts.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableDatabaseAccountNoLocationList.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/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "location": "West US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb1",
        "creationTime": "2020-04-11T21:56:15Z",
        "deletionTime": "2021-03-12T22:05:09Z",
        "oldestRestorableTime": "2021-03-12T22:05:09Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "location": "East US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb2",
        "creationTime": "2020-05-01T08:05:18Z",
        "oldestRestorableTime": "2020-05-01T08:05:18Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ApiType	Aufzählung, um den API-Typ des wiederherstellbaren Datenbankkontos anzugeben.
CloudError	Eine Fehlerantwort des Diensts.
ErrorResponse	Fehlerantwort.
RestorableDatabaseAccountGetResult	Ein wiederhergestelltes Azure Cosmos DB-Datenbankkonto.
RestorableDatabaseAccountsListResult	Die Antwort auf den Listenvorgang, die die wiederherstellbaren Datenbankkonten und deren Eigenschaften enthält.
RestorableLocationResource	Eigenschaften des regionalen wiederherstellbaren Kontos.

ApiType

Aufzählung, um den API-Typ des wiederherstellbaren Datenbankkontos anzugeben.

Name	Typ	Beschreibung
Cassandra	string
Gremlin	string
GremlinV2	string
MongoDB	string
Sql	string
Table	string

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.

RestorableDatabaseAccountGetResult

Ein wiederhergestelltes Azure Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string	Der Name der ARM-Ressource.
properties.accountName	string	Der Name des globalen Datenbankkontos
properties.apiType	ApiType	Der API-Typ des wiederherstellbaren Datenbankkontos.
properties.creationTime	string	Die Erstellungszeit des wiederherstellbaren Datenbankkontos (ISO-8601-Format).
properties.deletionTime	string	Der Zeitpunkt, zu dem das wiederherstellbare Datenbankkonto gelöscht wurde (ISO-8601-Format).
properties.oldestRestorableTime	string	Die zuletzt verwendete Zeit, zu der das Datenbankkonto wiederhergestellt werden kann (ISO-8601-Format).
properties.restorableLocations	RestorableLocationResource[]	Liste der Regionen, in denen das Datenbankkonto wiederhergestellt werden kann.
type	string	Der Typ der Azure-Ressource.