Share via

az hdinsight-on-aks clusterpool

  • Preview
  • Reference

Note

This reference is part of the hdinsightonaks extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az hdinsight-on-aks clusterpool command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Clusterpool operations.

Commands

Name Description Type Status
az hdinsight-on-aks clusterpool create

Create a cluster pool.

 Extension Preview
az hdinsight-on-aks clusterpool delete

Delete a Cluster Pool.

 Extension Preview
az hdinsight-on-aks clusterpool list

List the list of Cluster Pools within a Subscription.

 Extension Preview
az hdinsight-on-aks clusterpool show

Get a cluster pool.

 Extension Preview
az hdinsight-on-aks clusterpool update

Update a cluster pool.

 Extension Preview
az hdinsight-on-aks clusterpool upgrade

Upgrade clusterpool.

 Extension Preview
az hdinsight-on-aks clusterpool upgrade history

List a list of upgrade history.

 Extension Preview
az hdinsight-on-aks clusterpool upgrade list

List a cluster pool available upgrade.

 Extension Preview
az hdinsight-on-aks clusterpool upgrade run

Upgrade a cluster pool.

 Extension Preview
az hdinsight-on-aks clusterpool wait

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

 Extension Preview

az hdinsight-on-aks clusterpool create

Preview

Command group 'az hdinsight-on-aks clusterpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a cluster pool.

az hdinsight-on-aks clusterpool create --cluster-pool-name
                                       --resource-group
                                       [--api-server-authorized-ip-ranges]
                                       [--availability-zones]
                                       [--cluster-pool-version]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--la-workspace-id]
                                       [--location]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--private-server-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--subnet-id]
                                       [--tags]
                                       [--workernode-size]

Examples

Create a cluster pool.

az hdinsight-on-aks clusterpool create -g {RG} -n {poolName} -l {westus3} --workernode-size {Standard_E4s_v3} --version {1.1}

Required Parameters

--cluster-pool-name --name -n

The name of the cluster pool.

--resource-group -g

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

Optional Parameters

--api-server-authorized-ip-ranges --api-server-ip-ranges

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--availability-zones

The list of Availability zones to use for AKS VMSS nodes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cluster-pool-version --version

Cluster pool version is a 2-part version.

--enable-log-analytics

True if log analytics is enabled for cluster pool, otherwise false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--la-workspace-id --log-analytic-workspace-id

Log analytics workspace to associate with the OMS agent.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--managed-rg-name

A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}{clusterPoolName}{region}. Please make sure it meets resource group name restriction.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--outbound-type

This can only be set at cluster pool creation time and cannot be changed later.

Accepted values: loadBalancer, userDefinedRouting
Default value: loadBalancer
--private-server-enabled

ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--subnet-id

Cluster pool subnet resource id.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--workernode-size

The virtual machine SKU.

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 hdinsight-on-aks clusterpool delete

Preview

Command group 'az hdinsight-on-aks clusterpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Cluster Pool.

az hdinsight-on-aks clusterpool delete [--cluster-pool-name]
                                       [--ids]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Examples

Deletes a Cluster Pool.

az hdinsight-on-aks clusterpool delete -g {RG} -n {poolName}

Optional Parameters

--cluster-pool-name --name -n

The name of the cluster pool.

--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 hdinsight-on-aks clusterpool list

Preview

Command group 'az hdinsight-on-aks clusterpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the list of Cluster Pools within a Subscription.

az hdinsight-on-aks clusterpool list [--max-items]
                                     [--next-token]
                                     [--resource-group]

Examples

Lists the list of clusterpool in a resource group.

az hdinsight-on-aks clusterpool list -g {RG}

List the list of Cluster Pools within a Subscription.

az hdinsightonaks clusterpool list

Optional Parameters

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

--next-token

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

--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 hdinsight-on-aks clusterpool show

Preview

Command group 'az hdinsight-on-aks clusterpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a cluster pool.

az hdinsight-on-aks clusterpool show [--cluster-pool-name]
                                     [--ids]
                                     [--resource-group]
                                     [--subscription]

Examples

Get the clusterpool.

az hdinsight-on-aks clusterpool show -g {RG} -n {poolName}

Optional Parameters

--cluster-pool-name --name -n

The name of the cluster pool.

--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 hdinsight-on-aks clusterpool update

Preview

Command group 'az hdinsight-on-aks clusterpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a cluster pool.

az hdinsight-on-aks clusterpool update [--add]
                                       [--api-server-authorized-ip-ranges]
                                       [--cluster-pool-name]
                                       [--cluster-pool-version]
                                       [--compute-profile]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--la-workspace-id]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subnet-id]
                                       [--subscription]
                                       [--tags]

Examples

Updates an existing Cluster enable log analytic.

az hdinsight-on-aksclusterpool update -g {RG} -n {poolName} --enable-log-analytics --log-analytic-workspace-id {"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/microsoft.operationalinsights/workspaces/yourworkspace"}

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

--api-server-authorized-ip-ranges --api-server-ip-ranges

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cluster-pool-name --name -n

The name of the cluster pool.

--cluster-pool-version --version

Cluster pool version is a 2-part version.

--compute-profile

CLuster pool compute profile. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--enable-log-analytics

True if log analytics is enabled for cluster pool, otherwise false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--la-workspace-id --log-analytic-workspace-id

Log analytics workspace to associate with the OMS agent.

--managed-rg-name

A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}{clusterPoolName}{region}. Please make sure it meets resource group name restriction.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--outbound-type

This can only be set at cluster pool creation time and cannot be changed later.

Accepted values: loadBalancer, userDefinedRouting
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--subnet-id

Cluster pool subnet resource id.

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 hdinsight-on-aks clusterpool wait

Preview

Command group 'az hdinsight-on-aks clusterpool' 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 hdinsight-on-aks clusterpool wait [--cluster-pool-name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

Optional Parameters

--cluster-pool-name --name -n

The name of the cluster pool.

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