az monitor autoscale

  • Reference

Manage autoscale settings.

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

Commands

az monitor autoscale create

Create new autoscale settings.
az monitor autoscale delete

Deletes and autoscale setting.
az monitor autoscale list

Lists the autoscale settings for a resource group.
az monitor autoscale profile

Manage autoscaling profiles.
az monitor autoscale profile create

Create a fixed or recurring autoscale profile.
az monitor autoscale profile delete

Delete an autoscale profile.
az monitor autoscale profile list

List autoscale profiles.
az monitor autoscale profile list-timezones

Look up time zone information.
az monitor autoscale profile show

Show details of an autoscale profile.
az monitor autoscale rule

Manage autoscale scaling rules.
az monitor autoscale rule copy

Copy autoscale rules from one profile to another.
az monitor autoscale rule create

Add a new autoscale rule.
az monitor autoscale rule delete

Remove autoscale rules from a profile.
az monitor autoscale rule list

List autoscale rules for a profile.
az monitor autoscale show

Show autoscale setting details.
az monitor autoscale update

Update autoscale settings.

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]
                            [--subscription]
                            [--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.

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

--subscription

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

--tags

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

az monitor autoscale delete

Edit

Deletes and autoscale setting.

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

Optional Parameters

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

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

--subscription

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

az monitor autoscale list

Edit

Lists the autoscale settings for a resource group.

az monitor autoscale list --resource-group
                          [--query-examples]
                          [--subscription]

Required Parameters

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az monitor autoscale show

Edit

Show autoscale setting details.

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

Examples

Show autoscale setting details. (autogenerated)

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

Optional Parameters

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

--name -n

Name of the autoscale settings.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az monitor autoscale update

Edit

Update autoscale settings.

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]
                            [--count]
                            [--email-administrator {false, true}]
                            [--email-coadministrators {false, true}]
                            [--enabled {false, true}]
                            [--force-string]
                            [--ids]
                            [--max-count]
                            [--min-count]
                            [--name]
                            [--remove]
                            [--remove-action]
                            [--resource-group]
                            [--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 bob@contoso.com

Update autoscale settings. (autogenerated)

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

Add an action to fire when a scaling event occurs.

--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: false, true
--email-coadministrators

Send email to subscription co-administrators on scaling.

accepted values: false, true
--enabled

Autoscale settings enabled status.

accepted values: false, true
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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

--name -n

Name of the autoscale settings.

--remove

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

--remove-action -r

Remove one or more actions.

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

--subscription

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

--tags

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