az documentdb mongocluster replica

  • Vorschau

Hinweis

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

Die Befehlsgruppe "az documentdb mongocluster" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Replikat verwalten.

Befehle

Name Beschreibung Typ Status
az documentdb mongocluster replica create

Erstellen Sie ein Lesereplikat eines vorhandenen Mongoclusters.

 Extension Preview
az documentdb mongocluster replica list

Listet alle Replikate für den Mongocluster auf.

 Extension Preview
az documentdb mongocluster replica promote

Stuft einen Replikatmongocluster zu einer primären Rolle hoch.

 Extension Preview

az documentdb mongocluster replica create

Vorschau

Befehlsgruppe "az documentdb mongocluster replica" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Erstellen Sie ein Lesereplikat eines vorhandenen Mongoclusters.

Der Quellcluster muss die Vorschaufunktion "GeoReplicas" aktiviert haben. Das Replikat wird als neuer Mongo-Cluster bereitgestellt und erbt seine Konfiguration (Compute, Speicher, Sharding) vom Quellcluster. Ein Replikat in derselben Region wie die Quelle wird als In-Region AsyncReplicaerstellt; ein Replikat in einer anderen Region wird als bereichsübergreifendes GeoAsyncReplicaReplikat erstellt.

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

Beispiele

Erstellen Sie ein Replikat eines Clusters.

az documentdb mongocluster replica create -n MyReplica -g MyResourceGroup --location centralus --source-cluster MySourceCluster

Erforderliche Parameter

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

--source-cluster

Name oder Ressourcen-ID des Quell-Mongoclusters, aus dem repliziert werden soll. Wenn ein Name angegeben wird, wird die aktuelle Abonnement- und Ressourcengruppe angenommen. Stellen Sie eine vollständige ARM-ID für eine Quelle in einer anderen Ressourcengruppe oder einem anderen Abonnement bereit.

Eigenschaft Wert
Parametergruppe: Replica 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 replica list

Vorschau

Befehlsgruppe "az documentdb mongocluster replica" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Listet alle Replikate für den Mongocluster auf.

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

Beispiele

Auflisten von Replikaten eines Clusters.

az documentdb mongocluster replica list --source-cluster MyCluster -g MyResourceGroup

Erforderliche Parameter

--resource-group -g

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

--source-cluster

Der Name des Quellmongoclusters.

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

Vorschau

Befehlsgruppe "az documentdb mongocluster replica" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Stuft einen Replikatmongocluster zu einer primären Rolle hoch.

az documentdb mongocluster replica promote --promote-option {Forced}
                                           --source-cluster
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--ids]
                                           [--mode {Switchover}]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Beispiele

Höherstufen eines Replikats in den primären.

az documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced

Erforderliche Parameter

--promote-option

Die Höherstufenoption, die auf den Vorgang angewendet werden soll.

Eigenschaft Wert
Parametergruppe: Body Arguments
Zulässige Werte: Forced
--source-cluster

Name oder Ressourcen-ID des erwarteten Quellclusters (primär) dieses Replikats. Die Heraufstufung wird nur fortgesetzt, wenn sie dem tatsächlichen Quellcluster des Replikats entspricht; andernfalls schlägt der Vorgang fehl.

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

Der Modus, der auf den Heraufstufenvorgang angewendet werden soll. Der Wert ist optional, und der Standardwert ist "Switchover".

Eigenschaft Wert
Parametergruppe: Body Arguments
Zulässige Werte: Switchover
--name -n

Der Name des zu bewerbenden Replikats.

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