Share via

az monitor autoscale

  • Reference

Manage autoscale settings.

Commands

Name Description Type Status
az monitor autoscale create

Create new autoscale settings.

 Core GA
az monitor autoscale delete

Delete an autoscale setting.

 Core GA
az monitor autoscale list

Lists the autoscale settings for a resource group.

 Core GA
az monitor autoscale profile

Manage autoscaling profiles.

 Core GA
az monitor autoscale profile create

Create a fixed or recurring autoscale profile.

 Core GA
az monitor autoscale profile delete

Delete an autoscale profile.

 Core GA
az monitor autoscale profile list

List autoscale profiles.

 Core GA
az monitor autoscale profile list-timezones

Look up time zone information.

 Core GA
az monitor autoscale profile show

Show details of an autoscale profile.

 Core GA
az monitor autoscale rule

Manage autoscale scaling rules.

 Core GA
az monitor autoscale rule copy

Copy autoscale rules from one profile to another.

 Core GA
az monitor autoscale rule create

Add a new autoscale rule.

 Core GA
az monitor autoscale rule delete

Remove autoscale rules from a profile.

 Core GA
az monitor autoscale rule list

List autoscale rules for a profile.

 Core GA
az monitor autoscale show

Get an autoscale setting.

 Core GA
az monitor autoscale show-predictive-metric

Show predictive autoscale metric future data.

 Core GA
az monitor autoscale update

Update an autoscale setting.

 Core GA

az monitor autoscale create

Edit

Create new autoscale settings.

For more information on autoscaling, visit: https://docs.microsoft.com/azure/monitoring-and-diagnostics/monitoring-understanding-autoscale-settings.

az monitor autoscale create --count
                            --resource
                            [--action]
                            [--disabled {false, true}]
                            [--email-administrator {false, true}]
                            [--email-coadministrators {false, true}]
                            [--location]
                            [--max-count]
                            [--min-count]
                            [--name]
                            [--resource-group]
                            [--resource-namespace]
                            [--resource-parent]
                            [--resource-type]
                            [--scale-look-ahead-time]
                            [--scale-mode {Disabled, Enabled, ForecastOnly}]
                            [--tags]

Examples

Create autoscale settings to scale between 2 and 5 instances (3 as default). Email the administrator when scaling occurs.

az monitor autoscale create -g {myrg} --resource {resource-id} --min-count 2 --max-count 5 \
  --count 3 --email-administrator

az monitor autoscale rule create -g {myrg} --autoscale-name {resource-name} --scale out 1 \
  --condition "Percentage CPU > 75 avg 5m"

az monitor autoscale rule create -g {myrg} --autoscale-name {resource-name} --scale in 1 \
  --condition "Percentage CPU < 25 avg 5m"

Create autoscale settings for exactly 4 instances.

az monitor autoscale create -g {myrg} --resource {resource-id} --count 4

Create new autoscale settings. (autogenerated)

az monitor autoscale create --count 3 --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource myScaleSet --resource-group MyResourceGroup --resource-type Microsoft.Compute/virtualMachineScaleSets

Required Parameters

--count

The numer of instances to use. If used with --min/max-count, the default number of instances to use.

--resource

Name or ID of the target resource.

Optional Parameters

--action -a

Add an action to fire when a scaling event occurs.

Usage: --action TYPE KEY [ARG ...] Email: --action email [email protected] [email protected] Webhook: --action webhook https://www.contoso.com/alert apiKey=value Webhook: --action webhook https://www.contoso.com/alert?apiKey=value Multiple actions can be specified by using more than one --action argument.

--disabled

Create the autoscale settings in a disabled state.

Accepted values: false, true
--email-administrator

Send email to subscription administrator on scaling.

Accepted values: false, true
--email-coadministrators

Send email to subscription co-administrators on scaling.

Accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--max-count

The maximum number of instances.

--min-count

The minimum number of instances.

--name -n

Name of the autoscale settings.

--resource-group -g

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

--resource-namespace

Target resource provider namespace.

--resource-parent

Target resource parent path, if applicable.

--resource-type

Target resource type. Can also accept namespace/type format (Ex: 'Microsoft.Compute/virtualMachines').

--scale-look-ahead-time

The amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format (for example, 100 days would be P100D).

--scale-mode

The predictive autoscale mode.

Accepted values: Disabled, Enabled, ForecastOnly
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 monitor autoscale delete

Edit

Delete an autoscale setting.

az monitor autoscale delete [--autoscale-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

Optional Parameters

--autoscale-name --name -n

The autoscale setting name.

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

Edit

Lists the autoscale settings for a resource group.

az monitor autoscale list --resource-group
                          [--max-items]
                          [--next-token]

Required Parameters

--resource-group -g

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

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.

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

Edit

Get an autoscale setting.

az monitor autoscale show [--autoscale-name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

Examples

Show autoscale setting details.

az monitor autoscale show --name MyAutoscaleSettings --resource-group MyResourceGroup

Optional Parameters

--autoscale-name --name -n

The autoscale setting name.

--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 monitor autoscale show-predictive-metric

Edit

Show predictive autoscale metric future data.

az monitor autoscale show-predictive-metric --aggregation
                                            --interval
                                            --metric-name
                                            --metric-namespace
                                            --timespan
                                            [--autoscale-setting-name]
                                            [--ids]
                                            [--resource-group]
                                            [--subscription]

Required Parameters

--aggregation

The list of aggregation types (comma separated) to retrieve.

--interval

The interval (i.e. timegrain) of the query.

--metric-name

The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'.

--metric-namespace

Metric namespace to query metric definitions for.

--timespan

The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

Optional Parameters

--autoscale-setting-name

The autoscale setting name.

--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 monitor autoscale update

Edit

Update an autoscale setting.

For more information on autoscaling, visit: https://docs.microsoft.com/azure/monitoring-and-diagnostics/monitoring-understanding-autoscale-settings.

az monitor autoscale update [--add]
                            [--add-action]
                            [--autoscale-name]
                            [--count]
                            [--email-administrator {0, 1, f, false, n, no, t, true, y, yes}]
                            [--email-coadministrators {0, 1, f, false, n, no, t, true, y, yes}]
                            [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--max-count]
                            [--min-count]
                            [--remove]
                            [--remove-action]
                            [--resource-group]
                            [--scale-look-ahead-time]
                            [--scale-mode {Disabled, Enabled, ForecastOnly}]
                            [--set]
                            [--subscription]
                            [--tags]

Examples

Update autoscale settings to use a fixed 3 instances by default.

az monitor autoscale update -g myrg -n autoscale-name --count 3

Update autoscale settings to remove an email notification.

az monitor autoscale update -g myrg -n autoscale-name --remove-action email [email protected]

Update autoscale settings.

az monitor autoscale update --count 3 --email-administrator true --enabled true --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource-group MyResourceGroup --tags key[=value]

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

--add-action --add-actions -a

Add an action to fire when a scaling event occurs. Usage: --add-action TYPE KEY [ARG ...] Email: --add-action email [email protected] [email protected] Webhook: --add-action webhook https://www.contoso.com/alert apiKey=value Webhook: --add-action webhook https://www.contoso.com/alert?apiKey=value Multiple actions can be specified by using more than one --add-action argument. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--autoscale-name --name -n

The autoscale setting name.

--count

The numer of instances to use. If used with --min/max-count, the default number of instances to use.

--email-administrator

Send email to subscription administrator on scaling.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--email-coadministrators

Send email to subscription co-administrators on scaling.

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

The enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is '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.

--max-count

The maximum number of instances.

--min-count

The minimum number of instances.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--remove-action --remove-actions -r

Remove one or more actions. Usage: --remove-action TYPE KEY [KEY ...] Email: --remove-action email [email protected] [email protected] Webhook: --remove-action webhook https://contoso.com/alert https://alerts.contoso.com. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

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

--scale-look-ahead-time

The amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format (for example, 100 days would be P100D).

--scale-mode

The predictive autoscale mode.

Accepted values: Disabled, Enabled, ForecastOnly
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--tags

Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. 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.