Microsoft.DesktopVirtualization hostPools 2025-09-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2025-09-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

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

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

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (обязательно)
план Сведения о плане ресурсов. План
properties Подробные свойства для HostPool HostPoolProperties (обязательно)
sku Номер SKU (единица хранения запасов), назначенный этому ресурсу. Sku
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

AgentUpdateProperties

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

Свойства HostPool

Имя Description Ценность
agentUpdate Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link. 'Disabled'
'Enabled'
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
deploymentScope Тип DeploymentScope для HostPool. «Географический»
"Региональный"
описание Описание HostPool. струна
directUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
friendlyName Понятное имя HostPool. струна
hostPoolType Тип HostPool для настольных компьютеров. «BYODesktop»
"Персональный"
«Объединенный» (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. «Широта первая»
«Глубина прежде всего»
«МножественныйПостоянный»
«Постоянный» (обязательно)
управляемыйPrivateUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
тип управления Тип управления для данного пула узлов: автоматизированный или стандартный. Значение по умолчанию — Автоматически. "Автоматизировано"
'Standard'
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
oboTenantId Клиент, от имени которого запрашивается ресурс. струна
personalDesktopAssignmentType PersonalDesktopAssignment для HostPool. 'Automatic'
'Direct'
preferredAppGroupType Тип предпочитаемой группы приложений, по умолчанию Группа приложений для настольных ПК 'Desktop'
'None'
'RailApplications' (обязательно)
доступ к публичной сети Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки. 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
релеUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписи сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемый для выпуска сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для связи с ADFS. струна
ssoSecretType Тип единого входа в Secret Type. 'Certificate'
«СертификатInKeyVault»
SharedKey
«SharedKeyInKeyVault»
startVMOnConnect Флаг для включения/выключения функции StartVMOnConnect. bool
validationEnvironment Это среда валидации. bool
Шаблон vmTemplate Шаблон виртуальной машины для настройки sessionhosts в пуле хостов. струна

MaintenanceWindowProperties

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Имя Description Ценность

Plan

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

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

Имя Description Ценность
время истечения срока Срок действия регистрационного токена. струна
registrationTokenOperation Тип сброса токена. 'Delete'
'None'
'Update'
token Токен регистрации base64 закодирован в строке. струна

Sku

Имя Description Ценность
capacity Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
family Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. струна
имя Имя номера SKU. Например, P3. Обычно это код буквы и числа строка (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. струна
tier Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Имя Description Ценность

UserAssignedIdentity

Имя Description Ценность

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

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

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

Модуль Description
Пул узлов Виртуального рабочего стола Azure (AVD) Ресурсный модуль AVM для пула узлов Виртуального рабочего стола Azure (AVD)

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2025-09-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

Имя Description Ценность
apiVersion Версия API «2025-09-01-превью»
identity Удостоверения управляемой службы, назначенные этому ресурсу. ManagedServiceIdentity
добрый Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. string

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

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (обязательно)
план Сведения о плане ресурсов. План
properties Подробные свойства для HostPool HostPoolProperties (обязательно)
sku Номер SKU (единица хранения запасов), назначенный этому ресурсу. Sku
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса «Microsoft.DesktopVirtualization/hostPools»

AgentUpdateProperties

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

Свойства HostPool

Имя Description Ценность
agentUpdate Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link. 'Disabled'
'Enabled'
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
deploymentScope Тип DeploymentScope для HostPool. «Географический»
"Региональный"
описание Описание HostPool. струна
directUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
friendlyName Понятное имя HostPool. струна
hostPoolType Тип HostPool для настольных компьютеров. «BYODesktop»
"Персональный"
«Объединенный» (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. «Широта первая»
«Глубина прежде всего»
«МножественныйПостоянный»
«Постоянный» (обязательно)
управляемыйPrivateUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
тип управления Тип управления для данного пула узлов: автоматизированный или стандартный. Значение по умолчанию — Автоматически. "Автоматизировано"
'Standard'
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
oboTenantId Клиент, от имени которого запрашивается ресурс. струна
personalDesktopAssignmentType PersonalDesktopAssignment для HostPool. 'Automatic'
'Direct'
preferredAppGroupType Тип предпочитаемой группы приложений, по умолчанию Группа приложений для настольных ПК 'Desktop'
'None'
'RailApplications' (обязательно)
доступ к публичной сети Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки. 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
релеUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписи сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемый для выпуска сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для связи с ADFS. струна
ssoSecretType Тип единого входа в Secret Type. 'Certificate'
«СертификатInKeyVault»
SharedKey
«SharedKeyInKeyVault»
startVMOnConnect Флаг для включения/выключения функции StartVMOnConnect. bool
validationEnvironment Это среда валидации. bool
Шаблон vmTemplate Шаблон виртуальной машины для настройки sessionhosts в пуле хостов. струна

MaintenanceWindowProperties

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Имя Description Ценность

Plan

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

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

Имя Description Ценность
время истечения срока Срок действия регистрационного токена. струна
registrationTokenOperation Тип сброса токена. 'Delete'
'None'
'Update'
token Токен регистрации base64 закодирован в строке. струна

Sku

Имя Description Ценность
capacity Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
family Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. струна
имя Имя номера SKU. Например, P3. Обычно это код буквы и числа строка (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. струна
tier Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Имя Description Ценность

UserAssignedIdentity

Имя Description Ценность

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

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

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

Template Description
создание AVD с помощью присоединения к идентификатору Microsoft Entra

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2025-09-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

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

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

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (обязательно)
план Сведения о плане ресурсов. План
properties Подробные свойства для HostPool HostPoolProperties (обязательно)
sku Номер SKU (единица хранения запасов), назначенный этому ресурсу. Sku
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.DesktopVirtualization/hostPools@2025-09-01-preview"

AgentUpdateProperties

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

Свойства HostPool

Имя Description Ценность
agentUpdate Конфигурация узла сеанса для обновления агента, агента мониторинга и компонента стека. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Контролирует, разрешено ли использование транспорта RDPShortPath, возможно, в обход маршрутов Private Link. 'Disabled'
'Enabled'
customRdpProperty Настраиваемое свойство rdp объекта HostPool. струна
deploymentScope Тип DeploymentScope для HostPool. «Географический»
"Региональный"
описание Описание HostPool. струна
directUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
friendlyName Понятное имя HostPool. струна
hostPoolType Тип HostPool для настольных компьютеров. «BYODesktop»
"Персональный"
«Объединенный» (обязательно)
loadBalancerType Тип подсистемы балансировки нагрузки. «Широта первая»
«Глубина прежде всего»
«МножественныйПостоянный»
«Постоянный» (обязательно)
управляемыйPrivateUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
тип управления Тип управления для данного пула узлов: автоматизированный или стандартный. Значение по умолчанию — Автоматически. "Автоматизировано"
'Standard'
maxSessionLimit Максимальное ограничение сеанса HostPool. инт
oboTenantId Клиент, от имени которого запрашивается ресурс. струна
personalDesktopAssignmentType PersonalDesktopAssignment для HostPool. 'Automatic'
'Direct'
preferredAppGroupType Тип предпочитаемой группы приложений, по умолчанию Группа приложений для настольных ПК 'Desktop'
'None'
'RailApplications' (обязательно)
доступ к публичной сети Включена возможность доступа к этому ресурсу как из общедоступных, так и частных сетей, отключена возможность доступа к этому ресурсу только через частные конечные точки. 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
регистрацияИнфо Сведения о регистрации HostPool. Информация о регистрации
релеUDP По умолчанию: для определения доступности подключения используются настройки на уровне AVD, Включено: UDP будет пытаться установить этот тип соединения при выполнении подключений. Это означает, что данное соединение возможно, но не гарантируется, так как существуют другие факторы, которые могут препятствовать этому типу соединения, Отключено: UDP не будет пытаться использовать этот тип соединения при выполнении соединений По умолчанию
'Disabled'
'Enabled'
кольцо Номер кольца HostPool. инт
ssoadfsAuthority URL-адрес сервера ADFS клиента для подписи сертификатов единого входа WVD. струна
ssoClientId ClientId для зарегистрированной проверяющей стороны, используемый для выпуска сертификатов единого входа WVD. струна
ssoClientSecretKeyVaultPath Путь к Azure KeyVault, в котором хранится секрет, используемый для связи с ADFS. струна
ssoSecretType Тип единого входа в Secret Type. 'Certificate'
«СертификатInKeyVault»
SharedKey
«SharedKeyInKeyVault»
startVMOnConnect Флаг для включения/выключения функции StartVMOnConnect. bool
validationEnvironment Это среда валидации. bool
Шаблон vmTemplate Шаблон виртуальной машины для настройки sessionhosts в пуле хостов. струна

MaintenanceWindowProperties

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Имя Description Ценность

Plan

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

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

Имя Description Ценность
время истечения срока Срок действия регистрационного токена. струна
registrationTokenOperation Тип сброса токена. 'Delete'
'None'
'Update'
token Токен регистрации base64 закодирован в строке. струна

Sku

Имя Description Ценность
capacity Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
family Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. струна
имя Имя номера SKU. Например, P3. Обычно это код буквы и числа строка (обязательно)
size Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. струна
tier Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Имя Description Ценность

UserAssignedIdentity

Имя Description Ценность

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

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

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

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