az documentdb mongocluster

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-Befehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten des Mongo-Clusters.

Befehle

Name Beschreibung Typ Status
az documentdb mongocluster check-name-availability

Überprüfen Sie, ob der Mongo-Clustername zur Verwendung verfügbar ist.

 Extension GA
az documentdb mongocluster create

Erstellen Sie einen Mongocluster. Aktualisieren überschreibt alle Eigenschaften für die Ressource. Verwenden Sie PATCH, um nur einige der Eigenschaften zu ändern.

 Extension GA
az documentdb mongocluster delete

Löschen Eines Mongoclusters.

 Extension GA
az documentdb mongocluster firewall-rule

Firewallregel verwalten.

 Extension GA
az documentdb mongocluster firewall-rule create

Erstellen Sie eine neue Firewallregel, oder aktualisieren Sie eine vorhandene Firewallregel auf einem Mongocluster.

 Extension GA
az documentdb mongocluster firewall-rule delete

Löschen Sie eine Mongo-Clusterfirewallregel.

 Extension GA
az documentdb mongocluster firewall-rule list

Listet alle Firewallregeln in einem bestimmten Mongocluster auf.

 Extension GA
az documentdb mongocluster firewall-rule show

Abrufen von Informationen zu einer Mongo-Clusterfirewallregel.

 Extension GA
az documentdb mongocluster firewall-rule update

Aktualisieren Sie eine neue Firewallregel, oder aktualisieren Sie eine vorhandene Firewallregel auf einem Mongocluster.

 Extension GA
az documentdb mongocluster firewall-rule wait

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

 Extension GA
az documentdb mongocluster identity

Identität verwalten.

 Extension GA
az documentdb mongocluster identity assign

Weisen Sie die vom Benutzer oder System verwalteten Identitäten zu.

 Extension GA
az documentdb mongocluster identity remove

Entfernen Sie die vom Benutzer oder System verwalteten Identitäten.

 Extension GA
az documentdb mongocluster identity show

Zeigen Sie die Details der verwalteten Identitäten an.

 Extension GA
az documentdb mongocluster identity wait

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

 Extension GA
az documentdb mongocluster list

Listet alle Mongocluster in einem bestimmten Abonnement auf.

 Extension GA
az documentdb mongocluster list-connection-strings

Auflisten von Mongo-Clusterverbindungszeichenfolgen. Dazu gehören die Standardverbindungszeichenfolge mit SCRAM-SHA-256 sowie andere vom Cluster unterstützte Verbindungszeichenfolgen.

 Extension GA
az documentdb mongocluster replica

Replikat verwalten.

 Extension GA
az documentdb mongocluster replica create

Erstellen Sie ein regionsübergreifendes Lesereplikat eines vorhandenen Mongoclusters.

 Extension GA
az documentdb mongocluster replica list

Listet alle Replikate für den Mongocluster auf.

 Extension GA
az documentdb mongocluster replica promote

Stuft einen Replikatmongocluster zu einer primären Rolle hoch.

 Extension GA
az documentdb mongocluster reset-password

Setzen Sie das Administratorkennwort eines Mongoclusters zurück.

 Extension GA
az documentdb mongocluster restore

Stellen Sie einen Mongocluster von einem Zeitpunkt an auf einen neuen Cluster zurück.

 Extension GA
az documentdb mongocluster show

Abrufen von Informationen zu einem Mongocluster.

 Extension GA
az documentdb mongocluster update

Aktualisieren sie einen Mongocluster. Aktualisieren überschreibt alle Eigenschaften für die Ressource. Verwenden Sie PATCH, um nur einige der Eigenschaften zu ändern.

 Extension GA
az documentdb mongocluster user

Benutzer verwalten.

 Extension GA
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 wait

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

 Extension GA

az documentdb mongocluster check-name-availability

Überprüfen Sie, ob der Mongo-Clustername zur Verwendung verfügbar ist.

az documentdb mongocluster check-name-availability [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--ids]
                                                   [--location]
                                                   [--name]
                                                   [--subscription]
                                                   [--type]

Beispiele

Überprüfen Sie, ob ein Mongoclustername verfügbar ist.

az documentdb mongocluster check-name-availability --location eastus --name MyCluster

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
--location -l

Location. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--name

Der Name der Ressource, für die die Verfügbarkeit überprüft werden muss.

Eigenschaft Wert
Parametergruppe: Body 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

Der Ressourcentyp.

Eigenschaft Wert
Parametergruppe: Body Arguments
Standardwert: Microsoft.DocumentDB/mongoClusters
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 create

Erstellen Sie einen Mongocluster. Aktualisieren überschreibt alle Eigenschaften für die Ressource. Verwenden Sie PATCH, um nur einige der Eigenschaften zu ändern.

az documentdb mongocluster create --admin-password
                                  --admin-user
                                  --cluster-name --name
                                  --high-availability {Disabled, SameZone, ZoneRedundantPreferred}
                                  --resource-group
                                  --shard-count
                                  --storage-size
                                  --tier
                                  [--acquire-policy-token]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--location]
                                  [--mi-user-assigned --user-assigned]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--server-version]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--tags]

Beispiele

Erstellen Sie einen Mongo-Cluster mit Premium SSD v2-Speicher.

az documentdb mongocluster create -n MyCluster -g MyResourceGroup --location eastus --admin-user dbadmin --admin-password MyP@ssw0rd123! --tier M30 --storage-size 128 --storage-type PremiumSSDv2 --shard-count 1 --high-availability Disabled

Erforderliche Parameter

--admin-password -p

Das Administratorkennwort. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--admin-user -u

Der Administratorbenutzername.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--cluster-name --name -n

Der Name des Mongoclusters.

--high-availability

Der für den Cluster angeforderte Zielmodus für hohe Verfügbarkeit.

Eigenschaft Wert
Parametergruppe: HighAvailability Arguments
Zulässige Werte: Disabled, SameZone, ZoneRedundantPreferred
--resource-group -g

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

--shard-count

Anzahl der Für den Cluster bereitzustellenden Shards.

Eigenschaft Wert
Parametergruppe: Sharding Arguments
--storage-size

Die Größe des Datenträgers, der jedem Server zugewiesen ist.

Eigenschaft Wert
Parametergruppe: Storage Arguments
--tier

Die Computeebene, die dem Cluster zugewiesen werden soll, wobei jede Ebene einer größe des virtuellen Kerns und des Arbeitsspeichers zugeordnet ist. Beispielwerte: 'M30', 'M40'.

Eigenschaft Wert
Parametergruppe: Compute Arguments

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
--auth-allowed-modes

Durch Leerzeichen getrennte Liste der zulässigen Authentifizierungsmodi für den Datenzugriff. Zulässige Werte: NativeAuth, MicrosoftEntraID. Beispiel: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file and yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: AuthConfig Arguments
--change-reference

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

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--data-api-mode

Aktivieren oder deaktivieren Sie die Mongo-Daten-API im Cluster. Zulässige Werte: „Aktiviert“, „Deaktiviert“ Beispiel: --data-api-mode Enabled.

Eigenschaft Wert
Parametergruppe: DataApi Arguments
Zulässige Werte: Disabled, Enabled
--encryption

Die Verschlüsselungskonfiguration für den Cluster. Hängt von der Konfiguration der Identität ab. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--location -l

Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort der Ressourcengruppe verwendet.

Eigenschaft Wert
Parametergruppe: Resource Arguments
--mi-user-assigned --user-assigned

Legen Sie die vom Benutzer verwalteten Identitäten fest. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Identity Arguments
--network-bypass-mode

Der Netzwerk-Bypass-Modus für den Cluster. Die Einstellung auf 'AzureCosmosDB' ermöglicht es Azure Cosmos DB-Diensten, Netzwerkbeschränkungen zu umgehen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: AzureCosmosDB, None
--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
--preview-features

Liste der privaten Endpunktverbindungen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--public-network-access

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: Disabled, Enabled
--server-version

Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--storage-type

Der Speichertyp, mit dem die Clusterserver bereitgestellt werden sollen.

Eigenschaft Wert
Parametergruppe: Storage Arguments
Zulässige Werte: PremiumSSD, PremiumSSDv2
--tags

Ressourcenkennzeichnungen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Resource 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 delete

Löschen Eines Mongoclusters.

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

Beispiele

Löschen Eines Mongoclusters.

az documentdb mongocluster delete -n 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 --name -n

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

Listet alle Mongocluster in einem bestimmten Abonnement auf.

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

Beispiele

Auflisten aller Mongocluster in einer Ressourcengruppe.

az documentdb mongocluster list -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.

--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
--resource-group -g

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

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 list-connection-strings

Auflisten von Mongo-Clusterverbindungszeichenfolgen. Dazu gehören die Standardverbindungszeichenfolge mit SCRAM-SHA-256 sowie andere vom Cluster unterstützte Verbindungszeichenfolgen.

az documentdb mongocluster list-connection-strings [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--resource-group]
                                                   [--subscription]

Beispiele

Listen Sie die Verbindungszeichenfolgen für einen Mongocluster auf.

az documentdb mongocluster list-connection-strings --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
--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 reset-password

Setzen Sie das Administratorkennwort eines Mongoclusters zurück.

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

Beispiele

Setzen Sie das Administratorkennwort zurück.

az documentdb mongocluster reset-password -n MyCluster -g MyResourceGroup --password NewP@ssw0rd123!

Erforderliche Parameter

--password -p

Das neue Administratorkennwort. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parametergruppe: Administrator Arguments

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

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

Stellen Sie einen Mongocluster von einem Zeitpunkt an auf einen neuen Cluster zurück.

Erstellt einen neuen Mongo-Cluster aus der Sicherung eines vorhandenen (oder gelöschten) Quellclusters zum angeforderten Zeitpunkt.

az documentdb mongocluster restore --admin-password
                                   --admin-user
                                   --cluster-name --name
                                   --resource-group
                                   --restore-time
                                   --source-cluster
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--location]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Beispiele

Stellen Sie einen Cluster zu einem Zeitpunkt wieder her.

az documentdb mongocluster restore -n RestoredCluster -g MyResourceGroup --location eastus2 --source-cluster MySourceCluster --restore-time "2026-06-30T10:00:00Z" --admin-user dbadmin --admin-password MyP@ssw0rd123!

Erforderliche Parameter

--admin-password -p

Das Administratorkennwort. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--admin-user -u

Der Administratorbenutzername.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--cluster-name --name -n

Der Name des Mongoclusters.

--resource-group -g

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

--restore-time

UTC-Zeitpunkt für die Wiederherstellung im ISO-8601-Format (z. B. 2026-06-30T10:00:00Z).

Eigenschaft Wert
Parametergruppe: Restore Arguments
--source-cluster

Name oder Ressourcen-ID des Quellmongoclusters, aus dem wiederhergestellt werden soll. Wenn ein Name angegeben wird, wird die aktuelle Abonnement- und Ressourcengruppe angenommen.

Eigenschaft Wert
Parametergruppe: Restore Arguments

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
--location -l

Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort der Ressourcengruppe verwendet.

Eigenschaft Wert
Parametergruppe: Resource 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
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 show

Abrufen von Informationen zu einem Mongocluster.

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

Beispiele

Abrufen von Informationen zu einem Mongocluster.

az documentdb mongocluster show -n 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 --name -n

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

Aktualisieren sie einen Mongocluster. Aktualisieren überschreibt alle Eigenschaften für die Ressource. Verwenden Sie PATCH, um nur einige der Eigenschaften zu ändern.

az documentdb mongocluster update [--acquire-policy-token]
                                  [--add]
                                  [--admin-password]
                                  [--admin-user]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--high-availability {Disabled, SameZone, ZoneRedundantPreferred}]
                                  [--ids]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--remove]
                                  [--resource-group]
                                  [--server-version]
                                  [--set]
                                  [--shard-count]
                                  [--storage-size]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--subscription]
                                  [--tags]
                                  [--tier]

Beispiele

Aktualisieren Sie die Computeebene eines Mongoclusters.

az documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40

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
--admin-password -p

Das Administratorkennwort. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--admin-user -u

Der Administratorbenutzername.

Eigenschaft Wert
Parametergruppe: Administrator Arguments
--auth-allowed-modes

Durch Leerzeichen getrennte Liste der zulässigen Authentifizierungsmodi für den Datenzugriff. Zulässige Werte: NativeAuth, MicrosoftEntraID. Beispiel: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file and yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: AuthConfig Arguments
--change-reference

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

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

Der Name des Mongoclusters.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--data-api-mode

Aktivieren oder deaktivieren Sie die Mongo-Daten-API im Cluster. Zulässige Werte: „Aktiviert“, „Deaktiviert“ Beispiel: --data-api-mode Enabled.

Eigenschaft Wert
Parametergruppe: DataApi Arguments
Zulässige Werte: Disabled, Enabled
--encryption

Die Verschlüsselungskonfiguration für den Cluster. Hängt von der Konfiguration der Identität ab. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties 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
--high-availability

Der für den Cluster angeforderte Zielmodus für hohe Verfügbarkeit.

Eigenschaft Wert
Parametergruppe: HighAvailability Arguments
Zulässige Werte: Disabled, SameZone, ZoneRedundantPreferred
--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
--network-bypass-mode

Der Netzwerk-Bypass-Modus für den Cluster. Die Einstellung auf 'AzureCosmosDB' ermöglicht es Azure Cosmos DB-Diensten, Netzwerkbeschränkungen zu umgehen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: AzureCosmosDB, None
--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
--preview-features

Liste der privaten Endpunktverbindungen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--public-network-access

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: Disabled, Enabled
--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
--server-version

Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.

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
--shard-count

Anzahl der Für den Cluster bereitzustellenden Shards.

Eigenschaft Wert
Parametergruppe: Sharding Arguments
--storage-size

Die Größe des Datenträgers, der jedem Server zugewiesen ist.

Eigenschaft Wert
Parametergruppe: Storage Arguments
--storage-type

Der Speichertyp, mit dem die Clusterserver bereitgestellt werden sollen.

Eigenschaft Wert
Parametergruppe: Storage Arguments
Zulässige Werte: PremiumSSD, PremiumSSDv2
--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
--tags

Ressourcenkennzeichnungen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Resource Arguments
--tier

Die Computeebene, die dem Cluster zugewiesen werden soll, wobei jede Ebene einer größe des virtuellen Kerns und des Arbeitsspeichers zugeordnet ist. Beispielwerte: 'M30', 'M40'.

Eigenschaft Wert
Parametergruppe: Compute 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 wait

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

az documentdb mongocluster wait [--acquire-policy-token]
                                [--change-reference]
                                [--cluster-name --name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--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 --name -n

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