共用方式為


Autoscale Settings - Get

取得自動調整設定

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}?api-version=2022-10-01

URI 參數

名稱 位於 必要 類型 Description
autoscaleSettingName
path True

string

自動調整設定名稱。

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

AutoscaleSettingResource

成功要求以取得一個自動調整設定

Other Status Codes

AutoscaleErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Get an autoscale setting

範例要求

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/TestingMetricsScaleSet/providers/Microsoft.Insights/autoscalesettings/MySetting?api-version=2022-10-01

範例回覆

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting",
  "name": "MySetting",
  "type": "Microsoft.Insights/autoscaleSettings",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "profiles": [
      {
        "name": "adios",
        "capacity": {
          "minimum": "1",
          "maximum": "10",
          "default": "1"
        },
        "rules": [
          {
            "metricTrigger": {
              "metricName": "Percentage CPU",
              "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
              "timeGrain": "PT1M",
              "statistic": "Average",
              "timeWindow": "PT5M",
              "timeAggregation": "Average",
              "operator": "GreaterThan",
              "threshold": 10,
              "dividePerInstance": false
            },
            "scaleAction": {
              "direction": "Increase",
              "type": "ChangeCount",
              "value": "1",
              "cooldown": "PT5M"
            }
          },
          {
            "metricTrigger": {
              "metricName": "Percentage CPU",
              "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
              "timeGrain": "PT2M",
              "statistic": "Average",
              "timeWindow": "PT5M",
              "timeAggregation": "Average",
              "operator": "GreaterThan",
              "threshold": 15,
              "dividePerInstance": false
            },
            "scaleAction": {
              "direction": "Decrease",
              "type": "ChangeCount",
              "value": "2",
              "cooldown": "PT6M"
            }
          }
        ],
        "fixedDate": {
          "timeZone": "UTC",
          "start": "2015-03-05T14:00:00Z",
          "end": "2015-03-05T14:30:00Z"
        }
      },
      {
        "name": "saludos",
        "capacity": {
          "minimum": "1",
          "maximum": "10",
          "default": "1"
        },
        "rules": [
          {
            "metricTrigger": {
              "metricName": "Percentage CPU",
              "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
              "timeGrain": "PT1M",
              "statistic": "Average",
              "timeWindow": "PT5M",
              "timeAggregation": "Average",
              "operator": "GreaterThan",
              "threshold": 10,
              "dividePerInstance": false
            },
            "scaleAction": {
              "direction": "Increase",
              "type": "ChangeCount",
              "value": "1",
              "cooldown": "PT5M"
            }
          },
          {
            "metricTrigger": {
              "metricName": "Percentage CPU",
              "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
              "timeGrain": "PT2M",
              "statistic": "Average",
              "timeWindow": "PT5M",
              "timeAggregation": "Average",
              "operator": "GreaterThan",
              "threshold": 15,
              "dividePerInstance": false
            },
            "scaleAction": {
              "direction": "Decrease",
              "type": "ChangeCount",
              "value": "2",
              "cooldown": "PT6M"
            }
          }
        ],
        "recurrence": {
          "frequency": "Week",
          "schedule": {
            "timeZone": "UTC",
            "days": [
              "1"
            ],
            "hours": [
              5
            ],
            "minutes": [
              15
            ]
          }
        }
      }
    ],
    "enabled": true,
    "predictiveAutoscalePolicy": {
      "scaleMode": "Enabled"
    },
    "name": "MySetting",
    "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
    "notifications": [
      {
        "operation": "Scale",
        "email": {
          "sendToSubscriptionAdministrator": true,
          "sendToSubscriptionCoAdministrators": true,
          "customEmails": [
            "gu@ms.com",
            "ge@ns.net"
          ]
        },
        "webhooks": [
          {
            "serviceUri": "http://myservice.com",
            "properties": {}
          }
        ]
      }
    ]
  }
}

定義

名稱 Description
AutoscaleErrorResponse

描述錯誤回應的格式。

AutoscaleNotification

自動調整通知。

AutoscaleProfile

自動調整配置檔。

AutoscaleSettingResource

自動調整設定資源。

ComparisonOperationType

用來比較計量數據和閾值的運算符。

createdByType

建立資源的身分識別類型。

EmailNotification

Email 自動調整事件的通知。

Error

error 物件。

MetricStatisticType

計量統計數據類型。 如何結合來自多個執行個體的度量。

MetricTrigger

會導致調整動作的觸發程序。

OperationType

與通知相關聯的作業及其值必須是“scale”

PredictiveAutoscalePolicy

啟用預測自動調整的參數。

PredictiveAutoscalePolicyScaleMode

預測性自動調整模式

Recurrence

此設定檔開始的重複次數。 如果使用了 FixedDate 元素,就不會使用這個元素。

RecurrenceFrequency

週期頻率。 排程設定檔應該生效的頻率。 此值必須是 [週],這表示每週將有一組相同的設定檔。 例如,若要設定每日排程,請將 排程 設定為每周的每一天。 frequency 屬性指定排程每周重複。

RecurrentSchedule

設定檔開始時的排程條件約束。

ScaleAction

調整動作的參數。

ScaleCapacity

可以在這個設定檔期間使用的執行個體數目。

ScaleDirection

縮放方向。 調整動作是否會增加或減少實例數目。

ScaleRule

提供調整動作之觸發程式和參數的規則。

ScaleRuleMetricDimension

指定自動調整規則計量維度。

ScaleRuleMetricDimensionOperationType

維度運算子。 僅支援 『Equals』 和 『NotEquals』。 'Equals' 等於任何值。 'NotEquals' 不等於所有值

ScaleType

引發縮放規則時應該發生的動作類型。

systemData

與建立和上次修改資源相關的元數據。

TimeAggregationType

時間匯總類型。 收集的資料應如何隨著時間結合。 預設值為 Average。

TimeWindow

配置檔的特定日期時間。

WebhookNotification

自動調整事件的 Webhook 通知。

AutoscaleErrorResponse

描述錯誤回應的格式。

名稱 類型 Description
error

Error

error 物件。

systemData

systemData

與回應相關的系統元數據。

AutoscaleNotification

自動調整通知。

名稱 類型 Description
email

EmailNotification

電子郵件通知。

operation

OperationType

與通知相關聯的作業及其值必須是“scale”

webhooks

WebhookNotification[]

Webhook 通知的集合。

AutoscaleProfile

自動調整配置檔。

名稱 類型 Description
capacity

ScaleCapacity

此配置檔期間可以使用的實例數目。

fixedDate

TimeWindow

配置檔的特定日期時間。 如果使用了 Recurrence 元素,就不會使用這個元素。

name

string

配置檔的名稱。

recurrence

Recurrence

這個配置檔開始的重複時間。 如果使用了 FixedDate 元素,就不會使用這個元素。

rules

ScaleRule[]

提供調整動作之觸發程式和參數的規則集合。 最多可指定 10 個規則。

AutoscaleSettingResource

自動調整設定資源。

名稱 類型 預設值 Description
id

string

Azure 資源標識碼

location

string

資源位置

name

string

Azure 資源名稱

properties.enabled

boolean

False

已啟用的旗標。 指定是否要針對資源啟用自動調整。 預設值為 'false'。

properties.name

string

自動調整設定的名稱。

properties.notifications

AutoscaleNotification[]

通知的集合。

properties.predictiveAutoscalePolicy

PredictiveAutoscalePolicy

預測性自動調整原則模式。

properties.profiles

AutoscaleProfile[]

自動調整配置檔的集合,指定不同時間週期的不同縮放參數。 最多可指定 20 個設定檔。

properties.targetResourceLocation

string

應加入自動調整設定的資源位置。

properties.targetResourceUri

string

應加入自動調整設定之資源的資源標識碼。

systemData

systemData

與回應相關的系統元數據。

tags

object

取得或設定描述資源的索引鍵值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標籤。 每個標籤的長度不能大於128個字元,且長度不超過256個字元的值。

type

string

Azure 資源類型

ComparisonOperationType

用來比較計量數據和閾值的運算符。

名稱 類型 Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

NotEquals

string

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

EmailNotification

Email 自動調整事件的通知。

名稱 類型 預設值 Description
customEmails

string[]

自訂電子郵件清單。 這個值可以是 Null 或空白,在此情況下,將會忽略這個屬性。

sendToSubscriptionAdministrator

boolean

False

值,指出是否要將電子郵件傳送給訂用帳戶管理員。

sendToSubscriptionCoAdministrators

boolean

False

值,指出是否要傳送電子郵件給訂用帳戶共同管理員。

Error

error 物件。

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。

details

string

人類可讀取的錯誤詳細數據表示法。

message

string

人類可讀取的錯誤表示法。

target

string

特定錯誤的目標。

MetricStatisticType

計量統計數據類型。 如何結合來自多個執行個體的度量。

名稱 類型 Description
Average

string

Count

string

Max

string

Min

string

Sum

string

MetricTrigger

會導致調整動作的觸發程序。

名稱 類型 Description
dimensions

ScaleRuleMetricDimension[]

維度條件的清單。 例如:[{“DimensionName”:“AppName”,“Operator”:“Equals”,“Values”:[“App1”]},{“DimensionName”:“Deployment”,“Operator”:“Equals”,“Values”:[“default”]}]。

dividePerInstance

boolean

值,指出計量是否應除以每個實例。

metricName

string

定義規則監視之計量的名稱。

metricNamespace

string

定義規則監視之計量的命名空間。

metricResourceLocation

string

規則監視的資源位置。

metricResourceUri

string

規則所監視之資源的資源標識碼。

operator

ComparisonOperationType

用來比較計量數據和閾值的運算符。

statistic

MetricStatisticType

計量統計數據類型。 如何結合來自多個執行個體的度量。

threshold

number

觸發縮放動作之計量的臨界值。

timeAggregation

TimeAggregationType

時間匯總類型。 收集的資料應如何隨著時間結合。 預設值為 Average。

timeGrain

string

規則監視的計量粒度。 必須是從度量的度量定義傳回的其中一個預先定義的值。 必須介於 12 小時與 1 分鐘之間。

timeWindow

string

收集實例數據的時間範圍。 此值必須大於度量集合中的延遲 (可能會因資源而有所不同)。 必須介於 12 小時與 5 分鐘之間。

OperationType

與通知相關聯的作業及其值必須是“scale”

名稱 類型 Description
Scale

string

PredictiveAutoscalePolicy

啟用預測自動調整的參數。

名稱 類型 Description
scaleLookAheadTime

string

指定要事先啟動實例的時間量。 它必須介於 ISO 8601 格式的 1 分鐘到 60 分鐘之間。

scaleMode

PredictiveAutoscalePolicyScaleMode

預測性自動調整模式

PredictiveAutoscalePolicyScaleMode

預測性自動調整模式

名稱 類型 Description
Disabled

string

Enabled

string

ForecastOnly

string

Recurrence

此設定檔開始的重複次數。 如果使用了 FixedDate 元素,就不會使用這個元素。

名稱 類型 Description
frequency

RecurrenceFrequency

週期頻率。 排程設定檔應該生效的頻率。 此值必須是 [週],這表示每週將有一組相同的設定檔。 例如,若要設定每日排程,請將 排程 設定為每周的每一天。 frequency 屬性指定排程每周重複。

schedule

RecurrentSchedule

配置文件開始時的排程條件約束。

RecurrenceFrequency

週期頻率。 排程設定檔應該生效的頻率。 此值必須是 [週],這表示每週將有一組相同的設定檔。 例如,若要設定每日排程,請將 排程 設定為每周的每一天。 frequency 屬性指定排程每周重複。

名稱 類型 Description
Day

string

Hour

string

Minute

string

Month

string

None

string

Second

string

Week

string

Year

string

RecurrentSchedule

設定檔開始時的排程條件約束。

名稱 類型 Description
days

string[]

配置檔生效的天數集合。 可能的值為星期日到星期六。

hours

integer[]

配置檔生效的時數集合。 24 小時制 (上午/PM 時間不支援 0 到 23 的值) 。

minutes

integer[]

設定檔生效的分鐘集合。

timeZone

string

配置檔時數的時區。 有效時區的一些範例包括:日期線標準時間、UTC-11、墨西哥標準時間、批注標準時間、太平洋標準時間 (墨西哥) 、太平洋標準時間、美國標準時間、美國標準時間 (墨西哥) 、Mountain Standard Time、Central Standard Time、Central Standard Time、Central Standard Time (墨西哥) 、加拿大中部標準時間、 SA Pacific Standard Time、美國東部標準時間、美國東部標準時間、阿根廷標準時間、巴西標準時間、巴西標準時間、SA 西部標準時間、太平洋 SA 標準時間、Newfoundland 標準時間、E.南北美洲標準時間、阿根廷標準時間、SA 東部標準時間、綠地標準時間、Montvideo 標準時間、蒙地維標準時間、Ba pacific Standard Time、 UTC-02、Mid-Atlantic 標準時間、Azores 標準時間、維德達標準時間、南非標準時間、阿拉伯標準時間、UTC、GMT 標準時間、W. 歐洲標準時間、西歐標準時間、中部標準時間、W.非洲標準時間、W.非洲標準時間、德國標準時間、西班牙標準時間、GTB 標準時間、中東標準時間、德國標準時間、中部標準時間、中部標準時間、 希臘標準時間、E. 歐洲標準時間、南非標準時間、FLE 標準時間、土耳其標準時間、以色列標準時間、亞美尼亞標準時間、阿拉伯標準時間、白俄羅斯標準時間、俄文標準時間、E.非洲標準時間、非洲標準時間、阿拉伯標準時間、阿拉伯標準時間、亞塞亞標準時間、俄羅斯時區 3、阿根廷標準時間、俄羅斯標準時間、 喬治亞標準時間、Caucasus 標準時間、喬治亞標準時間、西歐標準時間、Ekaterinburg 標準時間、印尼標準時間、印度標準時間、中部標準時間、中部標準時間、中部標準時間、N.東亞標準時間、北歐標準時間、SE 亞洲標準時間、北歐標準時間、 新加坡標準時間、W. Australia Standard Time、Ta一標準時間、Ulaanbaatar 標準時間、東京標準時間、韓國標準時間、Yakutsk 標準時間、Cen。 澳大利亞標準時間、AUS 中部標準時間、E. 澳大利亞標準時間、AUS 東部標準時間、西太平洋標準時間、Tasmania 標準時間、Magadan 標準時間、Vladivostok 標準時間、俄羅斯時區 10、中部太平洋標準時間、俄羅斯時區 11、紐西蘭標準時間、UTC+12、紐西蘭標準時間、UTC+12、亞美尼亞標準時間、卡達標準時間、Tonga 標準時間、亞美尼亞標準時間、 Line Islands Standard Time

ScaleAction

調整動作的參數。

名稱 類型 預設值 Description
cooldown

string

自此動作發生前的最後一個調整動作之後要等候的時間量。 它必須介於 ISO 8601 格式的 1 周到 1 分鐘之間。

direction

ScaleDirection

縮放方向。 調整動作是否會增加或減少實例數目。

type

ScaleType

引發縮放規則時應該發生的動作類型。

value

string

1

調整動作所涉及的實例數目。 此值必須是 1 或更大。 預設值為 1。

ScaleCapacity

可以在這個設定檔期間使用的執行個體數目。

名稱 類型 Description
default

string

如果計量無法用於評估,將會設定的實例數目。 只有當目前的執行個體計數低於預設值時,才會使用預設值。

maximum

string

資源的最大實例數目。 實際的實例數目上限受限於訂用帳戶中可用的核心。

minimum

string

資源的實例數目下限。

ScaleDirection

縮放方向。 調整動作是否會增加或減少實例數目。

名稱 類型 Description
Decrease

string

Increase

string

None

string

ScaleRule

提供調整動作之觸發程式和參數的規則。

名稱 類型 Description
metricTrigger

MetricTrigger

導致調整動作的觸發程式。

scaleAction

ScaleAction

調整動作的參數。

ScaleRuleMetricDimension

指定自動調整規則計量維度。

名稱 類型 Description
DimensionName

string

維度的名稱。

Operator

ScaleRuleMetricDimensionOperationType

維度運算子。 僅支援 『Equals』 和 『NotEquals』。 'Equals' 等於任何值。 'NotEquals' 不等於所有值

Values

string[]

維度值的清單。 例如:[“App1”,“App2”]。

ScaleRuleMetricDimensionOperationType

維度運算子。 僅支援 『Equals』 和 『NotEquals』。 'Equals' 等於任何值。 'NotEquals' 不等於所有值

名稱 類型 Description
Equals

string

NotEquals

string

ScaleType

引發縮放規則時應該發生的動作類型。

名稱 類型 Description
ChangeCount

string

ExactCount

string

PercentChangeCount

string

ServiceAllowedNextValue

string

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

TimeAggregationType

時間匯總類型。 收集的資料應如何隨著時間結合。 預設值為 Average。

名稱 類型 Description
Average

string

Count

string

Last

string

Maximum

string

Minimum

string

Total

string

TimeWindow

配置檔的特定日期時間。

名稱 類型 Description
end

string

ISO 8601 格式配置檔的結束時間。

start

string

ISO 8601 格式配置檔的開始時間。

timeZone

string

配置檔開始和結束時間的時區。 有效時區的一些範例包括:日期線標準時間、UTC-11、墨西哥標準時間、批注標準時間、太平洋標準時間 (墨西哥) 、太平洋標準時間、美國標準時間、美國標準時間 (墨西哥) 、Mountain Standard Time、Central Standard Time、Central Standard Time、Central Standard Time (墨西哥) 、加拿大中部標準時間、 SA Pacific Standard Time、美國東部標準時間、美國東部標準時間、阿根廷標準時間、巴西標準時間、巴西標準時間、SA 西部標準時間、太平洋 SA 標準時間、Newfoundland 標準時間、E.南北美洲標準時間、阿根廷標準時間、SA 東部標準時間、綠地標準時間、Montvideo 標準時間、蒙地維標準時間、Ba pacific Standard Time、 UTC-02、Mid-Atlantic 標準時間、Azores 標準時間、維德達標準時間、南非標準時間、阿拉伯標準時間、UTC、GMT 標準時間、W. 歐洲標準時間、西歐標準時間、中部標準時間、W.非洲標準時間、W.非洲標準時間、德國標準時間、西班牙標準時間、GTB 標準時間、中東標準時間、德國標準時間、中部標準時間、中部標準時間、 希臘標準時間、E. 歐洲標準時間、南非標準時間、FLE 標準時間、土耳其標準時間、以色列標準時間、亞美尼亞標準時間、阿拉伯標準時間、白俄羅斯標準時間、俄文標準時間、E.非洲標準時間、非洲標準時間、阿拉伯標準時間、阿拉伯標準時間、亞塞亞標準時間、俄羅斯時區 3、阿根廷標準時間、俄羅斯標準時間、 喬治亞標準時間、Caucasus 標準時間、喬治亞標準時間、西歐標準時間、Ekaterinburg 標準時間、印尼標準時間、印度標準時間、中部標準時間、中部標準時間、中部標準時間、N.東亞標準時間、北歐標準時間、SE 亞洲標準時間、北歐標準時間、 新加坡標準時間、W. Australia Standard Time、Ta一標準時間、Ulaanbaatar 標準時間、東京標準時間、韓國標準時間、Yakutsk 標準時間、Cen。 澳大利亞標準時間、AUS 中部標準時間、E. 澳大利亞標準時間、AUS 東部標準時間、西太平洋標準時間、Tasmania 標準時間、Magadan 標準時間、Vladivostok 標準時間、俄羅斯時區 10、中部太平洋標準時間、俄羅斯時區 11、紐西蘭標準時間、UTC+12、紐西蘭標準時間、UTC+12、亞美尼亞標準時間、卡達標準時間、Tonga 標準時間、亞美尼亞標準時間、 Line Islands Standard Time

WebhookNotification

自動調整事件的 Webhook 通知。

名稱 類型 Description
properties

object

設定的屬性包。 此值可以是空的。

serviceUri

string

要接收通知的服務位址。