az documentdb mongocluster user

Hinweis

Diese Referenz ist Teil der documentdb-Erweiterung für die Azure CLI (Version 2.75.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az documentdb mongocluster-Benutzerbefehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Benutzer verwalten.

Befehle

Name Beschreibung Typ Status
az documentdb mongocluster user create

Erstellen Sie einen neuen Benutzer oder aktualisiert einen vorhandenen Benutzer in einem Mongo-Cluster.

 Extension GA
az documentdb mongocluster user delete

Löschen sie einen Mongo-Clusterbenutzer.

 Extension GA
az documentdb mongocluster user list

Listen Sie alle Benutzer in einem Mongo-Cluster auf.

 Extension GA
az documentdb mongocluster user show

Rufen Sie die Definition eines Mongo-Clusterbenutzers ab.

 Extension GA
az documentdb mongocluster user update

Aktualisieren Sie einen neuen Benutzer oder aktualisiert einen vorhandenen Benutzer in einem Mongo-Cluster.

 Extension GA
az documentdb mongocluster user wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

 Extension GA

az documentdb mongocluster user create

Erstellen Sie einen neuen Benutzer oder aktualisiert einen vorhandenen Benutzer in einem Mongo-Cluster.

az documentdb mongocluster user create --cluster-name
                                       --name --user-name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--role --roles]
                                       [--type {ServicePrincipal, User}]

Beispiele

Erstellen Sie einen entra-gesicherten Benutzer.

az documentdb mongocluster user create -n alice-entra --cluster-name MyCluster -g MyResourceGroup --type User --role db=admin role=root

Erforderliche Parameter

--cluster-name

Der Name des Mongoclusters.

--name --user-name -n

Der Name des Mongo-Clusterbenutzers.

--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.

--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
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--role --roles

Datenbankrollen, die dem Benutzer zugewiesen sind. Verwendung: --role db=admin role=root. Mehrere Rollen können mit mehr als einem -role-Argument angegeben werden. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen. Singular flags: --role.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--type -t

Der Microsoft Entra Prinzipaltyp des Benutzers. Zulässige Werte: Benutzer, ServicePrincipal. Beispiel: --type User.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: ServicePrincipal, User
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 documentdb mongocluster user delete

Löschen sie einen Mongo-Clusterbenutzer.

az documentdb mongocluster user delete [--acquire-policy-token]
                                       [--change-reference]
                                       [--cluster-name]
                                       [--ids]
                                       [--name --user-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Beispiele

Löscht einen Benutzer.

az documentdb mongocluster user delete -n alice@contoso.com --cluster-name MyCluster -g MyResourceGroup

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
--cluster-name

Der Name des Mongoclusters.

Eigenschaft Wert
Parametergruppe: Resource Id 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 --user-name -n

Der Name des Mongo-Clusterbenutzers.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--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
--yes -y

Nicht um Bestätigung bitten.

Eigenschaft Wert
Standardwert: False
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

az documentdb mongocluster user list

Listen Sie alle Benutzer in einem Mongo-Cluster auf.

az documentdb mongocluster user list --cluster-name
                                     --resource-group
                                     [--max-items]
                                     [--next-token]

Beispiele

Auflisten von Benutzern in einem Cluster.

az documentdb mongocluster user list --cluster-name MyCluster -g MyResourceGroup

Erforderliche Parameter

--cluster-name

Der Name des Mongoclusters.

--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.

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft Wert
Parametergruppe: Pagination Arguments
--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

Eigenschaft Wert
Parametergruppe: Pagination 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/.

--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 documentdb mongocluster user show

Rufen Sie die Definition eines Mongo-Clusterbenutzers ab.

az documentdb mongocluster user show [--cluster-name]
                                     [--ids]
                                     [--name --user-name]
                                     [--resource-group]
                                     [--subscription]

Beispiele

Rufen Sie einen Benutzer ab.

az documentdb mongocluster user show -n alice@contoso.com --cluster-name MyCluster -g MyResourceGroup

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.

--cluster-name

Der Name des Mongoclusters.

Eigenschaft Wert
Parametergruppe: Resource Id 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 --user-name -n

Der Name des Mongo-Clusterbenutzers.

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

az documentdb mongocluster user update

Aktualisieren Sie einen neuen Benutzer oder aktualisiert einen vorhandenen Benutzer in einem Mongo-Cluster.

az documentdb mongocluster user update [--acquire-policy-token]
                                       [--add]
                                       [--change-reference]
                                       [--cluster-name]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--name --user-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--role --roles]
                                       [--set]
                                       [--subscription]
                                       [--type {ServicePrincipal, User}]

Beispiele

Aktualisieren sie die Rollen eines Benutzers.

az documentdb mongocluster user update -n alice-entra --cluster-name MyCluster -g MyResourceGroup --role db=admin role=root

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
--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
--change-reference

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

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--cluster-name

Der Name des Mongoclusters.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--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 --user-name -n

Der Name des Mongo-Clusterbenutzers.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parametergruppe: Generic Update 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
--role --roles

Datenbankrollen, die dem Benutzer zugewiesen sind. Verwendung: --role db=admin role=root. Mehrere Rollen können mit mehr als einem -role-Argument angegeben werden. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen. Singular flags: --role.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft Wert
Parametergruppe: Generic Update 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
--type -t

Der Microsoft Entra Prinzipaltyp des Benutzers. Zulässige Werte: Benutzer, ServicePrincipal. Beispiel: --type User.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: ServicePrincipal, User
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

az documentdb mongocluster user wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

az documentdb mongocluster user wait [--acquire-policy-token]
                                     [--change-reference]
                                     [--cluster-name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--name --user-name]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

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
--cluster-name

Der Name des Mongoclusters.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--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
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 30
--name --user-name -n

Der Name des Mongo-Clusterbenutzers.

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
--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
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