az documentdb mongocluster firewall-rule

Vorschau

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 firewall-rule-Befehl 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

Firewallregel verwalten.

Befehle

Name	Beschreibung	Typ	Status
az documentdb mongocluster firewall-rule create	Erstellen Sie eine neue Firewallregel, oder aktualisieren Sie eine vorhandene Firewallregel auf einem Mongocluster.	Extension	Preview
az documentdb mongocluster firewall-rule delete	Löschen Sie eine Mongo-Clusterfirewallregel.	Extension	Preview
az documentdb mongocluster firewall-rule list	Listet alle Firewallregeln in einem bestimmten Mongocluster auf.	Extension	Preview
az documentdb mongocluster firewall-rule show	Abrufen von Informationen zu einer Mongo-Clusterfirewallregel.	Extension	Preview
az documentdb mongocluster firewall-rule update	Aktualisieren Sie eine neue Firewallregel, oder aktualisieren Sie eine vorhandene Firewallregel auf einem Mongocluster.	Extension	Preview
az documentdb mongocluster firewall-rule wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.	Extension	Preview

az documentdb mongocluster firewall-rule create

Vorschau

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

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

az documentdb mongocluster firewall-rule create --cluster-name
                                                --firewall-rule-name --name
                                                --resource-group
                                                [--acquire-policy-token]
                                                [--change-reference]
                                                [--end-ip-address]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--start-ip-address]

Beispiele

Erstellen Sie eine Firewallregel.

az documentdb mongocluster firewall-rule create -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --start-ip-address 1.2.3.4 --end-ip-address 1.2.3.9

Erforderliche Parameter

--cluster-name

Der Name des Mongoclusters.

--firewall-rule-name --name -n

Der Name der Mongo-Clusterfirewallregel.

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

--end-ip-address

Die IP-Endadresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein.

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

--start-ip-address

Die Start-IP-Adresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein.

Eigenschaft	Wert
Parametergruppe:	Properties 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 firewall-rule delete

Vorschau

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

Löschen Sie eine Mongo-Clusterfirewallregel.

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

Beispiele

Eine Firewall-Regel löschen.

az documentdb mongocluster firewall-rule delete -n AllowOffice --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

--firewall-rule-name --name -n

Der Name der Mongo-Clusterfirewallregel.

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

Vorschau

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

Listet alle Firewallregeln in einem bestimmten Mongocluster auf.

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

Beispiele

Firewallregeln auf einem Cluster auflisten.

az documentdb mongocluster firewall-rule 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 firewall-rule show

Vorschau

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

Abrufen von Informationen zu einer Mongo-Clusterfirewallregel.

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

Beispiele

Rufen Sie eine Firewallregel ab.

az documentdb mongocluster firewall-rule show -n AllowOffice --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

--firewall-rule-name --name -n

Der Name der Mongo-Clusterfirewallregel.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

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

Vorschau

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

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

az documentdb mongocluster firewall-rule update [--acquire-policy-token]
                                                [--add]
                                                [--change-reference]
                                                [--cluster-name]
                                                [--end-ip-address]
                                                [--firewall-rule-name --name]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--remove]
                                                [--resource-group]
                                                [--set]
                                                [--start-ip-address]
                                                [--subscription]

Beispiele

Aktualisieren Sie den IP-Bereich einer Firewallregel.

az documentdb mongocluster firewall-rule update -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --end-ip-address 1.2.3.20

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

--end-ip-address

Die IP-Endadresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein.

Eigenschaft	Wert
Parametergruppe:	Properties Arguments

--firewall-rule-name --name -n

Der Name der Mongo-Clusterfirewallregel.

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

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

--set

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

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--start-ip-address

Die Start-IP-Adresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein.

Eigenschaft	Wert
Parametergruppe:	Properties 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 firewall-rule wait

Vorschau

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

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

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

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

--firewall-rule-name --name -n

Der Name der Mongo-Clusterfirewallregel.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

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

Feedback

War diese Seite hilfreich?