Restorable Mongodb Collections - List

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Egy adott adatbázis összes Azure Cosmos DB MongoDB-gyűjteményében végrehajtott összes mutáció eseménycsatornájának megjelenítése. Ez segít abban az esetben, ha a tárolót véletlenül törölték. 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}/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}

URI-paraméterek

Name	In	Kötelező	Típus	Description
instanceId	path	True	string	Egy 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ó.
endTime	query		string	Visszaállítható MongoDB-gyűjtemények eseménycsatorna befejezési ideje.
restorableMongodbDatabaseRid	query		string	A MongoDB-adatbázis erőforrás-azonosítója.
startTime	query		string	Visszaállítható MongoDB-gyűjtemények eseménycsatorna kezdési időpontja.

Válaszok

Name	Típus	Description
200 OK	RestorableMongodbCollectionsListResult	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

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

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
ErrorResponse	Hibaválasz.
OperationType	Enumerálás az esemény művelettípusának jelzéséhez.
Resource	Egy Azure Cosmos DB MongoDB-gyűjteményesemény erőforrása
RestorableMongodbCollectionGetResult	Azure Cosmos DB MongoDB-gyűjtési esemény
RestorableMongodbCollectionsListResult	A List műveleti válasz, amely a MongoDB-gyűjtemény eseményeit és azok tulajdonságait tartalmazza.

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, amely jelzi, hogy a művelet miért hiúsult meg.

OperationType

Enumerálás 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 MongoDB-gyűjteményesemény erőforrása

Name	Típus	Description
_rid	string	Rendszer által létrehozott tulajdonság. Egy egyedi azonosító.
canUndelete	string	A gyűjtemény állapota annak azonosítására, hogy a tároló visszaállítható-e ugyanabban a fiókban.
canUndeleteReason	string	Ez az oka annak, hogy ez a gyűjtemény nem állítható vissza ugyanabban a fiókban.
eventTimestamp	string	A gyűjtési esemény bekövetkezésének időpontja.
operationType	OperationType	A gyűjteményesemény művelettípusa.
ownerId	string	A MongoDB-gyűjtemény neve.
ownerResourceId	string	A MongoDB-gyűjtemény erőforrás-azonosítója.

RestorableMongodbCollectionGetResult

Azure Cosmos DB MongoDB-gyűjtési esemény

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