Share via

az hdinsight autoscale

Manage HDInsight cluster's Autoscale configuration.

Commands

Name Description Type Status
az hdinsight autoscale condition

Manage schedule condition of the HDInsight cluster which enabled Schedule-based Autoscale.

 Core GA
az hdinsight autoscale condition create

Add a new schedule condition.

 Core GA
az hdinsight autoscale condition delete

Delete schedule condition.

 Core GA
az hdinsight autoscale condition list

List all schedule conditions.

 Core GA
az hdinsight autoscale condition update

Update a schedule condition.

 Core GA
az hdinsight autoscale condition wait

Place the CLI in a waiting state until an operation is complete.

 Core GA
az hdinsight autoscale create

Enable Autoscale for a running cluster.

 Core GA
az hdinsight autoscale delete

Disable Autoscale for a running cluster.

 Core GA
az hdinsight autoscale list-timezones

List the available timezone name when enabling Schedule-based Autoscale.

 Core GA
az hdinsight autoscale show

Get the Autoscale configuration of a specified cluster.

 Core GA
az hdinsight autoscale update

Update the Autoscale configuration.

 Core GA
az hdinsight autoscale wait

Place the CLI in a waiting state until an operation is complete.

 Core GA

az hdinsight autoscale create

Edit

Enable Autoscale for a running cluster.

az hdinsight autoscale create --cluster-name
                              --resource-group
                              --type {Load, Schedule}
                              [--days {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                              [--max-workernode-count]
                              [--min-workernode-count]
                              [--no-wait]
                              [--time]
                              [--timezone]
                              [--workernode-count]
                              [--yes]

Examples

Enable Load-based Autoscale for a running cluster.

az hdinsight autoscale create --resource-group MyResourceGroup --cluster-name MyCluster --type Load \
--min-workernode-count 3 --max-workernode-count 5

Enable Schedule-based Autoscale for a running cluster.

az hdinsight autoscale create --resource-group MyResourceGroup --cluster-name MyCluster --type Schedule \
--timezone "Pacific Standard Time" --days Monday Tuesday --time 09:00 --workernode-count 5

Required Parameters

--cluster-name

The name of the cluster.

--resource-group -g

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

--type

The autoscale type.

Property Value
Accepted values: Load, Schedule

Optional Parameters

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

--days

A space-delimited list of schedule day.

Property Value
Parameter group: Schedule-based Autoscale Arguments
Accepted values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday
--max-workernode-count

The max workernode count for Load-based atuoscale.

Property Value
Parameter group: Load-based Autoscale Arguments
--min-workernode-count

The minimal workernode count for Load-based atuoscale.

Property Value
Parameter group: Load-based Autoscale Arguments
--no-wait

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

Property Value
Default value: False
--time

The 24-hour time in the form xx:xx in days.

Property Value
Parameter group: Schedule-based Autoscale Arguments
--timezone

The timezone for schedule autoscale type. Values from az hdinsight autoscale list-timezones.

Property Value
Parameter group: Schedule-based Autoscale Arguments
--workernode-count

The schedule workernode count.

Property Value
Parameter group: Schedule-based Autoscale 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 hdinsight autoscale delete

Edit

Disable Autoscale for a running cluster.

az hdinsight autoscale delete --cluster-name
                              --resource-group
                              [--no-wait]
                              [--yes]

Examples

Disable Autoscale for a running cluster.

az hdinsight autoscale delete --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name

The name of the 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.

--no-wait

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

Property Value
Default value: False
--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 hdinsight autoscale list-timezones

Edit

List the available timezone name when enabling Schedule-based Autoscale.

az hdinsight autoscale list-timezones

Examples

List the available timezone name.

az hdinsight autoscale list-timezones
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 hdinsight autoscale show

Edit

Get the Autoscale configuration of a specified cluster.

az hdinsight autoscale show --cluster-name
                            --resource-group

Examples

Get the Autoscale configuration.

az hdinsight autoscale show --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name

The name of the 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 hdinsight autoscale update

Edit

Update the Autoscale configuration.

az hdinsight autoscale update --cluster-name
                              --resource-group
                              [--max-workernode-count]
                              [--min-workernode-count]
                              [--no-wait]
                              [--timezone]

Examples

Update Load-based Autoscale related configuration.

az hdinsight autoscale update --resource-group MyResourceGroup --cluster-name MyCluster --max-workernode-count 5

Update Schedule-based Autoscale related configuration.

az hdinsight autoscale update --resource-group MyResourceGroup --cluster-name MyCluster --timezone "China Standard Time"

Required Parameters

--cluster-name

The name of the 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-workernode-count

The max workernode count for Load-based atuoscale.

Property Value
Parameter group: Load-based Autoscale Arguments
--min-workernode-count

The minimal workernode count for Load-based atuoscale.

Property Value
Parameter group: Load-based Autoscale Arguments
--no-wait

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

Property Value
Default value: False
--timezone

The timezone for schedule autoscale type. Values from az hdinsight autoscale list-timezones.

Property Value
Parameter group: Schedule-based Autoscale 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 hdinsight autoscale wait

Edit

Place the CLI in a waiting state until an operation is complete.

az hdinsight autoscale wait --name
                            --resource-group
                            [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--interval]
                            [--timeout]
                            [--updated]

Required Parameters

--name -n

The name of the 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.

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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.

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