Restorable Mongodb Resources - List

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Gibt eine Liste der Datenbank- und Sammlungskombinationen zurück, die für das Konto zum angegebenen Zeitstempel und Speicherort vorhanden sind. Dies hilft in Szenarien, zu überprüfen, welche Ressourcen zu einem bestimmten Zeitstempel und Standort vorhanden sind. Diese API erfordert die Berechtigung "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read".

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instanceId-GUID eines wiederhergestellten Datenbankkontos.
location	path	True	string	Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort mit Großbuchstaben.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
restoreLocation	query		string	Der Speicherort, an dem sich die wiederherstellbaren Ressourcen befinden.
restoreTimestampInUtc	query		string	Der Zeitstempel, wenn die wiederherstellbaren Ressourcen vorhanden sind.

Antworten

Name	Typ	Beschreibung
200 OK	RestorableMongodbResourcesListResult	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

CosmosDBRestorableMongodbResourceList

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableMongodbResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

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_resource_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_mongodb_resources.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-11-15/examples/CosmosDBRestorableMongodbResourceList.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/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database1",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources",
      "name": "Database1",
      "databaseName": "Database1",
      "collectionNames": [
        "Collection1"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database2",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources",
      "name": "Database2",
      "databaseName": "Database2",
      "collectionNames": [
        "Collection1",
        "Collection2"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database3",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources",
      "name": "Database3",
      "databaseName": "Database3",
      "collectionNames": []
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
ErrorResponse	Fehlerantwort.
RestorableMongodbResourcesGetResult	Bestimmte Datenbanken, die wiederhergestellt werden sollen.
RestorableMongodbResourcesListResult	Die Antwort auf den Listenvorgang, die die wiederherstellbaren MongoDB-Ressourcen enthält.

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.

RestorableMongodbResourcesGetResult

Bestimmte Datenbanken, die wiederhergestellt werden sollen.

Name	Typ	Beschreibung
collectionNames	string[]	Die Namen der für die Wiederherstellung verfügbaren Auflistungen.
databaseName	string	Der Name der Datenbank, die für die Wiederherstellung verfügbar ist.
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
name	string	Der Name der ARM-Ressource.
type	string	Der Typ der Azure-Ressource.