az horizondb cluster pool firewall-rule

Note

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

Command group 'az horizondb cluster pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Firewall Rule.

Commands

Name Description Type Status
az horizondb cluster pool firewall-rule create

Create a HorizonDB pool firewall rule.

Extension Preview
az horizondb cluster pool firewall-rule delete

Delete a HorizonDB pool firewall rule.

Extension Preview
az horizondb cluster pool firewall-rule list

List all HorizonDB firewall rules in a pool.

Extension Preview
az horizondb cluster pool firewall-rule show

Get information about a HorizonDB pool firewall rule.

Extension Preview
az horizondb cluster pool firewall-rule update

Update a HorizonDB pool firewall rule.

Extension Preview
az horizondb cluster pool firewall-rule wait

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

Extension Preview

az horizondb cluster pool firewall-rule create

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a HorizonDB pool firewall rule.

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

Examples

Create or replace a firewall rule on a HorizonDB pool

az horizondb cluster pool firewall-rule create --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --firewall-rule-name example-firewall-rule-01 --start-ip-address 10.0.0.1 --end-ip-address 10.0.0.254 --description Allow access from the corporate network

Required Parameters

--cluster-name

The name of the HorizonDB cluster.

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

The name of the HorizonDB pool firewall rule. The name must be 1 through 80 characters, contain only ASCII letters, digits, underscores, periods, and hyphens, start with a letter or digit, and end with a letter, digit, or underscore.

--pool-name

The name of the HorizonDB pool.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

The description of the HorizonDB firewall rule. The maximum length is 1024 characters.

Property Value
Parameter group: Properties Arguments
--end-ip-address

The end IPv4 address of the firewall rule in dotted-decimal notation. This address must be numerically greater than or equal to startIpAddress.

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--start-ip-address

The start IPv4 address of the firewall rule in dotted-decimal notation.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az horizondb cluster pool firewall-rule delete

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a HorizonDB pool firewall rule.

az horizondb cluster pool 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}]
                                               [--pool-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--yes]

Examples

Delete a firewall rule from a HorizonDB pool

az horizondb cluster pool firewall-rule delete --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --firewall-rule-name example-firewall-rule-01

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--firewall-rule-name --name -n

The name of the HorizonDB pool firewall rule. The name must be 1 through 80 characters, contain only ASCII letters, digits, underscores, periods, and hyphens, start with a letter or digit, and end with a letter, digit, or underscore.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name

The name of the HorizonDB pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az horizondb cluster pool firewall-rule list

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all HorizonDB firewall rules in a pool.

az horizondb cluster pool firewall-rule list --cluster-name
                                             --pool-name
                                             --resource-group
                                             [--max-items]
                                             [--next-token]

Required Parameters

--cluster-name

The name of the HorizonDB cluster.

--pool-name

The name of the HorizonDB pool.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az horizondb cluster pool firewall-rule show

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get information about a HorizonDB pool firewall rule.

az horizondb cluster pool firewall-rule show [--cluster-name]
                                             [--firewall-rule-name --name]
                                             [--ids]
                                             [--pool-name]
                                             [--resource-group]
                                             [--subscription]

Examples

Get a firewall rule on a HorizonDB pool

az horizondb cluster pool firewall-rule show --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --firewall-rule-name example-firewall-rule-01

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--firewall-rule-name --name -n

The name of the HorizonDB pool firewall rule. The name must be 1 through 80 characters, contain only ASCII letters, digits, underscores, periods, and hyphens, start with a letter or digit, and end with a letter, digit, or underscore.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--pool-name

The name of the HorizonDB pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az horizondb cluster pool firewall-rule update

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a HorizonDB pool firewall rule.

az horizondb cluster pool firewall-rule update [--acquire-policy-token]
                                               [--add]
                                               [--change-reference]
                                               [--cluster-name]
                                               [--description]
                                               [--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}]
                                               [--pool-name]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--start-ip-address]
                                               [--subscription]

Examples

Update a firewall rule on a HorizonDB pool

az horizon-db cluster pool firewall-rule update --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --firewall-rule-name example-firewall-rule-01 --start-ip-address 10.0.0.1 --end-ip-address 10.0.0.254 --description Allow access from the corporate network

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--description

The description of the HorizonDB firewall rule. The maximum length is 1024 characters.

Property Value
Parameter group: Properties Arguments
--end-ip-address

The end IPv4 address of the firewall rule in dotted-decimal notation. This address must be numerically greater than or equal to startIpAddress.

Property Value
Parameter group: Properties Arguments
--firewall-rule-name --name -n

The name of the HorizonDB pool firewall rule. The name must be 1 through 80 characters, contain only ASCII letters, digits, underscores, periods, and hyphens, start with a letter or digit, and end with a letter, digit, or underscore.

Property Value
Parameter group: Resource Id Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name

The name of the HorizonDB pool.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--start-ip-address

The start IPv4 address of the firewall rule in dotted-decimal notation.

Property Value
Parameter group: Properties Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az horizondb cluster pool firewall-rule wait

Preview

Command group 'az horizondb cluster pool firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az horizondb cluster pool firewall-rule wait [--acquire-policy-token]
                                             [--change-reference]
                                             [--cluster-name]
                                             [--created]
                                             [--custom]
                                             [--deleted]
                                             [--exists]
                                             [--firewall-rule-name --name]
                                             [--ids]
                                             [--interval]
                                             [--pool-name]
                                             [--resource-group]
                                             [--subscription]
                                             [--timeout]
                                             [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--firewall-rule-name --name -n

The name of the HorizonDB pool firewall rule. The name must be 1 through 80 characters, contain only ASCII letters, digits, underscores, periods, and hyphens, start with a letter or digit, and end with a letter, digit, or underscore.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--pool-name

The name of the HorizonDB pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False