az cosmosdb postgres firewall-rule

  • Reference

Manage Azure Cosmos DB for PostgreSQL firewall rules.

Commands

Name Description Type Status
az cosmosdb postgres firewall-rule create

Create a new cluster firewall rule or updates an existing cluster firewall rule.

 Core GA
az cosmosdb postgres firewall-rule delete

Delete a cluster firewall rule.

 Core GA
az cosmosdb postgres firewall-rule list

List all the firewall rules on cluster.

 Core GA
az cosmosdb postgres firewall-rule show

Get information about a cluster firewall rule.

 Core GA
az cosmosdb postgres firewall-rule update

Update an existing cluster firewall rule.

 Core GA
az cosmosdb postgres firewall-rule wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az cosmosdb postgres firewall-rule create

Edit

Create a new cluster firewall rule or updates an existing cluster firewall rule.

az cosmosdb postgres firewall-rule create --cluster-name
                                          --end-ip-address
                                          --firewall-rule-name
                                          --resource-group
                                          --start-ip-address
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a firewall rule of the cluster

az cosmosdb postgres firewall-rule create -n "rule1" --start-ip-address "0.0.0.0" --end-ip-address "255.255.255.255" --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Required Parameters

--cluster-name

The name of the cluster.

--end-ip-address

The end IP address of the cluster firewall rule. Must be IPv4 format.

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

The name of the cluster firewall rule.

--resource-group -g

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

--start-ip-address

The start IP address of the cluster firewall rule. Must be IPv4 format.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 postgres firewall-rule delete

Edit

Delete a cluster firewall rule.

az cosmosdb postgres firewall-rule delete [--cluster-name]
                                          [--firewall-rule-name]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]

Examples

Delete the firewall rule of the cluster

az cosmosdb postgres firewall-rule delete -n "rule1" --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Optional Parameters

--cluster-name

The name of the cluster.

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

The name of the cluster firewall rule.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

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

Edit

List all the firewall rules on cluster.

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

Examples

List firewall rules of the cluster

az cosmosdb postgres firewall-rule list --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Required Parameters

--cluster-name

The name of the 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 postgres firewall-rule show

Edit

Get information about a cluster firewall rule.

az cosmosdb postgres firewall-rule show [--cluster-name]
                                        [--firewall-rule-name]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]

Examples

Show the firewall rule of the cluster

az cosmosdb postgres firewall-rule show -n "rule1" --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Optional Parameters

--cluster-name

The name of the cluster.

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

The name of the cluster firewall rule.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

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

--subscription

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

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

Edit

Update an existing cluster firewall rule.

az cosmosdb postgres firewall-rule update [--add]
                                          [--cluster-name]
                                          [--end-ip-address]
                                          [--firewall-rule-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]

Examples

Update start ip address of the firewall rule of the cluster

az cosmosdb postgres firewall-rule update -n "rule1" --start-ip-address "0.0.0.1" --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--cluster-name

The name of the cluster.

--end-ip-address

The end IP address of the cluster firewall rule. Must be IPv4 format.

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

The name of the cluster firewall rule.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--start-ip-address

The start IP address of the cluster firewall rule. Must be IPv4 format.

--subscription

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

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 postgres firewall-rule wait

Edit

Place the CLI in a waiting state until a condition is met.

az cosmosdb postgres firewall-rule wait [--cluster-name]
                                        [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--firewall-rule-name]
                                        [--ids]
                                        [--interval]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]

Optional Parameters

--cluster-name

The name of the cluster.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--firewall-rule-name --name -n

The name of the cluster firewall rule.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.