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


Пулы узлов Microsoft.DesktopVirtualization

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

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

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

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

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview' = {
  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: {
    agentUpdate: {
      maintenanceWindows: [
        {
          dayOfWeek: 'string'
          hour: int
        }
      ]
      maintenanceWindowTimeZone: 'string'
      type: 'string'
      useSessionHostLocalTime: bool
    }
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managementType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    publicNetworkAccess: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    ring: int
    ssoadfsAuthority: 'string'
    ssoClientId: 'string'
    ssoClientSecretKeyVaultPath: 'string'
    ssoSecretType: 'string'
    startVMOnConnect: bool
    validationEnvironment: bool
    vmTemplate: 'string'
  }
}

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

hostPools

Имя Описание Значение
name имя ресурса. строка (обязательно)

Ограничение символов: 3–64

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания, точки и дефисы.

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

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

HostPoolProperties

Имя Описание Значение
agentUpdate Конфигурация узла сеансов для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
customRdpProperty Настраиваемое свойство rdp объекта HostPool. строка
description Описание HostPool. строка
friendlyName Понятное имя HostPool. строка
hostPoolType Тип HostPool для настольных компьютеров. 'BYODesktop'
"Персональный"
Pooled (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. 'BreadthFirst'
DepthFirst
Persistent (обязательно)
managementType Тип управления для этого пула узлов, автоматизированного или стандартного. Значение по умолчанию — Автоматизировано. "Автоматизированный"
"Стандартный"
maxSessionLimit Максимальное количество сеансов для HostPool. INT
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматический"
'Direct'
preferredAppGroupType Тип предпочтительной группы приложений, по умолчанию — Группа классических приложений. "Рабочий стол"
"Нет"
RailApplications (обязательно)
publicNetworkAccess Включено позволяет получить доступ к этому ресурсу как из общедоступных, так и из частных сетей. Значение Отключено разрешает доступ к этому ресурсу только через частные конечные точки. "Отключено"
"Включено"
EnabledForClientsOnly
EnabledForSessionHostsOnly
registrationInfo Сведения о регистрации HostPool. RegistrationInfo
звонить Номер круга HostPool. INT
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD. строка
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. строка
ssoClientSecretKeyVaultPath Путь к Azure Key Vault, в котором хранится секрет, используемый для обмена данными с ADFS. строка
ssoSecretType Тип единого входа для типа секрета. "Certificate"
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault
startVMOnConnect Флаг для включения или отключения функции StartVMOnConnect. bool
validationEnvironment Среда проверки. bool
vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в пуле узлов. строка

AgentUpdateProperties

Имя Описание Значение
maintenanceWindows Список периодов обслуживания. Период обслуживания составляет 2 часа. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Часовой пояс для обслуживания, как определено в разделе https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid Должно быть задано, если параметр useLocalTime имеет значение true. строка
type Тип обслуживания компонентов узла сеансов. 'Default'
"Запланировано"
useSessionHostLocalTime Следует ли использовать localTime виртуальной машины. bool

MaintenanceWindowProperties

Имя Описание Значение
dayOfWeek День недели. "Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
hour Час начала обновления в день. (0 - 23) INT

RegistrationInfo

Имя Описание Значение
expirationTime; Срок действия маркера регистрации. строка
registrationTokenOperation Тип сброса маркера. "Удалить"
"Нет"
"Обновить"
token Строка маркера регистрации в кодировке Base64. строка

ResourceModelWithAllowedPropertySetSku

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

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

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

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

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

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2023-11-01-preview",
  "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": {
    "agentUpdate": {
      "maintenanceWindows": [
        {
          "dayOfWeek": "string",
          "hour": "int"
        }
      ],
      "maintenanceWindowTimeZone": "string",
      "type": "string",
      "useSessionHostLocalTime": "bool"
    },
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "publicNetworkAccess": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "ring": "int",
    "ssoadfsAuthority": "string",
    "ssoClientId": "string",
    "ssoClientSecretKeyVaultPath": "string",
    "ssoSecretType": "string",
    "startVMOnConnect": "bool",
    "validationEnvironment": "bool",
    "vmTemplate": "string"
  }
}

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

hostPools

Имя Описание Значение
тип Тип ресурса Microsoft.DesktopVirtualization/hostPools
версия_API Версия API ресурсов '2023-11-01-preview'
name имя ресурса. строка (обязательно)

Ограничение символов: 3–64

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания, точки и дефисы.

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

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

HostPoolProperties

Имя Описание Значение
agentUpdate Конфигурация узла сеансов для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
customRdpProperty Настраиваемое свойство rdp объекта HostPool. строка
description Описание HostPool. строка
friendlyName Понятное имя HostPool. строка
hostPoolType Тип HostPool для настольных компьютеров. 'BYODesktop'
"Персональный"
Pooled (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. 'BreadthFirst'
DepthFirst
Persistent (обязательно)
managementType Тип управления для этого пула узлов, автоматизированного или стандартного. Значение по умолчанию — Автоматизировано. "Автоматизированный"
"Стандартный"
maxSessionLimit Максимальное количество сеансов для HostPool. INT
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматический"
'Direct'
preferredAppGroupType Тип предпочтительной группы приложений, по умолчанию — Группа классических приложений. "Рабочий стол"
"Нет"
RailApplications (обязательно)
publicNetworkAccess Включено позволяет получить доступ к этому ресурсу как из общедоступных, так и из частных сетей. Значение Отключено разрешает доступ к этому ресурсу только через частные конечные точки. "Отключено"
"Включено"
EnabledForClientsOnly
EnabledForSessionHostsOnly
registrationInfo Сведения о регистрации HostPool. RegistrationInfo
звонить Номер круга HostPool. INT
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD. строка
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. строка
ssoClientSecretKeyVaultPath Путь к Azure Key Vault, в котором хранится секрет, используемый для обмена данными с ADFS. строка
ssoSecretType Тип единого входа для типа секрета. "Сертификат"
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault
startVMOnConnect Флаг для включения или отключения функции StartVMOnConnect. bool
validationEnvironment Среда проверки. bool
vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в пуле узлов. строка

AgentUpdateProperties

Имя Описание Значение
maintenanceWindows Список периодов обслуживания. Период обслуживания составляет 2 часа. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Часовой пояс для обслуживания, определенный в https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid разделе Должен быть задан, если параметр useLocalTime имеет значение true. строка
type Тип обслуживания компонентов узла сеансов. 'Default'
"Запланировано"
useSessionHostLocalTime Указывает, следует ли использовать localTime виртуальной машины. bool

MaintenanceWindowProperties

Имя Описание Значение
dayOfWeek День недели. "Пятница"
"Понедельник"
'Суббота'
'Воскресенье'
"Четверг"
"Вторник"
"Среда"
hour Час начала обновления в день. (0 - 23) INT

RegistrationInfo

Имя Описание Значение
expirationTime; Срок действия маркера регистрации. строка
registrationTokenOperation Тип сброса маркера. "Удалить"
"Нет"
"Обновить"
token Строка в кодировке Base64 маркера регистрации. строка

ResourceModelWithAllowedPropertySetSku

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview"
  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 = {
      agentUpdate = {
        maintenanceWindows = [
          {
            dayOfWeek = "string"
            hour = int
          }
        ]
        maintenanceWindowTimeZone = "string"
        type = "string"
        useSessionHostLocalTime = bool
      }
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managementType = "string"
      maxSessionLimit = int
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      publicNetworkAccess = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      ring = int
      ssoadfsAuthority = "string"
      ssoClientId = "string"
      ssoClientSecretKeyVaultPath = "string"
      ssoSecretType = "string"
      startVMOnConnect = bool
      validationEnvironment = bool
      vmTemplate = "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"
    }
  })
}

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

HostPools

Имя Описание Значение
тип Тип ресурса "Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview"
name имя ресурса. string (обязательно)

Ограничение символов: 3-64

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания, точки и дефисы.

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

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

HostPoolProperties

Имя Описание Значение
agentUpdate Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
customRdpProperty Настраиваемое свойство rdp объекта HostPool. строка
description Описание HostPool. строка
friendlyName Понятное имя HostPool. строка
hostPoolType Тип hostPool для рабочего стола. "BYODesktop"
"Персональный"
Pooled (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. "BreadthFirst"
"DepthFirst"
"Persistent" (обязательно)
managementType Тип управления для этого пула узлов— автоматизированный или стандартный. Значение по умолчанию — Автоматизировано. "Автоматизировано"
"Стандартный"
maxSessionLimit Максимальное количество сеансов для HostPool. INT
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматический"
"Direct"
preferredAppGroupType Тип предпочтительной группы приложений, по умолчанию — Группа классических приложений. "Рабочий стол"
"None"
"RailApplications" (обязательно)
publicNetworkAccess Включена возможность доступа к этому ресурсу как из общедоступных, так и из частных сетей. Отключено разрешает доступ к этому ресурсу только через частные конечные точки. "Отключено"
"Включено"
EnabledForClientsOnly
EnabledForSessionHostsOnly
registrationInfo Сведения о регистрации HostPool. RegistrationInfo
звонить Номер круга HostPool. INT
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписи сертификатов единого входа WVD. строка
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. строка
ssoClientSecretKeyVaultPath Путь к Хранилищу ключей Azure, в котором хранится секрет, используемый для обмена данными с ADFS. строка
ssoSecretType Тип единого входа для типа секрета. "Certificate"
CertificateInKeyVault
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect Флаг для включения или отключения функции StartVMOnConnect. bool
validationEnvironment Среда проверки. bool
vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в пуле узлов. строка

AgentUpdateProperties

Имя Описание Значение
maintenanceWindows Список периодов обслуживания. Период обслуживания составляет 2 часа. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Часовой пояс для обслуживания, определенный в https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid разделе Должен быть задан, если параметр useLocalTime имеет значение true. строка
type Тип обслуживания компонентов узла сеансов. "По умолчанию"
"Запланировано"
useSessionHostLocalTime Указывает, следует ли использовать localTime виртуальной машины. bool

MaintenanceWindowProperties

Имя Описание Значение
dayOfWeek День недели. Пятница
Понедельник
Суббота
Воскресенье
Четверг
Вторник
Среда
hour Час начала обновления в день. (0 - 23) INT

RegistrationInfo

Имя Описание Значение
expirationTime; Срок действия маркера регистрации. строка
registrationTokenOperation Тип сброса маркера. "Удалить"
"None"
"Обновить"
token Строка в кодировке Base64 маркера регистрации. строка

ResourceModelWithAllowedPropertySetSku

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