Get information about an autoscale setting in Azure Monitor REST API

 

Updated: September 26, 2016

See Common headers and parameters for headers and parameters that are used by all requests related to autoscale settings.

Method

Request URI

GET

https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/microsoft.insights/autoscaleSettings/{autoscale-setting-name}?api-version={api-version}

Replace {autoscale-setting-name} with the name of the setting for which you want to get information.

Status code: 200; otherwise a 404.

{

  "id": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/norapp/providers/Microsoft.insights/autoscalesettings/webfrontend-norapp-norapp",
  "name": "webfrontend-norapp-norapp",
  "type": "Microsoft.Insights/autoscaleSettings",
  "location": "East US",
  "tags": { },
  "properties": {
    "profiles": [ {
      "name": "Day",
      "capacity": {
        "minimum": "1",
        "maximum": "5",
        "default": "4"
      },
      "rules": [ {
        "metricTrigger": {
          "metricName": "Percentage CPU",
          "metricNamespace": "",
          "metricResourceUri": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/norapp/providers/icrosoft.classicCompute/domainNames/norapp/availabilitySets/webfrontend",
          "timeGrain": "PT5M",
          "statistic": "Average",
          "timeWindow": "PT45M",
          "timeAggregation": "Average",
          "operator": "GreaterThanOrEqual",
          "threshold": 60
        },
        "scaleAction": {
          "direction": "Increase",
          "type": "ChangeCount",
          "value": "2",
          "cooldown": "PT20M"
        }
      } ],
      "recurrence": {
        "frequency": "Week",
        "schedule": {
          "timeZone": "Pacific Standard Time",
          "days": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday"
          ],
          "hours": [ 8 ],
          "minutes": [ 0 ]
        }
      }
    } ],
    "enabled": true,
    "name": "webfrontend-norapp-norapp",
    "targetResourceUri": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/norapp/providers/icrosoft.classicCompute/domainNames/norapp/availabilitySets/webfrontend"
    "notifications": [
      {
        "operation": "Scale",
        "email": {
          "sendToSubscriptionAdministrator": false,
          "sendToSubscriptionCoAdministrators": false,
          "customEmails": [
              "user1@mycompany.com",
              "user2@mycompany.com"
              ]
        },
        "webhooks": [
          {
            "serviceUri": "https://foo.webhook.example.com?token=abcd1234",
            "properties": {
              "optional_key1": "optional_value1",
              "optional_key2": "optional_value2"
            }
          }
        ]
      }
    ]

  }
} 

Element Name

Description

name

The name of the autoscale setting.

Type

Specifies that this is of type Microsoft.Insights/AutoscaleSettings

location

Specifies the supported Azure location of the autoscale setting. For more information, see List all of the available geo-locations.

Tags

The tags and their values that are used by the autoscale setting.

Profiles

Contains a collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

Name

The name of the profile.

capacity

The number of instances that can be used during this profile.

Rules

Contains a collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.

metricTrigger

The trigger that results in a scaling action.

scaleAction

Specifies parameters for the scaling action.

fixedDate

A specific date for the profile. This element is not used if the Recurrence element is used.

recurrence

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

enabled

Specifies whether automatic scaling is enabled for the resource.

targetResourceUri

The resource identifier of the resource that the autoscale setting should be added to.

Element name

Description

minimum

Specifies the minimum number of instances that are available for the scaling action.

Maximum

Specifies the maximum number of instances that are available for the scaling action. The maximum number of instances is limited by the cores that are available in the subscription. You can use the classic portal to see the number of cores that are available in your subscription.

Default

Specifies the number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.

Element name

Description

metricName

The name of the metric that defines what the rule monitors.

metricResourceUri

The resource identifier of the resource the rule monitors.

timeGrain

The granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. ISO 8601 duration format.

Statistic

How the metrics from multiple instances are combined. Possible values are:

  • Average

  • Min

  • Max

timeWindow

The range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. ISO 8601 duration format.

timeAggregation

How the data that is collected should be combined over time. The default value is Average. Possible values are:

  • Average

  • Minimum

  • Maximum

  • Last

  • Total

  • Count

operator

The operator that is used to compare the metric data and the threshold. Possible values are:

  • Equals

  • NotEquals

  • GreaterThan

  • GreaterThanOrEqual

  • LessThan

  • LessThanOrEqual

threshold

The threshold of the metric that triggers the scale action.

Element name

Description

direction

Increase or decrease.

Type

The type of action that should occur, this must be set to ChangeCount or PercentChangeCount.

Value

The number that is involved in the scaling action. This value must be 1 or greater. The default value is 1.

Cooldown

The amount of time to wait since the last scaling action before this action occurs. Must be between 1 week and 1 minute. ISO 8601 duration format.

Element name

Description

timeZone

The time zone of the start and end times for the profile.

Start

The start time for the profile.

End

The end time for the profile.

Element name

Description

frequency

How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles.

Schedule

The scheduling constraints for when the profile begins.

timeZone

The time zone for the hours of the profile.

Days

An array of days of the week on which the profile will take effect. Possible values are days of the week (Sunday to Saturday).

Hours

An array of hours of the day when the profile will take effect. If multiple values are added, the profile will take effect at each of those hours.

Minutes

An array of minutes in an hour when the profile will take effect. If multiple values are added, the profile will take effect at each of those minute and hour values, eg. an hours array of [2, 5, 7] and minute array of [00, 30] will have the profile take effect at 2:00, 2:30, 5:00, 5:30, 7:00, and 7:30.

Field

Description

operation

value must be "Scale"

sendToSubscriptionAdministrator

value must be "true" or "false"

sendToSubscriptionCoAdministrator

value must be "true" or "false"

customEmails

value can be null [] or string array of emails

webhooks

can be null or valid Uri

serviceUri

a valid HTTPS Uri

properties

value must be empty {} or can contain key-value pairs

Show: