az horizondb cluster pool

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 command. Learn more about extensions.

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

Manage HorizonDB Pool.

Commands

Name Description Type Status
az horizondb cluster pool create

Create a new HorizonDB pool.

Extension Preview
az horizondb cluster pool delete

Delete a HorizonDB pool.

Extension Preview
az horizondb cluster pool firewall-rule

Manage Firewall Rule.

Extension Preview
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 list

List all HorizonDB pools in a cluster.

Extension Preview
az horizondb cluster pool show

Get information about a HorizonDB pool.

Extension Preview
az horizondb cluster pool update

Update an existing HorizonDB pool.

Extension Preview
az horizondb cluster pool wait

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

Extension Preview

az horizondb cluster pool create

Preview

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

Create a new HorizonDB pool.

az horizondb cluster pool create --cluster-name
                                 --name --pool-name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--compute-generation]
                                 [--compute-processor {AMD, Intel}]
                                 [--high-availability-mode {AnyZone, Disabled, ZoneRedundant}]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--node-count]
                                 [--v-cores]

Examples

Create a minimum provisioned HorizonDB pool using the default parameter group

az horizondb cluster pool create --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --compute-processor AMD --compute-generation 3 --v-cores 2 --node-count 1 --high-availability-mode Disabled

Required Parameters

--cluster-name

The name of the HorizonDB cluster.

--name --pool-name -n

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

The compute generation for the compute model.

Property Value
Parameter group: ComputeModel Arguments
--compute-processor

The processor type for the compute model.

Property Value
Parameter group: ComputeModel Arguments
Accepted values: AMD, Intel
--high-availability-mode

The high-availability mode. Disabled is required when nodeCount is 1. AnyZone or ZoneRedundant is required when nodeCount is 2 through 16.

Property Value
Parameter group: HighAvailability Arguments
Accepted values: AnyZone, Disabled, ZoneRedundant
--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
--node-count

The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool.

Property Value
Parameter group: Properties Arguments
--v-cores

The number of vCores. Allowed values are 1 through 192.

Property Value
Parameter group: ComputeModel 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 delete

Preview

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

Delete a HorizonDB pool.

az horizondb cluster pool delete [--acquire-policy-token]
                                 [--change-reference]
                                 [--cluster-name]
                                 [--ids]
                                 [--name --pool-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Examples

Delete the last HorizonDB pool and disconnect private endpoint connections

az horizondb cluster pool delete --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-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
--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
--name --pool-name -n

The name of the HorizonDB pool.

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

Preview

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

List all HorizonDB pools in a cluster.

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

Examples

List HorizonDB pools in a cluster

az horizondb cluster pool list --resource-group example-resource-group --cluster-name example-cluster

Required Parameters

--cluster-name

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

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

Preview

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

Get information about a HorizonDB pool.

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

Examples

Get a HorizonDB pool

az horizondb cluster pool show --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-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
--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
--name --pool-name -n

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 update

Preview

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

Update an existing HorizonDB pool.

az horizondb cluster pool update [--acquire-policy-token]
                                 [--change-reference]
                                 [--cluster-name]
                                 [--compute-generation]
                                 [--compute-processor {AMD, Intel}]
                                 [--high-availability-mode {AnyZone, Disabled, ZoneRedundant}]
                                 [--ids]
                                 [--name --pool-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--node-count]
                                 [--param-group-apply --parameter-group-apply-method {Immediate, PendingReboot}]
                                 [--param-group-id --parameter-group-resource-id]
                                 [--resource-group]
                                 [--subscription]
                                 [--v-cores]

Examples

Update node count.

az horizondb cluster pool update --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --node-count 2

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

The compute generation for the compute model. Omission preserves the current compute generation.

Property Value
Parameter group: ComputeModel Arguments
--compute-processor

The processor type for the compute model. Omission preserves the current processor type.

Property Value
Parameter group: ComputeModel Arguments
Accepted values: AMD, Intel
--high-availability-mode

The high-availability mode. Omission preserves the current mode before the service validates it with the effective nodeCount.

Property Value
Parameter group: HighAvailability Arguments
Accepted values: AnyZone, Disabled, ZoneRedundant
--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
--name --pool-name -n

The name of the HorizonDB pool.

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

The number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. Omission preserves the current configured value. To deallocate runtime compute without changing the configured node count, stop the pool.

Property Value
Parameter group: Properties Arguments
--param-group-apply --parameter-group-apply-method

Determines when dynamic parameter changes from the associated parameter group become effective. Static parameter changes always require a customer-initiated pool Restart, regardless of this value. Stop followed by Start and scheduled maintenance do not apply pending parameter changes.

Property Value
Parameter group: ParameterGroup Arguments
Accepted values: Immediate, PendingReboot
--param-group-id --parameter-group-resource-id

The Azure resource ID of the corresponding default or customer-created parameter group to associate with the existing pool.

Property Value
Parameter group: ParameterGroup 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
--v-cores

The number of provisioned vCores. Allowed values are 1 through 192. This property applies only to a Provisioned compute model. Omission preserves the current value.

Property Value
Parameter group: ComputeModel 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 wait

Preview

Command group 'az horizondb cluster pool' 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 wait [--acquire-policy-token]
                               [--change-reference]
                               [--cluster-name]
                               [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name --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
--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
--name --pool-name -n

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