az hdinsight-on-aks clusterpool
Note
This reference is part of the hdinsightonaks extension for the Azure CLI (version 2.56.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 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
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]
[--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
The name of the cluster pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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 version is a 2-part version.
True if log analytics is enabled for cluster pool, otherwise false.
Log analytics workspace to associate with the OMS agent.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
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.
Do not wait for the long-running operation to finish.
This can only be set at cluster pool creation time and cannot be changed later.
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.
Cluster pool subnet resource id.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The virtual machine SKU.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az hdinsight-on-aks clusterpool delete
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
The name of the cluster pool.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az hdinsight-on-aks clusterpool list
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 listOptional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az hdinsight-on-aks clusterpool show
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
Gets a cluster pool.
az hdinsight-on-aks clusterpool show -g {RG} -n {poolName}Optional Parameters
The name of the cluster pool.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az hdinsight-on-aks clusterpool update
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 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>.
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.
The name of the cluster pool.
Cluster pool version is a 2-part version.
CLuster pool compute profile. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
True if log analytics is enabled for cluster pool, otherwise false.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Log analytics workspace to associate with the OMS agent.
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.
Do not wait for the long-running operation to finish.
This can only be set at cluster pool creation time and cannot be changed later.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Cluster pool subnet resource id.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az hdinsight-on-aks clusterpool wait
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
The name of the cluster pool.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for