Share via

az monitor autoscale profile

Manage autoscaling profiles.

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

Commands

Name Description Type Status
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 profile create

Edit

Create a fixed or recurring autoscale profile.

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

az monitor autoscale profile create --autoscale-name
                                    --count
                                    --name
                                    --resource-group
                                    --timezone
                                    [--copy-rules]
                                    [--end]
                                    [--max-count]
                                    [--min-count]
                                    [--recurrence]
                                    [--start]

Examples

Create a fixed date profile, inheriting the default scaling rules but changing the capacity.

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

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

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

az monitor autoscale profile create -g {myrg} --autoscale-name {name} -n Christmas \
  --copy-rules default --min-count 3 --count 6 --max-count 10 --start 2018-12-24 \
  --end 2018-12-26 --timezone "Pacific Standard Time"

Create a recurring weekend profile, inheriting the default scaling rules but changing the capacity.

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

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

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

az monitor autoscale profile create -g {myrg} --autoscale-name {name} -n weeekend \
  --copy-rules default --min-count 1 --count 2 --max-count 2 \
  --recurrence week sat sun --timezone "Pacific Standard Time"

Create a fixed or recurring autoscale profile. (autogenerated)

az monitor autoscale profile create --autoscale-name MyAutoscale --copy-rules default --count 2 --end 2018-12-26 --max-count 10 --min-count 1 --name Christmas --recurrence week sat sun --resource-group MyResourceGroup --start 2018-12-24 --timezone "Pacific Standard Time"

Create a fixed or recurring autoscale profile. (autogenerated)

az monitor autoscale profile create --autoscale-name MyAutoscale --count 2 --max-count 10 --min-count 1 --name Christmas --recurrence week sat sun --resource-group MyResourceGroup --start 2018-12-24 --subscription MySubscription --timezone "Pacific Standard Time"

Required Parameters

--autoscale-name

Name of the autoscale settings.

--count

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

Property Value
Parameter group: Instance Limit Arguments
--name -n

Name of the autoscale profile.

--resource-group -g

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

--timezone

Timezone name.

Property Value
Parameter group: Schedule Arguments
Value from: az monitor autoscale profile list-timezones

Optional Parameters

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

--copy-rules

Name of an existing schedule from which to copy the scaling rules for the new schedule.

--end

When the autoscale profile ends. Format depends on the type of profile.

Fixed: --end yyyy-mm-dd [hh:mm:ss] Weekly: [--end hh:mm].

Property Value
Parameter group: Schedule Arguments
--max-count

The maximum number of instances.

Property Value
Parameter group: Instance Limit Arguments
--min-count

The minimum number of instances.

Property Value
Parameter group: Instance Limit Arguments
--recurrence -r

When the profile recurs. If omitted, a fixed (non-recurring) profile is created.

Usage: --recurrence {week} [ARG ARG ...] Weekly: --recurrence week Sat Sun.

Property Value
Parameter group: Schedule Arguments
--start

When the autoscale profile begins. Format depends on the type of profile.

Fixed: --start yyyy-mm-dd [hh:mm:ss] Weekly: [--start hh:mm].

Property Value
Parameter group: Schedule 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 monitor autoscale profile delete

Edit

Delete an autoscale profile.

az monitor autoscale profile delete --autoscale-name
                                    --name
                                    --resource-group

Examples

Delete an autoscale profile. (autogenerated)

az monitor autoscale profile delete --autoscale-name MyAutoscale --name MyAutoscaleProfile --resource-group MyResourceGroup

Required Parameters

--autoscale-name

Name of the autoscale settings.

--name -n

Name of the autoscale profile.

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

Edit

List autoscale profiles.

az monitor autoscale profile list --autoscale-name
                                  --resource-group

Examples

List autoscale profiles. (autogenerated)

az monitor autoscale profile list --autoscale-name MyAutoscale --resource-group MyResourceGroup

Required Parameters

--autoscale-name

Name of the autoscale settings.

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

Edit

Look up time zone information.

az monitor autoscale profile list-timezones [--offset]
                                            [--search-query]

Optional Parameters

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

--offset

Filter results based on UTC hour offset.

--search-query -q

Query text to find.

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

Edit

Show details of an autoscale profile.

az monitor autoscale profile show --autoscale-name
                                  --name
                                  --resource-group

Required Parameters

--autoscale-name

Name of the autoscale settings.

--name -n

Name of the autoscale profile.

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