Масштабирование Microsoft.DesktopVirtualizationPlans 2021-07-12

Определение ресурса Bicep

Тип ресурса ScalingPlans можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DesktopVirtualization/scalingPlans, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DesktopVirtualization/scalingPlans@2021-07-12' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  managedBy: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    description: 'string'
    exclusionTag: 'string'
    friendlyName: 'string'
    hostPoolReferences: [
      {
        hostPoolArmPath: 'string'
        scalingPlanEnabled: bool
      }
    ]
    hostPoolType: 'string'
    schedules: [
      {
        daysOfWeek: [
          'string'
        ]
        name: 'string'
        offPeakLoadBalancingAlgorithm: 'string'
        offPeakStartTime: 'string'
        peakLoadBalancingAlgorithm: 'string'
        peakStartTime: 'string'
        rampDownCapacityThresholdPct: int
        rampDownForceLogoffUsers: bool
        rampDownLoadBalancingAlgorithm: 'string'
        rampDownMinimumHostsPct: int
        rampDownNotificationMessage: 'string'
        rampDownStartTime: 'string'
        rampDownStopHostsWhen: 'string'
        rampDownWaitTimeMinutes: int
        rampUpCapacityThresholdPct: int
        rampUpLoadBalancingAlgorithm: 'string'
        rampUpMinimumHostsPct: int
        rampUpStartTime: 'string'
      }
    ]
    timeZone: 'string'
  }
}

Значения свойств

scalingPlans

Имя Описание Значение
name имя ресурса. string (обязательно)
location Географическое расположение, в котором находится ресурс строка
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku ResourceModelWithAllowedPropertySetSku
kind Метаданные, используемые порталом, инструментами и т. д. для отрисовки различных интерфейсов для ресурсов одного типа; Например, ApiApps — это тип типа Microsoft.Web/sites. Если это поддерживается, поставщик ресурсов должен проверить и сохранить это значение. строка

Ограничения:
Шаблон = ^[-\w\._,\(\)]+$
удостоверение ResourceModelWithAllowedPropertySetIdentity
managedBy Полный идентификатор ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. Если это так, при развертывании в полном режиме ресурс не будет удален из шаблона, так как он управляется другим ресурсом. строка
План ResourceModelWithAllowedPropertySetPlan
properties Подробные свойства плана масштабирования. ScalingPlanProperties

ResourceModelWithAllowedPropertySetIdentity

Имя Описание Значение
тип Тип удостоверения. SystemAssigned

ResourceModelWithAllowedPropertySetPlan

Имя Описание Значение
name Определяемое пользователем имя приобретаемого артефакта стороннего производителя. string (обязательно)
product Артефакт 3-й партии, который приобретается. Например, NewRelic. Продукт сопоставляется с OfferID, заданным для артефакта во время подключения к рынке данных. string (обязательно)
promotionCode Издатель предоставил код повышения уровня, подготовленный на рынке данных для указанного продукта или артефакта. строка
publisher Издатель приобретаемого артефакта 3-й стороны. Например, NewRelic string (обязательно)
version Версия нужного продукта или артефакта. строка

ScalingPlanProperties

Имя Описание Значение
description Описание плана масштабирования. строка
exclusionTag Тег исключения для плана масштабирования. строка
friendlyName Понятное имя плана масштабирования. строка
hostPoolReferences Список определений ScalingHostPoolReference. ScalingHostPoolReference[]
hostPoolType Тип HostPool для настольных компьютеров. 'BYODesktop'
"Персональный"
"В пуле"
schedules Список определений ScalingSchedule. ScalingSchedule[]
timeZone Часовой пояс плана масштабирования. строка

ScalingHostPoolReference

Имя Описание Значение
hostPoolArmPath Путь arm для указанного пула узлов. строка
scalingPlanEnabled Для этого пула узлов включен план масштабирования. bool

ScalingSchedule

Имя Описание Значение
daysOfWeek Набор дней недели, в которые активно это расписание. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
name Имя расписания масштабирования. строка
offPeakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода внепиковой нагрузки. 'BreadthFirst'
DepthFirst
offPeakStartTime Время начала для периода непиковой нагрузки. строка
peakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода пиковой нагрузки. 'BreadthFirst'
DepthFirst
peakStartTime Время начала пикового периода. строка
rampDownCapacityThresholdPct Пороговое значение емкости для периода уменьшения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownForceLogoffUsers Следует ли принудительно выключить пользователей из узлов. bool
rampDownLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода уменьшения нагрузки. 'BreadthFirst'
DepthFirst
rampDownMinimumHostsPct Минимальный процент размещения для периода уменьшения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownNotificationMessage Уведомление для пользователей во время периода простоя. строка
rampDownStartTime Время начала для периода уменьшения. строка
rampDownStopHostsWhen Указывает, когда следует останавливать узлы во время простоя. ZeroActiveSessions
ZeroSessions
rampDownWaitTimeMinutes Количество минут, в течение которых необходимо дождаться остановки узлов во время простоя. INT
rampUpCapacityThresholdPct Пороговое значение емкости для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода увеличения нагрузки. 'BreadthFirst'
DepthFirst
rampUpMinimumHostsPct Минимальный процент узла для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpStartTime Время начала периода увеличения. строка

ResourceModelWithAllowedPropertySetSku

Имя Описание Значение
Емкость Если номер SKU поддерживает горизонтальное увеличение масштаба, необходимо включить целое число емкости. Если горизонтальное увеличение масштаба невозможно для ресурса, это можно опустить. INT
family Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. строка
name Имя номера SKU. Пример — P3. Обычно это буква+числовой код. string (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. строка
Уровень Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. "Базовый"
"Бесплатный"
"Премиум"
"Стандартный"

Определение ресурса шаблона ARM

Тип ресурса ScalingPlans можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DesktopVirtualization/scalingPlans, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DesktopVirtualization/scalingPlans",
  "apiVersion": "2021-07-12",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "description": "string",
    "exclusionTag": "string",
    "friendlyName": "string",
    "hostPoolReferences": [
      {
        "hostPoolArmPath": "string",
        "scalingPlanEnabled": "bool"
      }
    ],
    "hostPoolType": "string",
    "schedules": [
      {
        "daysOfWeek": [ "string" ],
        "name": "string",
        "offPeakLoadBalancingAlgorithm": "string",
        "offPeakStartTime": "string",
        "peakLoadBalancingAlgorithm": "string",
        "peakStartTime": "string",
        "rampDownCapacityThresholdPct": "int",
        "rampDownForceLogoffUsers": "bool",
        "rampDownLoadBalancingAlgorithm": "string",
        "rampDownMinimumHostsPct": "int",
        "rampDownNotificationMessage": "string",
        "rampDownStartTime": "string",
        "rampDownStopHostsWhen": "string",
        "rampDownWaitTimeMinutes": "int",
        "rampUpCapacityThresholdPct": "int",
        "rampUpLoadBalancingAlgorithm": "string",
        "rampUpMinimumHostsPct": "int",
        "rampUpStartTime": "string"
      }
    ],
    "timeZone": "string"
  }
}

Значения свойств

scalingPlans

Имя Описание Значение
тип Тип ресурса Microsoft.DesktopVirtualization/scalingPlans
версия_API Версия API ресурсов '2021-07-12'
name имя ресурса. string (обязательно)
location Географическое расположение, в котором находится ресурс строка
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku ResourceModelWithAllowedPropertySetSku
kind Метаданные, используемые порталом, инструментами и т. д. для отрисовки различных интерфейсов для ресурсов одного типа; Например, ApiApps — это тип типа Microsoft.Web/sites. Если это поддерживается, поставщик ресурсов должен проверить и сохранить это значение. строка

Ограничения:
Шаблон = ^[-\w\._,\(\)]+$
удостоверение ResourceModelWithAllowedPropertySetIdentity
managedBy Полный идентификатор ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. Если это так, при развертывании в полном режиме ресурс не будет удален из шаблона, так как он управляется другим ресурсом. строка
План ResourceModelWithAllowedPropertySetPlan
properties Подробные свойства плана масштабирования. ScalingPlanProperties

ResourceModelWithAllowedPropertySetIdentity

Имя Описание Значение
тип Тип удостоверения. SystemAssigned

ResourceModelWithAllowedPropertySetPlan

Имя Описание Значение
name Определяемое пользователем имя приобретаемого артефакта стороннего производителя. string (обязательно)
product Артефакт 3-й партии, который приобретается. Например, NewRelic. Продукт сопоставляется с OfferID, заданным для артефакта во время подключения к рынке данных. строка (обязательно)
promotionCode Издатель предоставил промокод, подготовленный на рынке данных для указанного продукта или артефакта. строка
publisher Издатель приобретаемого артефакта 3-го производителя. Например, NewRelic строка (обязательно)
version Версия нужного продукта или артефакта. строка

ScalingPlanProperties

Имя Описание Значение
description Описание плана масштабирования. строка
exclusionTag Тег исключения для плана масштабирования. строка
friendlyName Понятное имя плана масштабирования. строка
hostPoolReferences Список определений ScalingHostPoolReference. ScalingHostPoolReference[]
hostPoolType Тип HostPool для настольных компьютеров. 'BYODesktop'
"Персональный"
"В пуле"
schedules Список определений ScalingSchedule. ScalingSchedule[]
timeZone Часовой пояс плана масштабирования. строка

ScalingHostPoolReference

Имя Описание Значение
hostPoolArmPath Путь arm для указанного пула узлов. строка
scalingPlanEnabled Для этого пула узлов включен план масштабирования. bool

ScalingSchedule

Имя Описание Значение
daysOfWeek Набор дней недели, в которые активно это расписание. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
name Имя расписания масштабирования. строка
offPeakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода внепиковой нагрузки. 'BreadthFirst'
DepthFirst
offPeakStartTime Время начала для периода непиковой нагрузки. строка
peakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода пиковой нагрузки. 'BreadthFirst'
DepthFirst
peakStartTime Время начала пикового периода. строка
rampDownCapacityThresholdPct Пороговое значение емкости для периода уменьшения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownForceLogoffUsers Следует ли принудительно выключить пользователей из узлов. bool
rampDownLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода уменьшения нагрузки. 'BreadthFirst'
DepthFirst
rampDownMinimumHostsPct Минимальный процент размещения для периода уменьшения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownNotificationMessage Уведомление для пользователей во время периода простоя. строка
rampDownStartTime Время начала для периода уменьшения. строка
rampDownStopHostsWhen Указывает, когда следует останавливать узлы во время простоя. ZeroActiveSessions
ZeroSessions
rampDownWaitTimeMinutes Количество минут, в течение которых необходимо дождаться остановки узлов во время простоя. INT
rampUpCapacityThresholdPct Пороговое значение емкости для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода увеличения нагрузки. 'BreadthFirst'
DepthFirst
rampUpMinimumHostsPct Минимальный процент размещения для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpStartTime Время начала периода увеличения. строка

ResourceModelWithAllowedPropertySetSku

Имя Описание Значение
Емкость Если номер SKU поддерживает горизонтальное увеличение масштаба, необходимо включить целое число емкости. Если горизонтальное увеличение масштаба для ресурса невозможно, это может быть опущено. INT
family Если служба имеет разные поколения оборудования для одного номера SKU, то это можно записать здесь. строка
name Имя номера SKU. Ex - P3. Обычно это буква+числовой код. строка (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и некоторого другого значения, это будет автономный код. строка
Уровень Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется в PUT. "Базовый"
"Бесплатный"
"Премиум"
"Стандартный"

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса ScalingPlans можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DesktopVirtualization/scalingPlans, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/scalingPlans@2021-07-12"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      description = "string"
      exclusionTag = "string"
      friendlyName = "string"
      hostPoolReferences = [
        {
          hostPoolArmPath = "string"
          scalingPlanEnabled = bool
        }
      ]
      hostPoolType = "string"
      schedules = [
        {
          daysOfWeek = [
            "string"
          ]
          name = "string"
          offPeakLoadBalancingAlgorithm = "string"
          offPeakStartTime = "string"
          peakLoadBalancingAlgorithm = "string"
          peakStartTime = "string"
          rampDownCapacityThresholdPct = int
          rampDownForceLogoffUsers = bool
          rampDownLoadBalancingAlgorithm = "string"
          rampDownMinimumHostsPct = int
          rampDownNotificationMessage = "string"
          rampDownStartTime = "string"
          rampDownStopHostsWhen = "string"
          rampDownWaitTimeMinutes = int
          rampUpCapacityThresholdPct = int
          rampUpLoadBalancingAlgorithm = "string"
          rampUpMinimumHostsPct = int
          rampUpStartTime = "string"
        }
      ]
      timeZone = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
  })
}

Значения свойств

scalingPlans

Имя Описание Значение
тип Тип ресурса "Microsoft.DesktopVirtualization/scalingPlans@2021-07-12"
name имя ресурса. строка (обязательно)
location Географическое расположение, в котором находится ресурс строка
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов.
sku ResourceModelWithAllowedPropertySetSku
kind Метаданные, используемые порталом, инструментами и т. д. для отрисовки различных взаимодействий с пользовательским интерфейсом для ресурсов одного типа; Например, ApiApps — это тип типа Microsoft.Web/sites. Если это значение поддерживается, поставщик ресурсов должен проверить и сохранить это значение. строка

Ограничения:
Шаблон = ^[-\w\._,\(\)]+$
удостоверение ResourceModelWithAllowedPropertySetIdentity
managedBy Полный идентификатор ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. При наличии полного режима развертывания ресурс не будет удален из шаблона, так как он управляется другим ресурсом. строка
План ResourceModelWithAllowedPropertySetPlan
properties Подробные свойства плана масштабирования. ScalingPlanProperties

ResourceModelWithAllowedPropertySetIdentity

Имя Описание Значение
тип Тип удостоверения. "SystemAssigned"

ResourceModelWithAllowedPropertySetPlan

Имя Описание Значение
name Определяемое пользователем имя приобретаемого артефакта стороннего производителя. string (обязательно)
product Артефакт 3-й партии, который приобретается. Например, NewRelic. Продукт сопоставляется с OfferID, заданным для артефакта во время подключения к рынке данных. string (обязательно)
promotionCode Издатель предоставил код повышения уровня, подготовленный на рынке данных для указанного продукта или артефакта. строка
publisher Издатель приобретаемого артефакта 3-й стороны. Например, NewRelic string (обязательно)
version Версия нужного продукта или артефакта. строка

ScalingPlanProperties

Имя Описание Значение
description Описание плана масштабирования. строка
exclusionTag Тег исключения для плана масштабирования. строка
friendlyName Понятное имя плана масштабирования. строка
hostPoolReferences Список определений ScalingHostPoolReference. ScalingHostPoolReference[]
hostPoolType Тип hostPool для рабочего стола. "BYODesktop"
"Персональный"
"В пуле"
schedules Список определений ScalingSchedule. ScalingSchedule[]
timeZone Часовой пояс плана масштабирования. строка

ScalingHostPoolReference

Имя Описание Значение
hostPoolArmPath Путь arm для указанного пула узлов. строка
scalingPlanEnabled Включен ли план масштабирования для этого пула узлов. bool

ScalingSchedule

Имя Описание Значение
daysOfWeek Набор дней недели, в которые активно это расписание. Массив строк, содержащий любой из:
Пятница
Понедельник
Суббота
Воскресенье
Четверг
Вторник
Среда
name Имя расписания масштабирования. строка
offPeakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода непиковой нагрузки. "BreadthFirst"
"DepthFirst"
offPeakStartTime Время начала для периода непиковой нагрузки. строка
peakLoadBalancingAlgorithm Алгоритм балансировки нагрузки для пикового периода. "BreadthFirst"
"DepthFirst"
peakStartTime Время начала пикового периода. строка
rampDownCapacityThresholdPct Пороговое значение емкости для периода уменьшения емкости. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownForceLogoffUsers Следует ли принудительно выключить пользователей из узлов. bool
rampDownLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода уменьшения нагрузки. "BreadthFirst"
"DepthFirst"
rampDownMinimumHostsPct Минимальный процент узла для периода уменьшения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampDownNotificationMessage Уведомление для пользователей во время периода простоя. строка
rampDownStartTime Время начала для периода уменьшения. строка
rampDownStopHostsWhen Указывает, когда следует останавливать узлы во время периода простоя. "ZeroActiveSessions"
"ZeroSessions"
rampDownWaitTimeMinutes Время ожидания остановки узлов в течение периода простоя в минутах. INT
rampUpCapacityThresholdPct Пороговое значение емкости для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpLoadBalancingAlgorithm Алгоритм балансировки нагрузки для периода увеличения. "BreadthFirst"
"DepthFirst"
rampUpMinimumHostsPct Минимальный процент узла для периода увеличения. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 100
rampUpStartTime Время начала периода увеличения. строка

ResourceModelWithAllowedPropertySetSku

Имя Описание Значение
Емкость Если номер SKU поддерживает горизонтальное увеличение масштаба, необходимо включить целое число емкости. Если горизонтальное увеличение масштаба невозможно для ресурса, это можно опустить. INT
family Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. строка
name Имя номера SKU. Пример — P3. Обычно это буква+числовой код. string (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. строка
Уровень Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. "Basic"
"Бесплатный"
"Премиум"
"Стандартный"