az horizondb 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 firewall-rule command. Learn more about extensions.

Manage firewall rules for an Azure HorizonDB cluster.

Firewall rules control public access to a HorizonDB cluster and are applied to the cluster's default pool. Use these commands to allow inbound connections from specific IP addresses or ranges.

Commands

Name	Description	Type	Status
az horizondb firewall-rule create	Create a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule delete	Delete a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule list	List the firewall rules for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule show	Show the details of a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule update	Update a firewall rule for an Azure HorizonDB cluster.	Extension	GA

az horizondb firewall-rule create

Create a firewall rule for an Azure HorizonDB cluster.

az horizondb firewall-rule create --cluster-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--description]
                                  [--end-ip-address]
                                  [--name]
                                  [--start-ip-address]

Examples

Create a firewall rule allowing a single IP address.

az horizondb firewall-rule create --resource-group exampleresourcegroup --cluster-name examplecluster --name allowclientip --start-ip-address 12.12.12.12

Create a firewall rule allowing a range of IP addresses.

az horizondb firewall-rule create --resource-group exampleresourcegroup --cluster-name examplecluster --name allowrange --start-ip-address 12.12.12.0 --end-ip-address 12.12.12.255

Create a firewall rule allowing access from all Azure-internal IP addresses.

az horizondb firewall-rule create --resource-group exampleresourcegroup --cluster-name examplecluster --name allowazure --start-ip-address 0.0.0.0 --end-ip-address 0.0.0.0

Required Parameters

--cluster-name -c

Name of the HorizonDB cluster.

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

--end-ip-address

The end IP address of the firewall rule (IPv4). Must be dotted-quad format. Use 0.0.0.0 to represent all Azure-internal IP addresses.

--name -n

The name of the firewall rule.

--start-ip-address

The start IP address of the firewall rule (IPv4). Must be dotted-quad format. Use 0.0.0.0 to represent all Azure-internal IP addresses.

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

Delete a firewall rule for an Azure HorizonDB cluster.

az horizondb firewall-rule delete --cluster-name
                                  --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--yes]

Examples

Delete a firewall rule.

az horizondb firewall-rule delete --resource-group exampleresourcegroup --cluster-name examplecluster --name allowclientip

Required Parameters

--cluster-name -c

Name of the HorizonDB cluster.

--name -n

The name of the firewall rule.

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

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

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

List the firewall rules for an Azure HorizonDB cluster.

az horizondb firewall-rule list --cluster-name
                                --resource-group

Examples

List all firewall rules for a cluster.

az horizondb firewall-rule list --resource-group exampleresourcegroup --cluster-name examplecluster

Required Parameters

--cluster-name -c

Name of the HorizonDB 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.

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

Show the details of a firewall rule for an Azure HorizonDB cluster.

az horizondb firewall-rule show --cluster-name
                                --name
                                --resource-group

Examples

Show a firewall rule.

az horizondb firewall-rule show --resource-group exampleresourcegroup --cluster-name examplecluster --name allowclientip

Required Parameters

--cluster-name -c

Name of the HorizonDB cluster.

--name -n

The name of the firewall rule.

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

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

Update a firewall rule for an Azure HorizonDB cluster.

az horizondb firewall-rule update --cluster-name
                                  --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--description]
                                  [--end-ip-address]
                                  [--start-ip-address]

Examples

Update the IP range of an existing firewall rule.

az horizondb firewall-rule update --resource-group exampleresourcegroup --cluster-name examplecluster --name allowrange --start-ip-address 12.12.12.0 --end-ip-address 12.12.12.128

Required Parameters

--cluster-name -c

Name of the HorizonDB cluster.

--name -n

The name of the firewall rule.

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

--end-ip-address

The end IP address of the firewall rule (IPv4). Must be dotted-quad format. Use 0.0.0.0 to represent all Azure-internal IP addresses.

--start-ip-address

The start IP address of the firewall rule (IPv4). Must be dotted-quad format. Use 0.0.0.0 to represent all Azure-internal IP addresses.

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

Feedback

Was this page helpful?