Microsoft.DesktopVirtualization hostPools 2021-02-01-preview
Тип ресурса hostPools можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DesktopVirtualization/hostPools, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2021-02-01-preview' = {
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'
}
}
Имя | Описание | Ценность |
---|---|---|
customRdpProperty | Настраиваемое свойство rdp объекта HostPool. | струна |
описание | Описание HostPool. | струна |
friendlyName | Понятное имя HostPool. | струна |
hostPoolType | Тип HostPool для рабочего стола. | ByODesktop "Персональный" Pooled (обязательный) |
loadBalancerType | Тип подсистемы балансировки нагрузки. | "BreadthFirst" 'DepthFirst' "Постоянный" (обязательный) |
maxSessionLimit | Максимальное ограничение сеанса HostPool. | int |
migrationRequest | Сведения о регистрации HostPool. | MigrationRequestProperties |
personalDesktopAssignmentType | Тип PersonalDesktopAssignment для HostPool. | "Автоматически" 'Direct' |
preferredAppGroupType | Тип предпочитаемой группы приложений по умолчанию — группа классических приложений | "Desktop" "Нет" RailApplications (обязательный) |
registrationInfo | Сведения о регистрации HostPool. | RegistrationInfo |
кольцо | Номер кольца HostPool. | int |
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. | струна |
Имя | Описание | Ценность |
---|---|---|
тождество | ResourceModelWithAllowedPropertySetIdentity | |
добрый | Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. | струна Ограничения целостности: Pattern = ^[-\w\._,\(\)]+$ |
местоположение | Географическое расположение, в котором находится ресурс | струна |
managedBy | Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом. | струна |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 (обязательно) |
план | ResourceModelWithAllowedPropertySetPlan | |
свойства | Подробные свойства для HostPool | HostPoolProperties (обязательно) |
SKU | ResourceModelWithAllowedPropertySetSku | |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
Имя | Описание | Ценность |
---|---|---|
migrationPath | Путь к устаревшей объекту для миграции. | струна |
операция | Тип операции миграции. | "Завершено" "Скрыть" "Отозвать" "Пуск" "Unhide" |
Имя | Описание | Ценность |
---|---|---|
dateTime | Время окончания срока действия маркера регистрации. | струна |
registrationTokenOperation | Тип сброса маркера. | "Удалить" "Нет" Обновление |
жетон | Строка закодированного маркера регистрации base64. | струна |
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения. | SystemAssigned |
Имя | Описание | Ценность |
---|---|---|
имя | Определяемое пользователем имя 3-й партии Артефакт, который приобретается. | строка (обязательно) |
продукт | 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. | строка (обязательно) |
промокод | Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. | струна |
издатель | Издатель 3-й партии артефакт, который покупается. Например, NewRelic | строка (обязательно) |
Версия | Версия требуемого продукта или артефакта. | струна |
Имя | Описание | Ценность |
---|---|---|
способность | Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. | int |
семья | Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. | струна |
имя | Имя номера SKU. Ex - P3. Обычно это код буквы и числа | строка (обязательно) |
размер | Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. | струна |
ярус | Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. | "Базовый" "Бесплатный" "Премиум" "Стандартный" |
Имя | Описание | Ценность |
---|
Следующие примеры краткого руководства по развертыванию этого типа ресурса.
Bicep-файл | Описание |
---|---|
создание AVD с помощью присоединения к идентификатору Microsoft Entra | Этот шаблон позволяет создавать ресурсы Виртуального рабочего стола Azure, такие как пул узлов, группа приложений, рабочая область, узел тестового сеанса и его расширения с присоединением к идентификатору Microsoft Entra ID |
Тип ресурса hostPools можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DesktopVirtualization/hostPools, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2021-02-01-preview",
"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"
}
}
Имя | Описание | Ценность |
---|---|---|
customRdpProperty | Настраиваемое свойство rdp объекта HostPool. | струна |
описание | Описание HostPool. | струна |
friendlyName | Понятное имя HostPool. | струна |
hostPoolType | Тип HostPool для рабочего стола. | ByODesktop "Персональный" Pooled (обязательный) |
loadBalancerType | Тип подсистемы балансировки нагрузки. | "BreadthFirst" 'DepthFirst' "Постоянный" (обязательный) |
maxSessionLimit | Максимальное ограничение сеанса HostPool. | int |
migrationRequest | Сведения о регистрации HostPool. | MigrationRequestProperties |
personalDesktopAssignmentType | Тип PersonalDesktopAssignment для HostPool. | "Автоматически" 'Direct' |
preferredAppGroupType | Тип предпочитаемой группы приложений по умолчанию — группа классических приложений | "Desktop" "Нет" RailApplications (обязательный) |
registrationInfo | Сведения о регистрации HostPool. | RegistrationInfo |
кольцо | Номер кольца HostPool. | int |
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. | струна |
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2021-02-01-preview' |
тождество | ResourceModelWithAllowedPropertySetIdentity | |
добрый | Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. | струна Ограничения целостности: Pattern = ^[-\w\._,\(\)]+$ |
местоположение | Географическое расположение, в котором находится ресурс | струна |
managedBy | Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом. | струна |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 (обязательно) |
план | ResourceModelWithAllowedPropertySetPlan | |
свойства | Подробные свойства для HostPool | HostPoolProperties (обязательно) |
SKU | ResourceModelWithAllowedPropertySetSku | |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
тип | Тип ресурса | "Microsoft.DesktopVirtualization/hostPools" |
Имя | Описание | Ценность |
---|---|---|
migrationPath | Путь к устаревшей объекту для миграции. | струна |
операция | Тип операции миграции. | "Завершено" "Скрыть" "Отозвать" "Пуск" "Unhide" |
Имя | Описание | Ценность |
---|---|---|
dateTime | Время окончания срока действия маркера регистрации. | струна |
registrationTokenOperation | Тип сброса маркера. | "Удалить" "Нет" Обновление |
жетон | Строка закодированного маркера регистрации base64. | струна |
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения. | SystemAssigned |
Имя | Описание | Ценность |
---|---|---|
имя | Определяемое пользователем имя 3-й партии Артефакт, который приобретается. | строка (обязательно) |
продукт | 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. | строка (обязательно) |
промокод | Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. | струна |
издатель | Издатель 3-й партии артефакт, который покупается. Например, NewRelic | строка (обязательно) |
Версия | Версия требуемого продукта или артефакта. | струна |
Имя | Описание | Ценность |
---|---|---|
способность | Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. | int |
семья | Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. | струна |
имя | Имя номера SKU. Ex - P3. Обычно это код буквы и числа | строка (обязательно) |
размер | Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. | струна |
ярус | Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. | "Базовый" "Бесплатный" "Премиум" "Стандартный" |
Имя | Описание | Ценность |
---|
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
создание AVD с помощью присоединения к идентификатору Microsoft Entra развертывание |
Этот шаблон позволяет создавать ресурсы Виртуального рабочего стола Azure, такие как пул узлов, группа приложений, рабочая область, узел тестового сеанса и его расширения с присоединением к идентификатору Microsoft Entra ID |
Тип ресурса hostPools можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DesktopVirtualization/hostPools, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools@2021-02-01-preview"
name = "string"
identity = {
type = "SystemAssigned"
}
kind = "string"
location = "string"
managedBy = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
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"
}
})
}
Имя | Описание | Ценность |
---|---|---|
customRdpProperty | Настраиваемое свойство rdp объекта HostPool. | струна |
описание | Описание HostPool. | струна |
friendlyName | Понятное имя HostPool. | струна |
hostPoolType | Тип HostPool для рабочего стола. | ByODesktop "Персональный" Pooled (обязательный) |
loadBalancerType | Тип подсистемы балансировки нагрузки. | "BreadthFirst" 'DepthFirst' "Постоянный" (обязательный) |
maxSessionLimit | Максимальное ограничение сеанса HostPool. | int |
migrationRequest | Сведения о регистрации HostPool. | MigrationRequestProperties |
personalDesktopAssignmentType | Тип PersonalDesktopAssignment для HostPool. | "Автоматически" 'Direct' |
preferredAppGroupType | Тип предпочитаемой группы приложений по умолчанию — группа классических приложений | "Desktop" "Нет" RailApplications (обязательный) |
registrationInfo | Сведения о регистрации HostPool. | RegistrationInfo |
кольцо | Номер кольца HostPool. | int |
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. | струна |
Имя | Описание | Ценность |
---|---|---|
тождество | ResourceModelWithAllowedPropertySetIdentity | |
добрый | Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение. | струна Ограничения целостности: Pattern = ^[-\w\._,\(\)]+$ |
местоположение | Географическое расположение, в котором находится ресурс | струна |
managedBy | Полный идентификатор ресурса ресурса, который управляет этим ресурсом. Указывает, управляется ли этот ресурс другим ресурсом Azure. В этом случае развертывание полного режима не удаляет ресурс, если он удаляется из шаблона, так как он управляется другим ресурсом. | струна |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 (обязательно) |
план | ResourceModelWithAllowedPropertySetPlan | |
свойства | Подробные свойства для HostPool | HostPoolProperties (обязательно) |
SKU | ResourceModelWithAllowedPropertySetSku | |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
тип | Тип ресурса | "Microsoft.DesktopVirtualization/hostPools@2021-02-01-preview" |
Имя | Описание | Ценность |
---|---|---|
migrationPath | Путь к устаревшей объекту для миграции. | струна |
операция | Тип операции миграции. | "Завершено" "Скрыть" "Отозвать" "Пуск" "Unhide" |
Имя | Описание | Ценность |
---|---|---|
dateTime | Время окончания срока действия маркера регистрации. | струна |
registrationTokenOperation | Тип сброса маркера. | "Удалить" "Нет" Обновление |
жетон | Строка закодированного маркера регистрации base64. | струна |
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения. | SystemAssigned |
Имя | Описание | Ценность |
---|---|---|
имя | Определяемое пользователем имя 3-й партии Артефакт, который приобретается. | строка (обязательно) |
продукт | 3-й партии артефакт, который приобретается. Например, NewRelic. Продукт сопоставляется с предложением, указанным для артефакта во время подключения рынка данных. | строка (обязательно) |
промокод | Издатель предоставил код повышения уровня, подготовленный в Data Market для указанного продукта или артефакта. | струна |
издатель | Издатель 3-й партии артефакт, который покупается. Например, NewRelic | строка (обязательно) |
Версия | Версия требуемого продукта или артефакта. | струна |
Имя | Описание | Ценность |
---|---|---|
способность | Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. | int |
семья | Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. | струна |
имя | Имя номера SKU. Ex - P3. Обычно это код буквы и числа | строка (обязательно) |
размер | Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код. | струна |
ярус | Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. | "Базовый" "Бесплатный" "Премиум" "Стандартный" |
Имя | Описание | Ценность |
---|