Scaling Plan Pooled Schedules - Create

Служба:: Desktop Virtualization

Версия API:: 2025-10-10

Создайте или обновите ScalingPlanPooledSchedule.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}?api-version=2025-10-10

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Имя плана масштабирования.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Имя ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties.daysOfWeek	DayOfWeek[]	Набор дней недели, в течение которых этот график активен.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для вне пикового периода.
properties.offPeakStartTime	Time	Время начала периода вне пикового периода.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для пикового периода.
properties.peakStartTime	Time	Время начала пикового периода.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Пороговое значение емкости для периода уменьшения емкости.
properties.rampDownForceLogoffUsers	boolean	Если пользователи будут удалены принудительно из узлов.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для периода уменьшения нагрузки.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Минимальный процент узлов для периода уменьшения масштаба.
properties.rampDownNotificationMessage	string	Сообщение уведомления для пользователей в период простоя.
properties.rampDownStartTime	Time	Время начала для периода уменьшения.
properties.rampDownStopHostsWhen	StopHostsWhen	Указывает, когда следует остановить узлы во время периода простоя.
properties.rampDownWaitTimeMinutes	integer (int32)	Количество минут, чтобы дождаться остановки узлов во время отката периода.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Пороговое значение емкости для периода увеличения.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для увеличения периода.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Минимальный процент узлов для периода увеличения.
properties.rampUpStartTime	Time	Время начала периода увеличения.

Ответы

Имя	Тип	Описание
200 OK	ScalingPlanPooledSchedule	Успешно обновлено ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Успешно создан ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Ответ об ошибке автоматизации с описанием причины сбоя операции.

Примеры

ScalingPlanPooledSchedules_Create

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

HTTP

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1?api-version=2025-10-10

{
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

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

Код состояния:: 200

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

Код состояния:: 201

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

Определения

Имя	Описание
CloudError	Объект ошибки облака.
CloudErrorProperties	Свойства объекта ошибки облака.
createdByType	Тип удостоверения, создавшего ресурс.
DayOfWeek	День недели.
ScalingPlanPooledSchedule	Представляет определение ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для увеличения периода.
StopHostsWhen	Указывает, когда следует остановить узлы во время периода простоя.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Time	Время выполнения действия масштабирования.

CloudError

Объект

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

Имя	Тип	Описание
error	CloudErrorProperties	Свойства объекта ошибки облака.

CloudErrorProperties

Объект

Свойства объекта ошибки облака.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

createdByType

Перечисление

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

Значение	Описание
User
Application
ManagedIdentity
Key

DayOfWeek

Перечисление

День недели.

Значение	Описание
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Объект

Представляет определение ScalingPlanPooledSchedule.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.daysOfWeek	DayOfWeek[]	Набор дней недели, в течение которых этот график активен.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для вне пикового периода.
properties.offPeakStartTime	Time	Время начала периода вне пикового периода.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для пикового периода.
properties.peakStartTime	Time	Время начала пикового периода.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Пороговое значение емкости для периода уменьшения емкости.
properties.rampDownForceLogoffUsers	boolean	Если пользователи будут удалены принудительно из узлов.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для периода уменьшения нагрузки.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Минимальный процент узлов для периода уменьшения масштаба.
properties.rampDownNotificationMessage	string	Сообщение уведомления для пользователей в период простоя.
properties.rampDownStartTime	Time	Время начала для периода уменьшения.
properties.rampDownStopHostsWhen	StopHostsWhen	Указывает, когда следует остановить узлы во время периода простоя.
properties.rampDownWaitTimeMinutes	integer (int32)	Количество минут, чтобы дождаться остановки узлов во время отката периода.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Пороговое значение емкости для периода увеличения.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Алгоритм балансировки нагрузки для увеличения периода.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Минимальный процент узлов для периода увеличения.
properties.rampUpStartTime	Time	Время начала периода увеличения.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Перечисление

Алгоритм балансировки нагрузки для увеличения периода.

Значение	Описание
BreadthFirst
DepthFirst

StopHostsWhen

Перечисление

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

Значение	Описание
ZeroSessions
ZeroActiveSessions

systemData

Объект

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

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

Time

Объект

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

Имя	Тип	Описание
hour	integer (int32) minimum: 0 maximum: 23	Час.
minute	integer (int32) minimum: 0 maximum: 59	Минута.

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

Scaling Plan Pooled Schedules - Create

Параметры URI

Текст запроса

Ответы

Примеры

ScalingPlanPooledSchedules_Create

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

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

Определения

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time