Restorable Mongodb Collections - List

Odwołanie

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Pokaż kanał informacyjny zdarzeń wszystkich mutacji wykonanych we wszystkich kolekcjach bazy danych MongoDB usługi Azure Cosmos DB w ramach określonej bazy danych. Pomaga to w scenariuszu, w którym kontener został przypadkowo usunięty. Ten interfejs API wymaga uprawnienia "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read"

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

With optional parameters:

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

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.
endTime	query		string	Przywracalny czas zakończenia zbierania zdarzeń bazy danych MongoDB.
restorableMongodbDatabaseRid	query		string	Identyfikator zasobu bazy danych MongoDB.
startTime	query		string	Przywracalny czas rozpoczęcia źródła zdarzeń kolekcji MongoDB.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RestorableMongodbCollectionsListResult	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

CosmosDBRestorableMongodbCollectionList

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections?api-version=2024-05-15&restorableMongodbDatabaseRid=PD5DALigDgw=

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_mongodb_collection_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_mongodb_collections.list(
        location="WestUS",
        instance_id="98a570f2-63db-4117-91f0-366327b7b353",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBRestorableMongodbCollectionList.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/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Collection1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Collection1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput."
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź błędu z usługi.
ErrorResponse	Odpowiedź na błąd.
OperationType	Wyliczenie wskazujące typ operacji zdarzenia.
Resource	Zasób zdarzenia kolekcji MongoDB usługi Azure Cosmos DB
RestorableMongodbCollectionGetResult	Zdarzenie zbierania danych MongoDB w usłudze Azure Cosmos DB
RestorableMongodbCollectionsListResult	Odpowiedź operacji Lista zawierająca zdarzenia kolekcji MongoDB i ich właściwości.

CloudError

Odpowiedź błędu 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ę.

OperationType

Wyliczenie wskazujące typ operacji zdarzenia.

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

Resource

Zasób zdarzenia kolekcji MongoDB usługi Azure Cosmos DB

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

RestorableMongodbCollectionGetResult

Zdarzenie zbierania danych MongoDB w usłudze 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 kolekcji MongoDB usługi Azure Cosmos DB
type	string	Typ zasobu platformy Azure.