Microsoft.DesktopVirtualization hostPools

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2026-01-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  managedBy: 'string'
  name: '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
    }
    allowRDPShortPathWithPrivateLink: 'string'
    customRdpProperty: 'string'
    deploymentScope: 'string'
    description: 'string'
    directUDP: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managedPrivateUDP: 'string'
    managementType: 'string'
    maxSessionLimit: int
    oboTenantId: 'string'
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    publicNetworkAccess: 'string'
    publicUDP: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    relayUDP: '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

Имя	Описание	Ценность
тождество	Удостоверения управляемой службы, назначенные этому ресурсу.	ManagedServiceIdentity (Управляемый сервисИдентификация)
добрый	Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение.	струна Ограничения целостности: Шаблон = `^[-\w\._,]+$`
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
managedBy	Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 64 Pattern = `^[A-Za-z0-9@.\-_ ]*$` (обязательно)
план	Сведения о плане ресурсов.	плана
свойства	Подробные свойства для HostPool	HostPoolProperties (обязательно)
SKU	Номер SKU (единица хранения запасов), назначенный этому ресурсу.	SKU
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах

AgentUpdateProperties

Имя	Описание	Ценность
maintenanceWindows	Список окон обслуживания. Срок обслуживания составляет 2 часа.	MaintenanceWindowProperties[]
maintenanceWindowTimeZone	Часовой пояс для обслуживания, определенный в файле /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Необходимо задать, если значение useLocalTime имеет значение true.	струна
тип	Тип обслуживания компонентов узла сеанса.	По умолчанию "Запланировано"
useSessionHostLocalTime	Следует ли использовать localTime виртуальной машины.	булевая переменная (bool)

Свойства HostPool

Имя	Описание	Ценность
agentUpdate	Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека.	AgentUpdateProperties
allowRDPShortPathWithPrivateLink	Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link.	"Отключено" "Включено"
customRdpProperty	Настраиваемое свойство rdp объекта HostPool.	струна
deploymentScope	Тип DeploymentScope для HostPool.	«Географический» "Региональный"
описание	Описание HostPool.	струна
directUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
дружественноеИмя	Понятное имя HostPool.	струна
hostPoolType	Тип HostPool для рабочего стола.	ByODesktop "Персональный" Pooled (обязательный)
loadBalancerType	Тип подсистемы балансировки нагрузки.	"BreadthFirst" «Глубина прежде всего» "MultiplePersistent" "Постоянный" (обязательный)
управляемыйPrivateUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
тип управления	Тип управления для этого узла, автоматизированного или стандартного. Значение по умолчанию — "Автоматизировано".	"Автоматизировано" "Стандартный"
maxSessionLimit	Максимальное ограничение сеанса HostPool.	инт
oboTenantId	Клиент, от имени которого запрашивается ресурс.	струна
personalDesktopAssignmentType	Тип PersonalDesktopAssignment для HostPool.	"Автоматически" «Прямой»
preferredAppGroupType	Тип предпочитаемой группы приложений по умолчанию — группа классических приложений	"Desktop" "Нет" RailApplications (обязательный)
доступ к публичной сети	Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки.	"Отключено" "Включено" "EnabledForClientsOnly" "EnabledForSessionHostsOnly"
publicUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
регистрацияИнфо	Сведения о регистрации HostPool.	Информация о регистрации
релеUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
кольцо	Номер кольца 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.	струна

MaintenanceWindowProperties

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

Управляемая служебная идентичность

Имя	Описание	Ценность
тип	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).	"Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем	Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

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

План

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

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

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

Артикул

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

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

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

Пользовательская назначенная идентичность

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

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

Проверенные модули 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": "2026-01-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "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"
    },
    "allowRDPShortPathWithPrivateLink": "string",
    "customRdpProperty": "string",
    "deploymentScope": "string",
    "description": "string",
    "directUDP": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managedPrivateUDP": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "oboTenantId": "string",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "publicNetworkAccess": "string",
    "publicUDP": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "relayUDP": "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	«2026-01-01-превью»
тождество	Удостоверения управляемой службы, назначенные этому ресурсу.	ManagedServiceIdentity (Управляемый сервисИдентификация)
добрый	Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение.	струна Ограничения целостности: Шаблон = `^[-\w\._,]+$`
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
managedBy	Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 64 Pattern = `^[A-Za-z0-9@.\-_ ]*$` (обязательно)
план	Сведения о плане ресурсов.	плана
свойства	Подробные свойства для HostPool	HostPoolProperties (обязательно)
SKU	Номер SKU (единица хранения запасов), назначенный этому ресурсу.	SKU
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.DesktopVirtualization/hostPools"

AgentUpdateProperties

Имя	Описание	Ценность
maintenanceWindows	Список окон обслуживания. Срок обслуживания составляет 2 часа.	MaintenanceWindowProperties[]
maintenanceWindowTimeZone	Часовой пояс для обслуживания, определенный в файле /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Необходимо задать, если значение useLocalTime имеет значение true.	струна
тип	Тип обслуживания компонентов узла сеанса.	По умолчанию "Запланировано"
useSessionHostLocalTime	Следует ли использовать localTime виртуальной машины.	булевая переменная (bool)

Свойства HostPool

Имя	Описание	Ценность
agentUpdate	Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека.	AgentUpdateProperties
allowRDPShortPathWithPrivateLink	Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link.	"Отключено" "Включено"
customRdpProperty	Настраиваемое свойство rdp объекта HostPool.	струна
deploymentScope	Тип DeploymentScope для HostPool.	«Географический» "Региональный"
описание	Описание HostPool.	струна
directUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
дружественноеИмя	Понятное имя HostPool.	струна
hostPoolType	Тип HostPool для рабочего стола.	ByODesktop "Персональный" Pooled (обязательный)
loadBalancerType	Тип подсистемы балансировки нагрузки.	"BreadthFirst" «Глубина прежде всего» "MultiplePersistent" "Постоянный" (обязательный)
управляемыйPrivateUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
тип управления	Тип управления для этого узла, автоматизированного или стандартного. Значение по умолчанию — "Автоматизировано".	"Автоматизировано" "Стандартный"
maxSessionLimit	Максимальное ограничение сеанса HostPool.	инт
oboTenantId	Клиент, от имени которого запрашивается ресурс.	струна
personalDesktopAssignmentType	Тип PersonalDesktopAssignment для HostPool.	"Автоматически" «Прямой»
preferredAppGroupType	Тип предпочитаемой группы приложений по умолчанию — группа классических приложений	"Desktop" "Нет" RailApplications (обязательный)
доступ к публичной сети	Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки.	"Отключено" "Включено" "EnabledForClientsOnly" "EnabledForSessionHostsOnly"
publicUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
регистрацияИнфо	Сведения о регистрации HostPool.	Информация о регистрации
релеUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
кольцо	Номер кольца 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.	струна

MaintenanceWindowProperties

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

Управляемая служебная идентичность

Имя	Описание	Ценность
тип	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).	"Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем	Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

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

План

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

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

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

Артикул

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

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

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

Пользовательская назначенная идентичность

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

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2026-01-01-preview"
  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 = {
      agentUpdate = {
        maintenanceWindows = [
          {
            dayOfWeek = "string"
            hour = int
          }
        ]
        maintenanceWindowTimeZone = "string"
        type = "string"
        useSessionHostLocalTime = bool
      }
      allowRDPShortPathWithPrivateLink = "string"
      customRdpProperty = "string"
      deploymentScope = "string"
      description = "string"
      directUDP = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managedPrivateUDP = "string"
      managementType = "string"
      maxSessionLimit = int
      oboTenantId = "string"
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      publicNetworkAccess = "string"
      publicUDP = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      relayUDP = "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

Имя	Описание	Ценность
тождество	Удостоверения управляемой службы, назначенные этому ресурсу.	ManagedServiceIdentity (Управляемый сервисИдентификация)
добрый	Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение.	струна Ограничения целостности: Шаблон = `^[-\w\._,]+$`
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
managedBy	Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 64 Pattern = `^[A-Za-z0-9@.\-_ ]*$` (обязательно)
план	Сведения о плане ресурсов.	плана
свойства	Подробные свойства для HostPool	HostPoolProperties (обязательно)
SKU	Номер SKU (единица хранения запасов), назначенный этому ресурсу.	SKU
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.DesktopVirtualization/hostPools@2026-01-01-preview"

AgentUpdateProperties

Имя	Описание	Ценность
maintenanceWindows	Список окон обслуживания. Срок обслуживания составляет 2 часа.	MaintenanceWindowProperties[]
maintenanceWindowTimeZone	Часовой пояс для обслуживания, определенный в файле /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Необходимо задать, если значение useLocalTime имеет значение true.	струна
тип	Тип обслуживания компонентов узла сеанса.	По умолчанию "Запланировано"
useSessionHostLocalTime	Следует ли использовать localTime виртуальной машины.	булевая переменная (bool)

Свойства HostPool

Имя	Описание	Ценность
agentUpdate	Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека.	AgentUpdateProperties
allowRDPShortPathWithPrivateLink	Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link.	"Отключено" "Включено"
customRdpProperty	Настраиваемое свойство rdp объекта HostPool.	струна
deploymentScope	Тип DeploymentScope для HostPool.	«Географический» "Региональный"
описание	Описание HostPool.	струна
directUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
дружественноеИмя	Понятное имя HostPool.	струна
hostPoolType	Тип HostPool для рабочего стола.	ByODesktop "Персональный" Pooled (обязательный)
loadBalancerType	Тип подсистемы балансировки нагрузки.	"BreadthFirst" «Глубина прежде всего» "MultiplePersistent" "Постоянный" (обязательный)
управляемыйPrivateUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
тип управления	Тип управления для этого узла, автоматизированного или стандартного. Значение по умолчанию — "Автоматизировано".	"Автоматизировано" "Стандартный"
maxSessionLimit	Максимальное ограничение сеанса HostPool.	инт
oboTenantId	Клиент, от имени которого запрашивается ресурс.	струна
personalDesktopAssignmentType	Тип PersonalDesktopAssignment для HostPool.	"Автоматически" «Прямой»
preferredAppGroupType	Тип предпочитаемой группы приложений по умолчанию — группа классических приложений	"Desktop" "Нет" RailApplications (обязательный)
доступ к публичной сети	Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки.	"Отключено" "Включено" "EnabledForClientsOnly" "EnabledForSessionHostsOnly"
publicUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
регистрацияИнфо	Сведения о регистрации HostPool.	Информация о регистрации
релеUDP	По умолчанию: параметры avd-wide используются для определения доступности подключения, включено: UDP попытается использовать этот тип подключения при создании подключений. Это означает, что это подключение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу подключения, отключен: UDP не будет пытаться использовать этот тип подключения при подключении.	По умолчанию "Отключено" "Включено"
кольцо	Номер кольца 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.	струна

MaintenanceWindowProperties

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

Управляемая служебная идентичность

Имя	Описание	Ценность
тип	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).	"Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем	Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

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

План

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

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

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

Артикул

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

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

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

Пользовательская назначенная идентичность

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

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

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

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

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

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2025-08-27

Microsoft.DesktopVirtualization hostPools

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

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

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

Microsoft.DesktopVirtualization/hostPools

AgentUpdateProperties

Свойства HostPool

MaintenanceWindowProperties

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

План

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

Артикул

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

Пользовательская назначенная идентичность

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

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

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

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

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

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

Microsoft.DesktopVirtualization/hostPools

AgentUpdateProperties

Свойства HostPool

MaintenanceWindowProperties

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

План

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

Артикул

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

Пользовательская назначенная идентичность

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

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

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

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

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

Microsoft.DesktopVirtualization/hostPools

AgentUpdateProperties

Свойства HostPool

MaintenanceWindowProperties

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

План

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

Артикул

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

Пользовательская назначенная идентичность

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

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

Обратная связь

Дополнительные ресурсы