Database Accounts - List Keys

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Listet die Zugriffstasten für das angegebene Azure Cosmos DB-Datenbankkonto auf.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys?api-version=2024-11-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. RegEx-Muster: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseAccountListKeysResult	Der Vorgang wurde erfolgreich abgeschlossen.

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

CosmosDBDatabaseAccountListKeys

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?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_database_account_list_keys.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.database_accounts.list_keys(
        resource_group_name="rg1",
        account_name="ddb1",
    )
    print(response)


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

{
  "primaryMasterKey": "primaryMasterKey",
  "secondaryMasterKey": "secondaryMasterKey",
  "primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
  "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}

Definitionen

DatabaseAccountListKeysResult

Die Zugriffstasten für das angegebene Datenbankkonto.

Name	Typ	Beschreibung
primaryMasterKey	string	Base64-codierter Wert des primären Lese-/Schreibzugriffsschlüssels.
primaryReadonlyMasterKey	string	Base64-codierter Wert des primären schreibgeschützten Schlüssels.
secondaryMasterKey	string	Base64-codierter Wert des sekundären Lese-/Schreibzugriffsschlüssels.
secondaryReadonlyMasterKey	string	Base64-codierter Wert des sekundären schreibgeschützten Schlüssels.

Freigeben über