Microsoft.DesktopВиртуализация хостПулы 2021-07-12

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

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

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

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

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2021-07-12' = {
  identity: {
    type: 'SystemAssigned'
  }
  kind: 'string'
  location: 'string'
  managedBy: 'string'
  name: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    migrationRequest: {
      migrationPath: 'string'
      operation: 'string'
    }
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
тождество ResourceModelWithAllowedPropertySetIdentity
добрый Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. струна

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

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

Свойства HostPool

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

MigrationRequestProperties (Свойства MigrationRequestProperties)

Имя Описание Ценность
миграционный путь Путь к устаревшей объекту для миграции. струна
операция Тип операции миграции. "Завершено"
"Скрыть"
"Отозвать"
"Пуск"
"Unhide"

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

Имя Описание Ценность
имя Определяемое пользователем имя 3-й партии Артефакт, который приобретается. строка (обязательно)
продукт 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. строка (обязательно)
промокод Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. струна
издатель Издатель 3-й партии артефакт, который покупается. Например, NewRelic строка (обязательно)
Версия Версия требуемого продукта или артефакта. струна

ResourceModelWithAllowedPropertySetSku

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

ResourceModelWithAllowedPropertySetTags

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

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

Проверенные модули 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": "2021-07-12",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "kind": "string",
  "location": "string",
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "migrationRequest": {
      "migrationPath": "string",
      "operation": "string"
    },
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
apiVersion Версия API '2021-07-12'
тождество ResourceModelWithAllowedPropertySetIdentity
добрый Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. струна

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

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

Свойства HostPool

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

MigrationRequestProperties (Свойства MigrationRequestProperties)

Имя Описание Ценность
миграционный путь Путь к устаревшей объекту для миграции. струна
операция Тип операции миграции. "Завершено"
"Скрыть"
"Отозвать"
"Пуск"
"Unhide"

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

Имя Описание Ценность
имя Определяемое пользователем имя 3-й партии Артефакт, который приобретается. строка (обязательно)
продукт 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. строка (обязательно)
промокод Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. струна
издатель Издатель 3-й партии артефакт, который покупается. Например, NewRelic строка (обязательно)
Версия Версия требуемого продукта или артефакта. струна

ResourceModelWithAllowedPropertySetSku

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

ResourceModelWithAllowedPropertySetTags

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

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

Шаблоны быстрого запуска 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@2021-07-12"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      migrationRequest = {
        migrationPath = "string"
        operation = "string"
      }
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "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"
    }
  }
}

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

Microsoft.DesktopVirtualization/hostPools

Имя Описание Ценность
тождество ResourceModelWithAllowedPropertySetIdentity
добрый Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. струна

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

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 64 (обязательно)
план ResourceModelWithAllowedPropertySetPlan
свойства Подробные свойства для HostPool HostPoolProperties (обязательно)
SKU ResourceModelWithAllowedPropertySetSku
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DesktopVirtualization/hostPools@2021-07-12"

Свойства HostPool

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

MigrationRequestProperties (Свойства MigrationRequestProperties)

Имя Описание Ценность
миграционный путь Путь к устаревшей объекту для миграции. струна
операция Тип операции миграции. "Завершено"
"Скрыть"
"Отозвать"
"Пуск"
"Unhide"

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

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

ResourceModelWithAllowedPropertySetIdentity

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

ResourceModelWithAllowedPropertySetPlan

Имя Описание Ценность
имя Определяемое пользователем имя 3-й партии Артефакт, который приобретается. строка (обязательно)
продукт 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. строка (обязательно)
промокод Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. струна
издатель Издатель 3-й партии артефакт, который покупается. Например, NewRelic строка (обязательно)
Версия Версия требуемого продукта или артефакта. струна

ResourceModelWithAllowedPropertySetSku

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

ResourceModelWithAllowedPropertySetTags

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

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

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

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

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