Freigeben über


az cosmosdb keys

Verwalten sie Azure Cosmos DB Schlüssel.

Befehle

Name Beschreibung Typ Status
az cosmosdb keys list

Auflisten der Zugriffstasten oder Verbindungszeichenfolgen für ein Azure Cosmos DB Datenbankkonto.

Core GA
az cosmosdb keys regenerate

Generieren Sie einen Zugriffsschlüssel für ein Azure Cosmos DB Datenbankkonto neu.

Core GA

az cosmosdb keys list

Auflisten der Zugriffstasten oder Verbindungszeichenfolgen für ein Azure Cosmos DB Datenbankkonto.

az cosmosdb keys list --name
                      --resource-group
                      [--type {connection-strings, keys, read-only-keys}]

Beispiele

Auflisten der Zugriffstasten oder Verbindungszeichenfolgen für ein Azure Cosmos DB Datenbankkonto. (autogenerated)

az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys

Erforderliche Parameter

--name -n

Cosmosdb-Kontoname.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--type

Der Kontoschlüsseltyp.

Eigenschaft Wert
Standardwert: keys
Zulässige Werte: connection-strings, keys, read-only-keys
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az cosmosdb keys regenerate

Generieren Sie einen Zugriffsschlüssel für ein Azure Cosmos DB Datenbankkonto neu.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--acquire-policy-token]
                            [--change-reference]
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Beispiele

Generieren Sie primärReadonly-Zugriffsschlüssel für ein Azure Cosmos DB Datenbankkonto neu.

az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

Erforderliche Parameter

--key-kind

Die Zugriffstaste, die neu generiert werden soll.

Eigenschaft Wert
Zulässige Werte: primary, primaryReadonly, secondary, secondaryReadonly

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--name -n

Name des Cosmos DB-Datenbankkontos.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False