Restorable Database Accounts - List By Location

Odwołanie

Usługa:: Cosmos DB Resource Provider

Wersja interfejsu API:: 2024-11-15

Wyświetla listę wszystkich możliwych do przywrócenia kont bazy danych usługi Azure Cosmos DB dostępnych w ramach subskrypcji i w regionie. To wywołanie wymaga uprawnienia "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read".

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string	Region usługi Cosmos DB ze spacjami między wyrazami i każdym wyrazem wielkich liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RestorableDatabaseAccountsListResult	Operacja została ukończona pomyślnie.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBRestorableDatabaseAccountList

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/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_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_by_location(
        location="West US",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableDatabaseAccountList.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

Przykładowa odpowiedź

Kod stanu:: 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": "West 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"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
ApiType	Wyliczenie wskazujące typ interfejsu API konta bazy danych możliwego do przywrócenia.
CloudError	Odpowiedź na błąd z usługi.
ErrorResponse	Odpowiedź na błąd.
RestorableDatabaseAccountGetResult	Konto bazy danych z możliwością przywracania w usłudze Azure Cosmos DB.
RestorableDatabaseAccountsListResult	Odpowiedź operacji Lista zawierająca możliwe do przywrócenia konta bazy danych i ich właściwości.
RestorableLocationResource	Właściwości regionalnego konta możliwego do przywrócenia.

ApiType

Wyliczenie wskazujące typ interfejsu API konta bazy danych możliwego do przywrócenia.

Nazwa	Typ	Opis
Cassandra	string
Gremlin	string
GremlinV2	string
MongoDB	string
Sql	string
Table	string

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

RestorableDatabaseAccountGetResult

Konto bazy danych z możliwością przywracania w usłudze Azure Cosmos DB.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	Lokalizacja grupy zasobów, do której należy zasób.
name	string	Nazwa zasobu usługi ARM.
properties.accountName	string	Nazwa globalnego konta bazy danych
properties.apiType	ApiType	Typ interfejsu API konta bazy danych możliwego do przywrócenia.
properties.creationTime	string	Czas tworzenia konta bazy danych z możliwością przywracania (format ISO-8601).
properties.deletionTime	string	Czas, w którym konto bazy danych możliwe do przywrócenia zostało usunięte (format ISO-8601).
properties.oldestRestorableTime	string	Najmniej ostatni czas, w którym można przywrócić konto bazy danych (format ISO-8601).
properties.restorableLocations	RestorableLocationResource[]	Lista regionów, z których można przywrócić konto bazy danych.
type	string	Typ zasobu platformy Azure.

RestorableDatabaseAccountsListResult

Odpowiedź operacji Lista zawierająca możliwe do przywrócenia konta bazy danych i ich właściwości.

Nazwa	Typ	Opis
value	RestorableDatabaseAccountGetResult[]	Lista możliwych do przywrócenia kont bazy danych i ich właściwości.

RestorableLocationResource

Właściwości regionalnego konta możliwego do przywrócenia.

Nazwa	Typ	Opis
creationTime	string	Czas tworzenia regionalnego konta bazy danych z możliwością przywracania (format ISO-8601).
deletionTime	string	Czas usunięcia regionalnego konta bazy danych z możliwością przywracania (format ISO-8601).
locationName	string	Lokalizacja regionalnego konta możliwego do przywrócenia.
regionalDatabaseAccountInstanceId	string	Identyfikator wystąpienia regionalnego konta możliwego do przywrócenia.

Udostępnij za pośrednictwem