az cosmosdb mongocluster firewall rule

Preview
Reference

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb mongocluster firewall rule command. Learn more about extensions.

Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Mongo cluster firewall rule.

Commands

Name	Description	Type	Status
az cosmosdb mongocluster firewall rule create	Create a Mongo cluster firewall rule.	Extension	Preview
az cosmosdb mongocluster firewall rule delete	Delete a Mongo cluster firewall rule.	Extension	Preview
az cosmosdb mongocluster firewall rule list	Lists firewall rule on a Mongo cluster.	Extension	Preview
az cosmosdb mongocluster firewall rule show	Get a Mongo cluster firewall rule.	Extension	Preview
az cosmosdb mongocluster firewall rule update	Create a Mongo cluster firewall rule.	Extension	Preview

az cosmosdb mongocluster firewall rule create

Preview

Command group 'cosmosdb mongocluster firewall rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule create --cluster-name
                                              --end-ip-address
                                              --resource-group
                                              --rule-name
                                              --start-ip-address

Examples

Create a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule create \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--rule-name MyRule \
--start-ip-address MyStartIpAddress \
--end-ip-address MyEndIpAddress \

Required Parameters

--cluster-name -c

Name of the Cosmos DB Mongo Cluster.

--end-ip-address

End IP address of the firewall rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-name

Name of the firewall rule.

--start-ip-address

Start IP address of the firewall rule.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb mongocluster firewall rule delete

Preview

Command group 'cosmosdb mongocluster firewall rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule delete --cluster-name
                                              --resource-group
                                              --rule-name
                                              [--yes]

Examples

Delete a Mongo Cluster firewall rule. If the firewall rule does not exist a NoContent response is returned.

az cosmosdb mongocluster firewall rule delete --cluster-name MyCluster --resource-group MyResourceGroup --rule-name MyRuleName

Required Parameters

--cluster-name -c

Name of the Cosmos DB Mongo Cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-name

Name of the firewall rule.

Optional Parameters

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb mongocluster firewall rule list

Preview

Command group 'cosmosdb mongocluster firewall rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists firewall rule on a Mongo cluster.

az cosmosdb mongocluster firewall rule list --cluster-name
                                            --resource-group

Examples

Lists a Mongo cluster firewall rule in a resource group.

az cosmosdb mongocluster firewall rule list --cluster-name MyCluster --resource-group MyResourceGroup

Required Parameters

--cluster-name -c

Name of the Cosmos DB Mongo Cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb mongocluster firewall rule show

Preview

Command group 'cosmosdb mongocluster firewall rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule show --cluster-name
                                            --resource-group
                                            --rule-name

Examples

Gets a Mongo cluster firewall rule. If the firewall rule does not exist a NotFound response is returned.

az cosmosdb mongocluster firewall rule show --cluster-name MyCluster --resource-group MyResourceGroup --rule-name MyRuleName

Required Parameters

--cluster-name -c

Name of the Cosmos DB Mongo Cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-name

Name of the firewall rule.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb mongocluster firewall rule update

Preview

Command group 'cosmosdb mongocluster firewall rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule update --cluster-name
                                              --end-ip-address
                                              --resource-group
                                              --rule-name
                                              --start-ip-address

Examples

Update a Mongo cluster firewall rule.

az cosmosdb mongocluster firewall rule update \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--rule-name MyRule \
--start-ip-address MyStartIpAddress \
--end-ip-address MyEndIpAddress \

Required Parameters

--cluster-name -c

Name of the Cosmos DB Mongo Cluster.

--end-ip-address

End IP address of the firewall rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-name

Name of the firewall rule.

--start-ip-address

Start IP address of the firewall rule.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb mongocluster firewall rule

Commands

az cosmosdb mongocluster firewall rule create

Examples

Required Parameters

az cosmosdb mongocluster firewall rule delete

Examples

Required Parameters

Optional Parameters

az cosmosdb mongocluster firewall rule list

Examples

Required Parameters

az cosmosdb mongocluster firewall rule show

Examples

Required Parameters

az cosmosdb mongocluster firewall rule update

Examples

Required Parameters

Feedback

Additional resources