Restorable Sql Databases - List

Service:

Cosmos DB Resource Provider

API Version:

2024-05-15

Pokaż źródło zdarzeń wszystkich mutacji wykonanych we wszystkich bazach danych SQL usługi Azure Cosmos DB w ramach konta możliwego do przywrócenia. Pomaga to w scenariuszu, w którym baza danych została przypadkowo usunięta, aby uzyskać czas usunięcia. Ten interfejs API wymaga uprawnienia "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read"

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
instanceId	path	True	string	Identyfikator GUID wystąpienia konta bazy danych z możliwością przywracania.
location	path	True	string	Region usługi Cosmos DB ze spacjami między wyrazami a każdym wyrazem z literami.
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	RestorableSqlDatabasesListResult	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 OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBRestorableSqlDatabaseList

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/restorableSqlDatabases?api-version=2024-05-15

Python

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_sql_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_sql_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/CosmosDBRestorableSqlDatabaseList.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/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź błędu z usługi.
CreateMode	Wyliczenie wskazujące tryb tworzenia konta.
Database	Obiekt zasobu bazy danych SQL usługi Cosmos DB
ErrorResponse	Odpowiedź na błąd.
OperationType	Wyliczenie wskazujące typ operacji zdarzenia.
Resource	Zasób zdarzenia bazy danych SQL usługi Azure Cosmos DB
ResourceRestoreParameters	Parametry wskazujące informacje o przywracaniu.
RestorableSqlDatabaseGetResult	Zdarzenie bazy danych SQL usługi Azure Cosmos DB
RestorableSqlDatabasesListResult	Odpowiedź operacji Lista zawierająca zdarzenia bazy danych SQL i ich właściwości.

CloudError

Odpowiedź błędu z usługi.

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

CreateMode

Wyliczenie wskazujące tryb tworzenia konta.

Nazwa	Typ	Opis
Default	string
Restore	string

Database

Obiekt zasobu bazy danych SQL usługi Cosmos DB

Nazwa	Typ	Wartość domyślna	Opis
_colls	string		Właściwość wygenerowana przez system, która określiła ścieżkę adresową zasobu kolekcji.
_etag	string		Właściwość wygenerowana przez system reprezentująca tag zasobu wymagany dla optymistycznej kontrolki współbieżności.
_rid	string		Właściwość wygenerowana przez system. Unikatowy identyfikator.
_self	string		Właściwość wygenerowana przez system, która określa ścieżkę adresową zasobu bazy danych.
_ts	number		Właściwość wygenerowana przez system, która określa ostatnią zaktualizowaną sygnaturę czasową zasobu.
_users	string		Właściwość wygenerowana przez system, która określa ścieżkę adresową zasobu użytkowników.
createMode	CreateMode	Default	Wyliczenie wskazujące tryb tworzenia zasobów.
id	string		Nazwa bazy danych SQL usługi Cosmos DB
restoreParameters	ResourceRestoreParameters		Parametry wskazujące informacje o przywracaniu

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ę.

OperationType

Wyliczenie wskazujące typ operacji zdarzenia.

Nazwa	Typ	Opis
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

Zasób zdarzenia bazy danych SQL usługi Azure Cosmos DB

Nazwa	Typ	Opis
_rid	string	Właściwość wygenerowana przez system. Unikatowy identyfikator.
canUndelete	string	Stan tej bazy danych do określenia, czy ta baza danych można przywrócić na tym samym koncie.
canUndeleteReason	string	Przyczyna, dla którego nie można przywrócić tej bazy danych na tym samym koncie.
database	Database	Obiekt zasobu bazy danych SQL usługi Cosmos DB
eventTimestamp	string	Czas wystąpienia tego zdarzenia bazy danych.
operationType	OperationType	Typ operacji tego zdarzenia bazy danych.
ownerId	string	Nazwa bazy danych SQL.
ownerResourceId	string	Identyfikator zasobu bazy danych SQL.

ResourceRestoreParameters

Parametry wskazujące informacje o przywracaniu.

Nazwa	Typ	Opis
restoreSource	string	Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Czas przywrócenia konta (format ISO-8601).

RestorableSqlDatabaseGetResult

Zdarzenie bazy danych SQL usługi Azure Cosmos DB

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
name	string	Nazwa zasobu usługi ARM.
properties.resource	Resource	Zasób zdarzenia bazy danych SQL usługi Azure Cosmos DB
type	string	Typ zasobu platformy Azure.

RestorableSqlDatabasesListResult

Odpowiedź operacji Lista zawierająca zdarzenia bazy danych SQL i ich właściwości.

Nazwa	Typ	Opis
value	RestorableSqlDatabaseGetResult[]	Lista zdarzeń bazy danych SQL i ich właściwości.