Autoscale Settings - Get

サービス:

Monitor

API バージョン:

2022-10-01

自動スケール設定を取得します

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

URI パラメーター

名前	/	必須	型	説明
autoscaleSettingName	path	True	string	自動スケーリング設定の名前。
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AutoscaleSettingResource	1 つの自動スケーリング設定を取得する要求が成功しました
Other Status Codes	AutoscaleErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Get an autoscale setting

要求のサンプル

HTTP

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

Java

/**
 * Samples for AutoscaleSettings GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/examples/getAutoscaleSetting.json
     */
    /**
     * Sample code: Get an autoscale setting.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnAutoscaleSetting(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getAutoscaleSettings()
            .getByResourceGroupWithResponse("TestingMetricsScaleSet", "MySetting", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/examples/getAutoscaleSetting.json
func ExampleAutoscaleSettingsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAutoscaleSettingsClient().Get(ctx, "TestingMetricsScaleSet", "MySetting", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AutoscaleSettingResource = armmonitor.AutoscaleSettingResource{
	// 	Name: to.Ptr("MySetting"),
	// 	Type: to.Ptr("Microsoft.Insights/autoscaleSettings"),
	// 	ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Properties: &armmonitor.AutoscaleSetting{
	// 		Name: to.Ptr("MySetting"),
	// 		Enabled: to.Ptr(true),
	// 		Notifications: []*armmonitor.AutoscaleNotification{
	// 			{
	// 				Email: &armmonitor.EmailNotification{
	// 					CustomEmails: []*string{
	// 						to.Ptr("gu@ms.com"),
	// 						to.Ptr("ge@ns.net")},
	// 						SendToSubscriptionAdministrator: to.Ptr(true),
	// 						SendToSubscriptionCoAdministrators: to.Ptr(true),
	// 					},
	// 					Operation: to.Ptr("Scale"),
	// 					Webhooks: []*armmonitor.WebhookNotification{
	// 						{
	// 							Properties: map[string]*string{
	// 							},
	// 							ServiceURI: to.Ptr("http://myservice.com"),
	// 					}},
	// 			}},
	// 			PredictiveAutoscalePolicy: &armmonitor.PredictiveAutoscalePolicy{
	// 				ScaleMode: to.Ptr(armmonitor.PredictiveAutoscalePolicyScaleModeEnabled),
	// 			},
	// 			Profiles: []*armmonitor.AutoscaleProfile{
	// 				{
	// 					Name: to.Ptr("adios"),
	// 					Capacity: &armmonitor.ScaleCapacity{
	// 						Default: to.Ptr("1"),
	// 						Maximum: to.Ptr("10"),
	// 						Minimum: to.Ptr("1"),
	// 					},
	// 					FixedDate: &armmonitor.TimeWindow{
	// 						End: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-03-05T14:30:00.000Z"); return t}()),
	// 						Start: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-03-05T14:00:00.000Z"); return t}()),
	// 						TimeZone: to.Ptr("UTC"),
	// 					},
	// 					Rules: []*armmonitor.ScaleRule{
	// 						{
	// 							MetricTrigger: &armmonitor.MetricTrigger{
	// 								DividePerInstance: to.Ptr(false),
	// 								MetricName: to.Ptr("Percentage CPU"),
	// 								MetricResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc"),
	// 								Operator: to.Ptr(armmonitor.ComparisonOperationTypeGreaterThan),
	// 								Statistic: to.Ptr(armmonitor.MetricStatisticTypeAverage),
	// 								Threshold: to.Ptr[float64](10),
	// 								TimeAggregation: to.Ptr(armmonitor.TimeAggregationTypeAverage),
	// 								TimeGrain: to.Ptr("PT1M"),
	// 								TimeWindow: to.Ptr("PT5M"),
	// 							},
	// 							ScaleAction: &armmonitor.ScaleAction{
	// 								Type: to.Ptr(armmonitor.ScaleTypeChangeCount),
	// 								Cooldown: to.Ptr("PT5M"),
	// 								Direction: to.Ptr(armmonitor.ScaleDirectionIncrease),
	// 								Value: to.Ptr("1"),
	// 							},
	// 						},
	// 						{
	// 							MetricTrigger: &armmonitor.MetricTrigger{
	// 								DividePerInstance: to.Ptr(false),
	// 								MetricName: to.Ptr("Percentage CPU"),
	// 								MetricResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc"),
	// 								Operator: to.Ptr(armmonitor.ComparisonOperationTypeGreaterThan),
	// 								Statistic: to.Ptr(armmonitor.MetricStatisticTypeAverage),
	// 								Threshold: to.Ptr[float64](15),
	// 								TimeAggregation: to.Ptr(armmonitor.TimeAggregationTypeAverage),
	// 								TimeGrain: to.Ptr("PT2M"),
	// 								TimeWindow: to.Ptr("PT5M"),
	// 							},
	// 							ScaleAction: &armmonitor.ScaleAction{
	// 								Type: to.Ptr(armmonitor.ScaleTypeChangeCount),
	// 								Cooldown: to.Ptr("PT6M"),
	// 								Direction: to.Ptr(armmonitor.ScaleDirectionDecrease),
	// 								Value: to.Ptr("2"),
	// 							},
	// 					}},
	// 				},
	// 				{
	// 					Name: to.Ptr("saludos"),
	// 					Capacity: &armmonitor.ScaleCapacity{
	// 						Default: to.Ptr("1"),
	// 						Maximum: to.Ptr("10"),
	// 						Minimum: to.Ptr("1"),
	// 					},
	// 					Recurrence: &armmonitor.Recurrence{
	// 						Frequency: to.Ptr(armmonitor.RecurrenceFrequencyWeek),
	// 						Schedule: &armmonitor.RecurrentSchedule{
	// 							Days: []*string{
	// 								to.Ptr("1")},
	// 								Hours: []*int32{
	// 									to.Ptr[int32](5)},
	// 									Minutes: []*int32{
	// 										to.Ptr[int32](15)},
	// 										TimeZone: to.Ptr("UTC"),
	// 									},
	// 								},
	// 								Rules: []*armmonitor.ScaleRule{
	// 									{
	// 										MetricTrigger: &armmonitor.MetricTrigger{
	// 											DividePerInstance: to.Ptr(false),
	// 											MetricName: to.Ptr("Percentage CPU"),
	// 											MetricResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc"),
	// 											Operator: to.Ptr(armmonitor.ComparisonOperationTypeGreaterThan),
	// 											Statistic: to.Ptr(armmonitor.MetricStatisticTypeAverage),
	// 											Threshold: to.Ptr[float64](10),
	// 											TimeAggregation: to.Ptr(armmonitor.TimeAggregationTypeAverage),
	// 											TimeGrain: to.Ptr("PT1M"),
	// 											TimeWindow: to.Ptr("PT5M"),
	// 										},
	// 										ScaleAction: &armmonitor.ScaleAction{
	// 											Type: to.Ptr(armmonitor.ScaleTypeChangeCount),
	// 											Cooldown: to.Ptr("PT5M"),
	// 											Direction: to.Ptr(armmonitor.ScaleDirectionIncrease),
	// 											Value: to.Ptr("1"),
	// 										},
	// 									},
	// 									{
	// 										MetricTrigger: &armmonitor.MetricTrigger{
	// 											DividePerInstance: to.Ptr(false),
	// 											MetricName: to.Ptr("Percentage CPU"),
	// 											MetricResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc"),
	// 											Operator: to.Ptr(armmonitor.ComparisonOperationTypeGreaterThan),
	// 											Statistic: to.Ptr(armmonitor.MetricStatisticTypeAverage),
	// 											Threshold: to.Ptr[float64](15),
	// 											TimeAggregation: to.Ptr(armmonitor.TimeAggregationTypeAverage),
	// 											TimeGrain: to.Ptr("PT2M"),
	// 											TimeWindow: to.Ptr("PT5M"),
	// 										},
	// 										ScaleAction: &armmonitor.ScaleAction{
	// 											Type: to.Ptr(armmonitor.ScaleTypeChangeCount),
	// 											Cooldown: to.Ptr("PT6M"),
	// 											Direction: to.Ptr(armmonitor.ScaleDirectionDecrease),
	// 											Value: to.Ptr("2"),
	// 										},
	// 								}},
	// 						}},
	// 						TargetResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc"),
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an autoscale setting
 *
 * @summary Gets an autoscale setting
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/examples/getAutoscaleSetting.json
 */
async function getAnAutoscaleSetting() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "TestingMetricsScaleSet";
  const autoscaleSettingName = "MySetting";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.autoscaleSettings.get(resourceGroupName, autoscaleSettingName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/examples/getAutoscaleSetting.json
// this example is just showing the usage of "AutoscaleSettings_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "TestingMetricsScaleSet";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AutoscaleSettingResource
AutoscaleSettingCollection collection = resourceGroupResource.GetAutoscaleSettings();

// invoke the operation
string autoscaleSettingName = "MySetting";
NullableResponse<AutoscaleSettingResource> response = await collection.GetIfExistsAsync(autoscaleSettingName);
AutoscaleSettingResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    AutoscaleSettingData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "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": {}
          }
        ]
      }
    ]
  }
}

定義

名前	説明
AutoscaleErrorResponse	エラー応答の形式について説明します。
AutoscaleNotification	自動スケーリング通知。
AutoscaleProfile	自動スケーリング プロファイル。
AutoscaleSettingResource	自動スケーリング設定リソース。
ComparisonOperationType	メトリック データとしきい値を比較するために使用される演算子。
createdByType	リソースを作成した ID の種類。
EmailNotification	自動スケーリング イベントの通知をEmailします。
Error	error オブジェクト。
MetricStatisticType	メトリック統計の種類。 複数のインスタンスのメトリックを結合する方法。
MetricTrigger	スケーリング処理を発生させるトリガー。
OperationType	通知に関連付けられている操作とその値は "scale" である必要があります
PredictiveAutoscalePolicy	予測自動スケーリングを有効にするためのパラメーター。
PredictiveAutoscalePolicyScaleMode	予測自動スケーリング モード
Recurrence	このプロファイルが開始する繰り返しの時間。 FixedDate 要素が使用されている場合、この要素は使用されません。
RecurrenceFrequency	繰り返し頻度。 スケジュール プロファイルを有効にする頻度。 この値は Week である必要があります。つまり、毎週同じセットのプロファイルを用意することになります。 たとえば、毎日のスケジュールを設定するには、[ スケジュール] を [毎日] に設定します。 frequency プロパティは、スケジュールが毎週繰り返されることを指定します。
RecurrentSchedule	プロファイルを開始するときのスケジュールに関する制約。
ScaleAction	スケーリング アクションのパラメーター。
ScaleCapacity	このプロファイル中に使用できるインスタンスの数。
ScaleDirection	スケールの方向。 スケーリング アクションがインスタンスの数を増減するかどうか。
ScaleRule	スケーリング アクションのトリガーとパラメーターを提供するルール。
ScaleRuleMetricDimension	自動スケール ルールのメトリック ディメンションを指定します。
ScaleRuleMetricDimensionOperationType	ディメンション演算子。 'Equals' と 'NotEquals' のみがサポートされています。 'Equals' は、いずれかの値と等しくなります。 'NotEquals' がすべての値と等しくない
ScaleType	スケール ルールの起動時に発生するアクションの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TimeAggregationType	時間集計の種類。 収集されたデータの経時的な結合方法。 既定値は Average です。
TimeWindow	プロファイルの特定の日時。
WebhookNotification	自動スケーリング イベントの Webhook 通知。

AutoscaleErrorResponse

エラー応答の形式について説明します。

名前	型	説明
error	Error	error オブジェクト。
systemData	systemData	応答に関連するシステム メタデータ。

AutoscaleNotification

自動スケーリング通知。

名前	型	説明
email	EmailNotification	電子メール通知。
operation	OperationType	通知に関連付けられている操作とその値は "scale" である必要があります
webhooks	WebhookNotification[]	webhook 通知のコレクション。

AutoscaleProfile

自動スケーリング プロファイル。

名前	型	説明
capacity	ScaleCapacity	このプロファイル中に使用できるインスタンスの数。
fixedDate	TimeWindow	プロファイルの特定の日時。 Recurrence 要素が使用されている場合、この要素は使用されません。
name	string	プロファイルの名前。
recurrence	Recurrence	このプロファイルが開始される繰り返し時間。 FixedDate 要素が使用されている場合、この要素は使用されません。
rules	ScaleRule[]	スケーリング アクションのトリガーとパラメーターを提供するルールのコレクション。 指定できるルールは最大 10 個です。

AutoscaleSettingResource

自動スケーリング設定リソース。

名前	型	規定値	説明
id	string		Azure リソース ID
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

メトリック データとしきい値を比較するために使用される演算子。

名前	型	説明
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
NotEquals	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

EmailNotification

自動スケーリング イベントの通知をEmailします。

名前	型	規定値	説明
customEmails	string[]		カスタム電子メール の一覧。 この値には null または空を指定できます。この場合、この属性は無視されます。
sendToSubscriptionAdministrator	boolean	False	サブスクリプション管理者にメールを送信するかどうかを示す 値。
sendToSubscriptionCoAdministrators	boolean	False	サブスクリプションの共同管理者に電子メールを送信するかどうかを示す 値。

Error

error オブジェクト。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
details	string	エラーの詳細を人間が判読できる表現。
message	string	エラーの人間が判読できる表現。
target	string	特定のエラーのターゲット。

MetricStatisticType

メトリック統計の種類。 複数のインスタンスのメトリックを結合する方法。

名前	型	説明
Average	string
Count	string
Max	string
Min	string
Sum	string

MetricTrigger

スケーリング処理を発生させるトリガー。

名前	型	説明
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	インスタンス データが収集される時間の範囲。 この値は、メトリック収集の遅延を上回っている必要があります。これは、resource-to-resource とは異なることがあります。 12 時間から 5 分の値にする必要があります。

OperationType

通知に関連付けられている操作とその値は "scale" である必要があります

名前	型	説明
Scale	string

PredictiveAutoscalePolicy

予測自動スケーリングを有効にするためのパラメーター。

名前	型	説明
scaleLookAheadTime	string	インスタンスを事前に起動する時間を指定します。 ISO 8601 形式では、1 分から 60 分の間である必要があります。
scaleMode	PredictiveAutoscalePolicyScaleMode	予測自動スケーリング モード

PredictiveAutoscalePolicyScaleMode

予測自動スケーリング モード

名前	型	説明
Disabled	string
Enabled	string
ForecastOnly	string

Recurrence

このプロファイルが開始する繰り返しの時間。 FixedDate 要素が使用されている場合、この要素は使用されません。

名前	型	説明
frequency	RecurrenceFrequency	繰り返し頻度。 スケジュール プロファイルを有効にする頻度。 この値は Week である必要があります。つまり、毎週同じセットのプロファイルを用意することになります。 たとえば、毎日のスケジュールを設定するには、[ スケジュール] を [毎日] に設定します。 frequency プロパティは、スケジュールが毎週繰り返されることを指定します。
schedule	RecurrentSchedule	プロファイルが開始されたときのスケジュール制約。

RecurrenceFrequency

繰り返し頻度。 スケジュール プロファイルを有効にする頻度。 この値は Week である必要があります。つまり、毎週同じセットのプロファイルを用意することになります。 たとえば、毎日のスケジュールを設定するには、[ スケジュール] を [毎日] に設定します。 frequency プロパティは、スケジュールが毎週繰り返されることを指定します。

名前	型	説明
Day	string
Hour	string
Minute	string
Month	string
None	string
Second	string
Week	string
Year	string

RecurrentSchedule

プロファイルを開始するときのスケジュールに関する制約。

名前	型	説明
days	string[]	プロファイルが有効な日数のコレクション。 日曜日から土曜日までの値を指定できます。
hours	integer[]	プロファイルが有効になる時間 (時) のコレクション。 サポートされる値は、24 時間制の 0 から 23 です (AM/PM 時間はサポートされていません)。
minutes	integer[]	プロファイルが有効になる分のコレクション。
timeZone	string	プロファイルの時間のタイムゾーン。 有効なタイム ゾーンの例としては、Dateline Standard Time、UTC-11、ハワイ標準時、アラスカ標準時、太平洋標準時 (メキシコ)、太平洋標準時、米国山標準時(メキシコ)、山標準時 (メキシコ)、山標準時、中央アメリカ標準時、中央標準時(メキシコ)、カナダ中部標準時、SA 太平洋標準時、東部標準時、などがあります。 米国東部標準時、ベネズエラ標準時、パラグアイ標準時、大西洋標準時、中央ブラジル標準時、SA 西標準時、太平洋 SA 標準時、ニューファンドランド標準時、E. 南アメリカ標準時、アルゼンチン標準時、SA 東部標準時、グリーンランド標準時、モンテビデオ標準時、バイア標準時、UTC-02、Mid-Atlantic 標準時、アゾレス標準時、 カーボベルデ標準時、モロッコ標準時、UTC、GMT 標準時、グリニッジ標準時、W. ヨーロッパ標準時、中央ヨーロッパ標準時、ロマンス標準時、中央ヨーロッパ標準時、W. 中央アフリカ標準時、ナミビア標準時、ヨルダン標準時、GTB 標準時、中東標準時、エジプト標準時、シリア標準時、E. ヨーロッパ標準時、 南アフリカ標準時、FLE 標準時、トルコ標準時、イスラエル標準時、カリーニングラード標準時、リビア標準時、アラビア標準時、アラブ標準時、ベラルーシ標準時、ロシア標準時、E.アフリカ標準時、イラン標準時、アラビア標準時、アゼルバイジャン標準時、ロシアタイム ゾーン 3、モーリシャス標準時、グルジア標準時、コーカサス標準時、 アフガニスタン標準時、西アジア標準時、エカテリンブルク標準時、パキスタン標準時、インド標準時、スリランカ標準時、ネパール標準時、中央アジア標準時、バングラデシュ標準時、N.中央アジア標準時、ミャンマー標準時、SEアジア標準時、北アジア標準時、中国標準時、北アジア東部標準時、シンガポール標準時、 W. オーストラリア標準時、台北標準時、モンゴル標準時、東京標準時、韓国標準時、ヤクーツク標準時、Cen。 オーストラリア標準時、オーストラリア中部標準時、E. オーストラリア標準時、オーストラリア東部標準時、西太平洋標準時、タスマニア標準時、マガダン標準時、ウラジオストク標準時、ロシアタイム ゾーン 10、中央太平洋標準時、ロシアタイム ゾーン 11、ニュージーランド標準時、UTC+12、フィジー標準時、カムチャッカ標準時、トンガ標準時、サモア標準時、サモア標準時 Line Islands Standard Time

ScaleAction

スケーリング アクションのパラメーター。

名前	型	規定値	説明
cooldown	string		このアクションが発生するまでの最後のスケーリング アクションから待機する時間。 ISO 8601 形式では、1 週間から 1 分の間である必要があります。
direction	ScaleDirection		スケールの方向。 スケーリング アクションがインスタンスの数を増減するかどうか。
type	ScaleType		スケール ルールの起動時に発生するアクションの種類。
value	string	1	スケーリング アクションに関係するインスタンスの数。 1 以上の値を設定する必要があります。 既定値は 1 です。

ScaleCapacity

このプロファイル中に使用できるインスタンスの数。

名前	型	説明
default	string	評価にメトリックが使用できない場合に設定されるインスタンスの数。 既定値は、現在のインスタンスの数が既定値より少ない場合にのみ使用されます。
maximum	string	リソースのインスタンスの最大数。 実際のインスタンスの最大数は、サブスクリプションで使用できるコアによって制限されます。
minimum	string	リソースのインスタンスの最小数。

ScaleDirection

スケールの方向。 スケーリング アクションがインスタンスの数を増減するかどうか。

名前	型	説明
Decrease	string
Increase	string
None	string

ScaleRule

スケーリング アクションのトリガーとパラメーターを提供するルール。

名前	型	説明
metricTrigger	MetricTrigger	スケーリング アクションが発生するトリガー。
scaleAction	ScaleAction	スケーリング アクションのパラメーター。

ScaleRuleMetricDimension

自動スケール ルールのメトリック ディメンションを指定します。

名前	型	説明
DimensionName	string	ディメンションの名前。
Operator	ScaleRuleMetricDimensionOperationType	ディメンション演算子。 'Equals' と 'NotEquals' のみがサポートされています。 'Equals' は、いずれかの値と等しくなります。 'NotEquals' がすべての値と等しくない
Values	string[]	ディメンション値の一覧。 例: ["App1","App2"]。

ScaleRuleMetricDimensionOperationType

ディメンション演算子。 'Equals' と 'NotEquals' のみがサポートされています。 'Equals' は、いずれかの値と等しくなります。 'NotEquals' がすべての値と等しくない

名前	型	説明
Equals	string
NotEquals	string

ScaleType

スケール ルールの起動時に発生するアクションの種類。

名前	型	説明
ChangeCount	string
ExactCount	string
PercentChangeCount	string
ServiceAllowedNextValue	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TimeAggregationType

時間集計の種類。 収集されたデータの経時的な結合方法。 既定値は Average です。

名前	型	説明
Average	string
Count	string
Last	string
Maximum	string
Minimum	string
Total	string

TimeWindow

プロファイルの特定の日時。

名前	型	説明
end	string	ISO 8601 形式のプロファイルの終了時刻。
start	string	ISO 8601 形式のプロファイルの開始時刻。
timeZone	string	プロファイルの開始時刻と終了時刻のタイムゾーン。 有効なタイム ゾーンの例としては、Dateline Standard Time、UTC-11、ハワイ標準時、アラスカ標準時、太平洋標準時 (メキシコ)、太平洋標準時、米国山標準時(メキシコ)、山標準時 (メキシコ)、山標準時、中央アメリカ標準時、中央標準時(メキシコ)、カナダ中部標準時、SA 太平洋標準時、東部標準時、などがあります。 米国東部標準時、ベネズエラ標準時、パラグアイ標準時、大西洋標準時、中央ブラジル標準時、SA 西標準時、太平洋 SA 標準時、ニューファンドランド標準時、E. 南アメリカ標準時、アルゼンチン標準時、SA 東部標準時、グリーンランド標準時、モンテビデオ標準時、バイア標準時、UTC-02、Mid-Atlantic 標準時、アゾレス標準時、 カーボベルデ標準時、モロッコ標準時、UTC、GMT 標準時、グリニッジ標準時、W. ヨーロッパ標準時、中央ヨーロッパ標準時、ロマンス標準時、中央ヨーロッパ標準時、W. 中央アフリカ標準時、ナミビア標準時、ヨルダン標準時、GTB 標準時、中東標準時、エジプト標準時、シリア標準時、E. ヨーロッパ標準時、 南アフリカ標準時、FLE 標準時、トルコ標準時、イスラエル標準時、カリーニングラード標準時、リビア標準時、アラビア標準時、アラブ標準時、ベラルーシ標準時、ロシア標準時、E.アフリカ標準時、イラン標準時、アラビア標準時、アゼルバイジャン標準時、ロシアタイム ゾーン 3、モーリシャス標準時、グルジア標準時、コーカサス標準時、 アフガニスタン標準時、西アジア標準時、エカテリンブルク標準時、パキスタン標準時、インド標準時、スリランカ標準時、ネパール標準時、中央アジア標準時、バングラデシュ標準時、N.中央アジア標準時、ミャンマー標準時、SEアジア標準時、北アジア標準時、中国標準時、北アジア東部標準時、シンガポール標準時、 W. オーストラリア標準時、台北標準時、モンゴル標準時、東京標準時、韓国標準時、ヤクーツク標準時、Cen。 オーストラリア標準時、オーストラリア中部標準時、E. オーストラリア標準時、オーストラリア東部標準時、西太平洋標準時、タスマニア標準時、マガダン標準時、ウラジオストク標準時、ロシアタイム ゾーン 10、中央太平洋標準時、ロシアタイム ゾーン 11、ニュージーランド標準時、UTC+12、フィジー標準時、カムチャッカ標準時、トンガ標準時、サモア標準時、サモア標準時 Line Islands Standard Time

WebhookNotification

自動スケーリング イベントの Webhook 通知。

名前	型	説明
properties	object	設定のプロパティ バッグ。 この値は空にすることができます。
serviceUri	string	通知を受信するサービス アドレス。