az documentdb mongocluster firewall-rule

Annotazioni

Questo riferimento fa parte dell'estensione documentdb per il interfaccia della riga di comando di Azure (versione 2.75.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az documentdb mongocluster firewall-rule . Altre informazioni sulle estensioni.

Gestire la regola del firewall.

Comandi

Nome Descrizione Tipo Status
az documentdb mongocluster firewall-rule create

Creare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

 Extension GA
az documentdb mongocluster firewall-rule delete

Eliminare una regola del firewall del cluster mongo.

 Extension GA
az documentdb mongocluster firewall-rule list

Elencare tutte le regole del firewall in un determinato cluster mongo.

 Extension GA
az documentdb mongocluster firewall-rule show

Ottenere informazioni su una regola del firewall del cluster mongo.

 Extension GA
az documentdb mongocluster firewall-rule update

Aggiornare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

 Extension GA
az documentdb mongocluster firewall-rule wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

 Extension GA

az documentdb mongocluster firewall-rule create

Creare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

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]

Esempio

Creare una regola del firewall.

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

Parametri necessari

--cluster-name

Nome del cluster mongo.

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

Nome della regola del firewall del cluster mongo.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--end-ip-address

Indirizzo IP finale della regola del firewall del cluster mongo. Deve essere formato IPv4.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--start-ip-address

Indirizzo IP iniziale della regola del firewall del cluster mongo. Deve essere formato IPv4.

Proprietà Valore
Gruppo di parametri: Properties Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster firewall-rule delete

Eliminare una regola del firewall del cluster mongo.

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]

Esempio

Elimina una regola del firewall.

az documentdb mongocluster firewall-rule delete -n AllowOffice --cluster-name MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--firewall-rule-name --name -n

Nome della regola del firewall del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--yes -y

Non richiedere conferma.

Proprietà Valore
Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster firewall-rule list

Elencare tutte le regole del firewall in un determinato cluster mongo.

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

Esempio

Elencare le regole del firewall in un cluster.

az documentdb mongocluster firewall-rule list --cluster-name MyCluster -g MyResourceGroup

Parametri necessari

--cluster-name

Nome del cluster mongo.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

Proprietà Valore
Gruppo di parametri: Pagination Arguments
--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Proprietà Valore
Gruppo di parametri: Pagination Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster firewall-rule show

Ottenere informazioni su una regola del firewall del cluster mongo.

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

Esempio

Ottenere una regola del firewall.

az documentdb mongocluster firewall-rule show -n AllowOffice --cluster-name MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--cluster-name

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--firewall-rule-name --name -n

Nome della regola del firewall del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster firewall-rule update

Aggiornare una nuova regola del firewall o aggiornare una regola del firewall esistente in un cluster mongo.

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]

Esempio

Aggiornare l'intervallo IP di una regola del firewall.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--end-ip-address

Indirizzo IP finale della regola del firewall del cluster mongo. Deve essere formato IPv4.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--firewall-rule-name --name -n

Nome della regola del firewall del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà Valore
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
--start-ip-address

Indirizzo IP iniziale della regola del firewall del cluster mongo. Deve essere formato IPv4.

Proprietà Valore
Gruppo di parametri: Properties Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az documentdb mongocluster firewall-rule wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

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]

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--cluster-name

Nome del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
--deleted

Attendere l'eliminazione.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--exists

Attendere che la risorsa esista.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
--firewall-rule-name --name -n

Nome della regola del firewall del cluster mongo.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--interval

Intervallo di polling in secondi.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: 30
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà Valore
Gruppo di parametri: Resource Id Arguments
--timeout

Attesa massima in secondi.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Proprietà Valore
Gruppo di parametri: Wait Condition Arguments
Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False