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	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	AutoscaleSettingResource	Успешный запрос на получение одного параметра автомасштабирования
Other Status Codes	AutoscaleErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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


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

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

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

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://video2.skills-academy.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	Тип удостоверения, создавшего ресурс.
EmailNotification	Email уведомление о событии автомасштабирования.
Error	Объект ошибки.
MetricStatisticType	тип статистики метрик. Указывает, как объединяются метрики от нескольких экземпляров.
MetricTrigger	Триггер, который приводит в действие операцию масштабирования.
OperationType	операция, связанная с уведомлением, и ее значение должно быть "scale"
PredictiveAutoscalePolicy	Параметры для включения прогнозного автомасштабирования.
PredictiveAutoscalePolicyScaleMode	режим прогнозного автомасштабирования
Recurrence	Количество повторов, после которого запускается этот профиль. Этот элемент не используется, если используется элемент FixedDate.
RecurrenceFrequency	частота повторения. Задает частоту выполнения расписания профилей. Этот параметр должен иметь значение "неделя", то есть на каждую неделю будет задан один и тот же набор профилей. Например, чтобы задать ежедневное расписание, присвойте расписание каждому дню недели. Свойство frequency указывает, что расписание повторяется еженедельно.
RecurrentSchedule	Ограничения расписания для начала профиля.
ScaleAction	Параметры для действия масштабирования.
ScaleCapacity	Задает количество экземпляров, которые можно использовать в этом профиле.
ScaleDirection	направление масштабирования. Указывает, увеличивает ли действие масштабирования или уменьшает количество экземпляров.
ScaleRule	Правило, которое предоставляет триггеры и параметры для действия масштабирования.
ScaleRuleMetricDimension	Задает измерение метрики правила автомасштабирования.
ScaleRuleMetricDimensionOperationType	оператор измерения. Поддерживаются только "Равно" и "NotEquals". Значение "Равно" равно любому из значений. NotEquals не равно всем значениям
ScaleType	тип действия, которое должно выполняться при срабатывании правила масштабирования.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TimeAggregationType	тип агрегирования времени. Порядок объединения данных, собранных за определенный период. Значение по умолчанию — Average (Среднее).
TimeWindow	Определенная дата и время для профиля.
WebhookNotification	Уведомление веб-перехватчика о событии автомасштабирования.

AutoscaleErrorResponse

Описывает формат ответа об ошибке.

Имя	Тип	Описание
error	Error	Объект ошибки.
systemData	systemData	Системные метаданные, связанные с ответом.

AutoscaleNotification

Уведомление об автомасштабировании.

Имя	Тип	Описание
email	EmailNotification	уведомление по электронной почте.
operation	OperationType	операция, связанная с уведомлением, и ее значение должно быть "scale"
webhooks	WebhookNotification[]	коллекция уведомлений веб-перехватчика.

AutoscaleProfile

Профиль автомасштабирования.

Имя	Тип	Описание
capacity	ScaleCapacity	количество экземпляров, которые можно использовать в этом профиле.
fixedDate	TimeWindow	конкретную дату и время для профиля. Этот элемент не используется, если используется элемент Recurrence.
name	string	имя профиля.
recurrence	Recurrence	время повторения, с которого начинается этот профиль. Этот элемент не используется, если используется элемент FixedDate.
rules	ScaleRule[]	коллекция правил, которые предоставляют триггеры и параметры для действия масштабирования. Можно указать максимум десять правил.

AutoscaleSettingResource

Ресурс параметра автомасштабирования.

Имя	Тип	Default value	Описание
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

Оператор, используемый для сравнения данных метрик и порогового значения.

Имя	Тип	Описание
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
NotEquals	string

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

EmailNotification

Email уведомление о событии автомасштабирования.

Имя	Тип	Default value	Описание
customEmails	string[]		настраиваемый список сообщений электронной почты. Это значение может быть пустым или null. В этом случае этот атрибут будет игнорироваться.
sendToSubscriptionAdministrator	boolean	False	значение , указывающее, следует ли отправлять сообщения электронной почты администратору подписки.
sendToSubscriptionCoAdministrators	boolean	False	значение , указывающее, следует ли отправлять сообщения электронной почты соадминистраторам подписки.

Error

Объект ошибки.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
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	диапазон времени, в течение которого собираются данные экземпляра. Это значение должно быть больше, чем задержка в сборе метрики, которая может отличаться для каждого ресурса. Должно быть в интервале от 12 часов до 5 минут.

OperationType

операция, связанная с уведомлением, и ее значение должно быть "scale"

Имя	Тип	Описание
Scale	string

PredictiveAutoscalePolicy

Параметры для включения прогнозного автомасштабирования.

Имя	Тип	Описание
scaleLookAheadTime	string	время, в течение которого необходимо указать, какие экземпляры запускаются заранее. Оно должно быть от 1 до 60 минут в формате ISO 8601.
scaleMode	PredictiveAutoscalePolicyScaleMode	режим прогнозного автомасштабирования

PredictiveAutoscalePolicyScaleMode

режим прогнозного автомасштабирования

Имя	Тип	Описание
Disabled	string
Enabled	string
ForecastOnly	string

Recurrence

Количество повторов, после которого запускается этот профиль. Этот элемент не используется, если используется элемент FixedDate.

Имя	Тип	Описание
frequency	RecurrenceFrequency	частота повторения. Задает частоту выполнения расписания профилей. Этот параметр должен иметь значение "неделя", то есть на каждую неделю будет задан один и тот же набор профилей. Например, чтобы задать ежедневное расписание, задайте для расписания каждый день недели. Свойство frequency указывает, что расписание повторяется еженедельно.
schedule	RecurrentSchedule	ограничения планирования для начала работы профиля.

RecurrenceFrequency

частота повторения. Задает частоту выполнения расписания профилей. Этот параметр должен иметь значение "неделя", то есть на каждую неделю будет задан один и тот же набор профилей. Например, чтобы задать ежедневное расписание, присвойте расписание каждому дню недели. Свойство frequency указывает, что расписание повторяется еженедельно.

Имя	Тип	Описание
Day	string
Hour	string
Minute	string
Month	string
None	string
Second	string
Week	string
Year	string

RecurrentSchedule

Ограничения расписания для начала профиля.

Имя	Тип	Описание
days	string[]	коллекция дней, на которые вступает в силу профиль. Возможные значения — с воскресенья по субботу.
hours	integer[]	Коллекция часов, на которые вступает в силу профиль. Поддерживаются значения от 0 до 23 для 24-часовых часов (время AM/PM не поддерживается).
minutes	integer[]	Коллекция минут, по которым профиль действует.
timeZone	string	часовой пояс для часов профиля. Примеры допустимых часовых поясов: стандартное время даты, utc-11, гавайское стандартное время, аляскинское стандартное время, тихоокеанское стандартное время (Мексика), тихоокеанское стандартное время, стандартное горное время США, стандартное горное время (Мексика), стандартное горное время , центральное стандартное время в Центральной Америке, центральное стандартное время (Мексика), центральное стандартное время (Мексика), центральное стандартное время Канады, стандартное тихоокеанское время SA, восточное стандартное время, Восточное стандартное время США, венесуэльское стандартное время, стандартное время Парагвая, атлантическое стандартное время, центральное бразильское время, западное стандартное время SA, тихоокеанское sa стандартное время, стандартное время Ньюфаундленда, стандартное время в Аргентине, восточное стандартное время SA, стандартное время в Гренландии, стандартное время Монтевидео, стандартное время в Баии, UTC-02, Mid-Atlantic стандартное время, Азорское время, Кабо-Верде стандартное время, марокко стандартное время, UTC, gmt standard time, гринвичское стандартное время, W. Europe Standard Time, Центрально-Европейское стандартное время, Центральноевропейское стандартное время, W. Центральноафриканское стандартное время, Намибия стандартное время, Стандартное время Иордании, GTB Standard Time, Центральное время Для Египта, Сирийское стандартное время, E. Europe standard time, Стандартное время в Южной Африке, стандартное время FLE, стандартное время в Турции, стандартное время в Израиле, стандартное время в Тбилиси, стандартное арабское время, стандартное арабское время, стандартное белорусское время, русское стандартное время, стандартное время E. Africa, стандартное время в Иране, стандартное арабское время, стандартное время для Азербайджана, часовой пояс 3, маврикийское время, стандартное грузинское время, кавказское стандартное время, Стандартное время в Афганистане, центрально-азиатское стандартное время, стандартное время в Екатеринбурге, пакистанское стандартное время, стандартное время в Индии, шри-ланка стандартное время, непальское стандартное время, центрально-азиатское стандартное время, стандартное время В Бангладеш, стандартное время в Мьянме, стандартное время Se Asia, стандартное время Северной Азии, стандартное время Для Китая, Восточно-Восточное стандартное время Северо-Азии, сингапурское время, стандартное время, W. Australia Standard Time, Тайбэйское стандартное время, Улан-Батор стандартное время, токийское стандартное время, Корейское стандартное время, Якутское стандартное время, Cen. Австралийское стандартное время, центральное стандартное время AUS, стандартное время E. Australia, восточное стандартное время AUS, западно-тихоокеанское стандартное время, стандартное время в Тасмании, стандартное время в Магадане, стандартное время в 10, россия часовой пояс 10, центральное тихоокеанское время, часовой пояс 11, стандартное время в Новой Зеландии, UTC+12, стандартное время Фиджи, стандартное время Навея, Стандартное время Тонга, Стандартное время Самоа, Line Islands (зима)

ScaleAction

Параметры для действия масштабирования.

Имя	Тип	Default value	Описание
cooldown	string		время ожидания с момента последнего действия масштабирования перед выполнением этого действия. Он должен находиться в диапазоне от 1 недели до 1 минуты в формате ISO 8601.
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	оператор измерения. Поддерживаются только "Равно" и "NotEquals". Значение "Равно" равно любому из значений. NotEquals не равно всем значениям
Values	string[]	список значений измерения. Например: ["App1","App2"].

ScaleRuleMetricDimensionOperationType

оператор измерения. Поддерживаются только "Равно" и "NotEquals". Значение "Равно" равно любому из значений. NotEquals не равно всем значениям

Имя	Тип	Описание
Equals	string
NotEquals	string

ScaleType

тип действия, которое должно выполняться при срабатывании правила масштабирования.

Имя	Тип	Описание
ChangeCount	string
ExactCount	string
PercentChangeCount	string
ServiceAllowedNextValue	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

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	часовой пояс времени начала и окончания для профиля. Некоторые примеры допустимых часовых поясов: стандартное время в формате UTC, время UTC-11, гавайское стандартное время, стандартное время Аляски, тихоокеанское стандартное время (Мексика), тихоокеанское время, стандартное время США, горное стандартное время (Мексика), горное стандартное время (Мексика), стандартное время в Центральной Америке, центральное стандартное время (Мексика), центральное стандартное время (Мексика), центральное стандартное время (Мексика), тихоокеанское время SA, восточное стандартное время. Восточное стандартное время США, венесуэльское стандартное время, стандартное время Парагвая, атлантическое стандартное время, центральное бразильский стандартное время, западное стандартное время SA, тихоокеанское стандартное время SA, стандартное время Ньюфаундленд, стандартное время E. южно-американское, аргентинское стандартное время, восточное время SA, стандартное время Гренландии, монтевидео стандартное время, стандартное время Баия, UTC-02, Mid-Atlantic стандартное время, Азорское время, Кабо-Верде (зима), марокко (стандартное время), время (UTC), стандартное время GMT, стандартное время по Гринвичу, стандартное время W. Europe, центральноевропейское стандартное время, романское стандартное время, центральноевропейское время (зима), центральное африканское время, стандартное время в Намибии, стандартное время в Иордании, gtb standard time, центрально-восточное время Египта, сирийское стандартное время, E. Europe standard time, Стандартное время в Южной Африке, стандартное время FLE, стандартное время в Турции, стандартное время в Израиле, стандартное время в Ливии, арабское стандартное время, стандартное арабское время, стандартное белорусское время, российское стандартное время, стандартное время E. Africa, стандартное время в Иране, арабское стандартное время, стандартное время в Азербайджане, часовой пояс России 3, маврикийское время, стандартное грузинское время, кавказское стандартное время, Стандартное время Для Афганистана, Западно-Азиатское стандартное время, Центрально-Азиатское стандартное время, Стандартное время в Пакистане, Стандартное время в Индии, Стандартное время Шри-Ланки, Центрально-Азиатское стандартное время, Бангладеш, N. Центрально-Азиатское стандартное время, Стандартное время в Мьянме, по среднеазиатским времени (зима), по северо-азиатскому стандартному времени, по китайскому стандартному времени, по Восточно-Восточной Азии, по сингапурскому времени( сингапурское время), W. Australia standard time, Taipei standard time, Ulaanbaatar standard time, Tokyo Standard Time, Korea Standard Time, Якутск standard time, Cen. Австралийское стандартное время, центральное стандартное время AUS, стандартное время E. Австралия, восточное стандартное время AUS, западное тихоокеанское стандартное время, стандартное время Тасмания, Магаданское стандартное время, стандартное время в Гуланде, часовой пояс 10, центрально-тихоокеанское время, часовой пояс 11, новозеландское стандартное время, UTC+12, стандартное время Фиджи, стандартное время «Камчатка», тонга стандартное время, самоа стандартное время, Line Islands (зима)

WebhookNotification

Уведомление веб-перехватчика о событии автомасштабирования.

Имя	Тип	Описание
properties	object	набор свойств параметров. Это значение может быть пустым.
serviceUri	string	адрес службы для получения уведомления.

Поделиться через

Autoscale Settings - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get an autoscale setting

Образец запроса

Пример ответа

Определения

AutoscaleErrorResponse

AutoscaleNotification

AutoscaleProfile

AutoscaleSettingResource

ComparisonOperationType

createdByType

EmailNotification

Error

MetricStatisticType

MetricTrigger

OperationType

PredictiveAutoscalePolicy

PredictiveAutoscalePolicyScaleMode

Recurrence

RecurrenceFrequency

RecurrentSchedule

ScaleAction

ScaleCapacity

ScaleDirection

ScaleRule

ScaleRuleMetricDimension

ScaleRuleMetricDimensionOperationType

ScaleType

systemData

TimeAggregationType

TimeWindow

WebhookNotification

Дополнительные ресурсы