Microsoft.DesktopVirtualization hostPools 2020-10-19-preview

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    ring: int
    ssoadfsAuthority: 'string'
    ssoClientId: 'string'
    ssoClientSecretKeyVaultPath: 'string'
    ssoContext: 'string'
    ssoSecretType: 'string'
    validationEnvironment: bool
    vmTemplate: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Подробные свойства для HostPool HostPoolProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

Свойства HostPool

Имя Описание Ценность
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
описание Описание HostPool. струна
дружественноеИмя Понятное имя HostPool. струна
hostPoolType Тип HostPool для рабочего стола. "Персональный"
Pooled (обязательный)
loadBalancerType Тип подсистемы балансировки нагрузки. "BreadthFirst"
«Глубина прежде всего»
"Постоянный" (обязательный)
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматически"
«Прямой»
preferredAppGroupType Тип предпочитаемой группы приложений по умолчанию — группа классических приложений "Desktop"
"Нет"
RailApplications (обязательный)
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS. струна
ssoКонтекст Путь к keyvault, содержащий секрет ssoContext. струна
ssoSecretType Тип единого входа в Secret Type. "Сертификат"
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault
validationEnvironment Среда проверки. булевая переменная (bool)
Шаблон vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в hostpool. струна

Информация о регистрации

Имя Описание Ценность
dateTime Время окончания срока действия маркера регистрации. струна
registrationTokenOperation Тип сброса маркера. "Удалить"
"Нет"
Обновление
жетон Строка закодированного маркера регистрации base64. струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Примеры использования

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
пула узлов Виртуального рабочего стола Azure (AVD) Модуль ресурсов AVM для пула узлов виртуального рабочего стола Azure (AVD)

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
создание AVD с помощью присоединения к идентификатору Microsoft Entra Этот шаблон позволяет создавать ресурсы Виртуального рабочего стола Azure, такие как пул узлов, группа приложений, рабочая область, узел тестового сеанса и его расширения с присоединением к идентификатору Microsoft Entra ID

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

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

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

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

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2020-10-19-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "ring": "int",
    "ssoadfsAuthority": "string",
    "ssoClientId": "string",
    "ssoClientSecretKeyVaultPath": "string",
    "ssoContext": "string",
    "ssoSecretType": "string",
    "validationEnvironment": "bool",
    "vmTemplate": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
apiVersion Версия API '2020-10-19-превью'
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Подробные свойства для HostPool HostPoolProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DesktopVirtualization/hostPools"

Свойства HostPool

Имя Описание Ценность
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
описание Описание HostPool. струна
дружественноеИмя Понятное имя HostPool. струна
hostPoolType Тип HostPool для рабочего стола. "Персональный"
Pooled (обязательный)
loadBalancerType Тип подсистемы балансировки нагрузки. "BreadthFirst"
«Глубина прежде всего»
"Постоянный" (обязательный)
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматически"
«Прямой»
preferredAppGroupType Тип предпочитаемой группы приложений по умолчанию — группа классических приложений "Desktop"
"Нет"
RailApplications (обязательный)
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS. струна
ssoКонтекст Путь к keyvault, содержащий секрет ssoContext. струна
ssoSecretType Тип единого входа в Secret Type. "Сертификат"
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault
validationEnvironment Среда проверки. булевая переменная (bool)
Шаблон vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в hostpool. струна

Информация о регистрации

Имя Описание Ценность
dateTime Время окончания срока действия маркера регистрации. струна
registrationTokenOperation Тип сброса маркера. "Удалить"
"Нет"
Обновление
жетон Строка закодированного маркера регистрации base64. струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
создание AVD с помощью присоединения к идентификатору Microsoft Entra

развертывание в Azure
Этот шаблон позволяет создавать ресурсы Виртуального рабочего стола Azure, такие как пул узлов, группа приложений, рабочая область, узел тестового сеанса и его расширения с присоединением к идентификатору Microsoft Entra ID

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      ring = int
      ssoadfsAuthority = "string"
      ssoClientId = "string"
      ssoClientSecretKeyVaultPath = "string"
      ssoContext = "string"
      ssoSecretType = "string"
      validationEnvironment = bool
      vmTemplate = "string"
    }
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Подробные свойства для HostPool HostPoolProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview"

Свойства HostPool

Имя Описание Ценность
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
описание Описание HostPool. струна
дружественноеИмя Понятное имя HostPool. струна
hostPoolType Тип HostPool для рабочего стола. "Персональный"
Pooled (обязательный)
loadBalancerType Тип подсистемы балансировки нагрузки. "BreadthFirst"
«Глубина прежде всего»
"Постоянный" (обязательный)
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
personalDesktopAssignmentType Тип PersonalDesktopAssignment для HostPool. "Автоматически"
«Прямой»
preferredAppGroupType Тип предпочитаемой группы приложений по умолчанию — группа классических приложений "Desktop"
"Нет"
RailApplications (обязательный)
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS. струна
ssoКонтекст Путь к keyvault, содержащий секрет ssoContext. струна
ssoSecretType Тип единого входа в Secret Type. "Сертификат"
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault
validationEnvironment Среда проверки. булевая переменная (bool)
Шаблон vmTemplate Шаблон виртуальной машины для конфигурации sessionhosts в hostpool. струна

Информация о регистрации

Имя Описание Ценность
dateTime Время окончания срока действия маркера регистрации. струна
registrationTokenOperation Тип сброса маркера. "Удалить"
"Нет"
Обновление
жетон Строка закодированного маркера регистрации base64. струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Примеры использования

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
пула узлов Виртуального рабочего стола Azure (AVD) Модуль ресурсов AVM для пула узлов виртуального рабочего стола Azure (AVD)