你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DesktopVirtualization hostPools 2020-11-10-preview
- 最新
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2023-07-07-preview
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
- 2020-11-02-preview
- 2020-10-19-preview
- 2020-09-21-preview
- 2019-12-10-preview
- 2019-09-24-preview
- 2019-01-23-preview
Bicep 资源定义
hostPools 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
customRdpProperty: 'string'
description: 'string'
friendlyName: 'string'
hostPoolType: 'string'
loadBalancerType: 'string'
maxSessionLimit: int
personalDesktopAssignmentType: 'string'
preferredAppGroupType: 'string'
registrationInfo: {
expirationTime: 'string'
registrationTokenOperation: 'string'
token: 'string'
}
ring: int
ssoadfsAuthority: 'string'
ssoClientId: 'string'
ssoClientSecretKeyVaultPath: 'string'
ssoSecretType: 'string'
startVMOnConnect: bool
validationEnvironment: bool
vmTemplate: 'string'
}
}
属性值
hostPools
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 | 字符串 (必需) 字符限制：3-64 有效字符： 字母数字、下划线字符、句点和连字符。 以字母或数字开头。 以字母、数字或下划线结尾。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| 标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| properties | HostPool 的详细属性 | HostPoolProperties (必需) |
HostPoolProperties
| 名称 | 说明 | 值 |
|---|---|---|
| customRdpProperty | HostPool 的自定义 rdp 属性。 | 字符串 |
| description | HostPool 的说明。 | 字符串 |
| friendlyName | HostPool 的友好名称。 | 字符串 |
| hostPoolType | 适用于桌面的 HostPool 类型。 | “个人” “共用” (必需) |
| loadBalancerType | 负载均衡器的类型。 | “BreadthFirst” “DepthFirst” “持久性” (必需) |
| maxSessionLimit | HostPool 的最大会话限制。 | int |
| personalDesktopAssignmentType | HostPool 的 PersonalDesktopAssignment 类型。 | “自动” “Direct” |
| preferredAppGroupType | 首选应用程序组类型的类型，默认为桌面应用程序组 | “桌面” “None” “RailApplications” (必需) |
| registrationInfo | HostPool 的注册信息。 | RegistrationInfo |
| 铃声 | HostPool 的环号。 | int |
| ssoadfsAuthority | 用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。 | 字符串 |
| ssoClientId | 用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。 | 字符串 |
| ssoClientSecretKeyVaultPath | Azure KeyVault 存储用于与 ADFS 通信的机密的路径。 | 字符串 |
| ssoSecretType | 单一登录机密类型的类型。 | “证书” “CertificateInKeyVault” “SharedKey” “SharedKeyInKeyVault” |
| startVMOnConnect | 用于打开/关闭 StartVMOnConnect 功能的标志。 | bool |
| validationEnvironment | 是验证环境。 | bool |
| vmTemplate | 主机池中用于会话主机配置的 VM 模板。 | 字符串 |
RegistrationInfo
| 名称 | 说明 | 值 |
|---|---|---|
| expirationTime | 注册令牌的过期时间。 | 字符串 |
| registrationTokenOperation | 重置令牌的类型。 | “Delete” “None” “Update” |
| 令牌 | 注册令牌 base64 编码字符串。 | 字符串 |
ARM 模板资源定义
hostPools 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2020-11-10-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"customRdpProperty": "string",
"description": "string",
"friendlyName": "string",
"hostPoolType": "string",
"loadBalancerType": "string",
"maxSessionLimit": "int",
"personalDesktopAssignmentType": "string",
"preferredAppGroupType": "string",
"registrationInfo": {
"expirationTime": "string",
"registrationTokenOperation": "string",
"token": "string"
},
"ring": "int",
"ssoadfsAuthority": "string",
"ssoClientId": "string",
"ssoClientSecretKeyVaultPath": "string",
"ssoSecretType": "string",
"startVMOnConnect": "bool",
"validationEnvironment": "bool",
"vmTemplate": "string"
}
}
属性值
hostPools
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DesktopVirtualization/hostPools” |
| apiVersion | 资源 API 版本 | “2020-11-10-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：3-64 有效字符： 字母数字、下划线字符、句点和连字符。 以字母或数字开头。 以字母、数字或下划线结尾。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| 标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| properties | HostPool 的详细属性 | HostPoolProperties (必需) |
HostPoolProperties
| 名称 | 说明 | 值 |
|---|---|---|
| customRdpProperty | HostPool 的自定义 rdp 属性。 | 字符串 |
| description | HostPool 的说明。 | 字符串 |
| friendlyName | HostPool 的友好名称。 | 字符串 |
| hostPoolType | 适用于桌面的 HostPool 类型。 | “个人” “共用” (必需) |
| loadBalancerType | 负载均衡器的类型。 | “BreadthFirst” “DepthFirst” “持久性” (必需) |
| maxSessionLimit | HostPool 的最大会话限制。 | int |
| personalDesktopAssignmentType | HostPool 的 PersonalDesktopAssignment 类型。 | “自动” “Direct” |
| preferredAppGroupType | 首选应用程序组类型的类型，默认为桌面应用程序组 | “Desktop” “None” “RailApplications” (必需) |
| registrationInfo | HostPool 的注册信息。 | RegistrationInfo |
| 铃声 | HostPool 的环号。 | int |
| ssoadfsAuthority | 用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。 | 字符串 |
| ssoClientId | 用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。 | 字符串 |
| ssoClientSecretKeyVaultPath | 存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。 | 字符串 |
| ssoSecretType | 机密类型的单一登录类型。 | 'Certificate' “CertificateInKeyVault” “SharedKey” “SharedKeyInKeyVault” |
| startVMOnConnect | 用于打开/关闭 StartVMOnConnect 功能的标志。 | bool |
| validationEnvironment | 是验证环境。 | bool |
| vmTemplate | 主机池中用于 sessionhosts 配置的 VM 模板。 | 字符串 |
RegistrationInfo
| 名称 | 说明 | 值 |
|---|---|---|
| expirationTime | 注册令牌的过期时间。 | 字符串 |
| registrationTokenOperation | 重置令牌的类型。 | 'Delete' “None” 'Update' |
| 令牌 | 注册令牌 base64 编码的字符串。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署 hostPools 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
customRdpProperty = "string"
description = "string"
friendlyName = "string"
hostPoolType = "string"
loadBalancerType = "string"
maxSessionLimit = int
personalDesktopAssignmentType = "string"
preferredAppGroupType = "string"
registrationInfo = {
expirationTime = "string"
registrationTokenOperation = "string"
token = "string"
}
ring = int
ssoadfsAuthority = "string"
ssoClientId = "string"
ssoClientSecretKeyVaultPath = "string"
ssoSecretType = "string"
startVMOnConnect = bool
validationEnvironment = bool
vmTemplate = "string"
}
})
}
属性值
hostPools
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：3-64 有效字符： 字母数字、下划线字符、句点和连字符。 以字母或数字开头。 以字母、数字或下划线结尾。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| parent_id | 若要部署到资源组，请使用该资源组的 ID。 | 字符串 (必需) |
| 标记 | 资源标记。 | 标记名称和值的字典。 |
| properties | HostPool 的详细属性 | 需要 hostPoolProperties () |
HostPoolProperties
| 名称 | 说明 | 值 |
|---|---|---|
| customRdpProperty | HostPool 的自定义 rdp 属性。 | 字符串 |
| description | HostPool 的说明。 | 字符串 |
| friendlyName | HostPool 的友好名称。 | 字符串 |
| hostPoolType | 桌面的 HostPool 类型。 | “个人” 需要“共用” () |
| loadBalancerType | 负载均衡器的类型。 | “BreadthFirst” “DepthFirst” 需要“持久” () |
| maxSessionLimit | HostPool 的最大会话限制。 | int |
| personalDesktopAssignmentType | HostPool 的 PersonalDesktopAssignment 类型。 | “Automatic” “Direct” |
| preferredAppGroupType | 首选应用程序组类型的类型，默认为桌面应用程序组 | “桌面” "None" “RailApplications” (必需) |
| registrationInfo | HostPool 的注册信息。 | RegistrationInfo |
| 铃声 | HostPool 的环号。 | int |
| ssoadfsAuthority | 用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。 | 字符串 |
| ssoClientId | 用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。 | 字符串 |
| ssoClientSecretKeyVaultPath | 存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。 | 字符串 |
| ssoSecretType | 机密类型的单一登录类型。 | “Certificate” “CertificateInKeyVault” “SharedKey” “SharedKeyInKeyVault” |
| startVMOnConnect | 用于打开/关闭 StartVMOnConnect 功能的标志。 | bool |
| validationEnvironment | 是验证环境。 | bool |
| vmTemplate | 主机池中用于 sessionhosts 配置的 VM 模板。 | 字符串 |
RegistrationInfo
| 名称 | 说明 | 值 |
|---|---|---|
| expirationTime | 注册令牌的过期时间。 | 字符串 |
| registrationTokenOperation | 重置令牌的类型。 | “Delete” "None" “Update” |
| 令牌 | 注册令牌 base64 编码的字符串。 | 字符串 |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈