你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DesktopVirtualization hostPools 2019-01-23-preview

  • 项目

Bicep 资源定义

hostPools 资源类型可以使用面向以下对象的操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2019-01-23-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'
      resetToken: bool
      token: 'string'
    }
    ring: int
    ssoContext: 'string'
    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
ssoContext 包含 ssoContext 机密的 keyvault 的路径。 字符串
validationEnvironment 是验证环境。 bool
vmTemplate 主机池中用于 sessionhosts 配置的 VM 模板。 字符串

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
resetToken 更新注册令牌。 bool
令牌 注册令牌 base64 编码的字符串。 字符串

ARM 模板资源定义

可以使用面向以下操作部署 hostPools 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2019-01-23-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",
      "resetToken": "bool",
      "token": "string"
    },
    "ring": "int",
    "ssoContext": "string",
    "validationEnvironment": "bool",
    "vmTemplate": "string"
  }
}

属性值

hostPools

名称 说明 Value
type 资源类型 “Microsoft.DesktopVirtualization/hostPools”
apiVersion 资源 API 版本 '2019-01-23-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 类型。 'Automatic'
“Direct”
preferredAppGroupType 首选应用程序组类型的类型，默认为桌面应用程序组 “Desktop”
“None”
“RailApplications” (必需)
registrationInfo HostPool 的注册信息。 RegistrationInfo
铃声 HostPool 的环号。 int
ssoContext 包含 ssoContext 机密的 keyvault 的路径。 字符串
validationEnvironment 是验证环境。 bool
vmTemplate 主机池中用于 sessionhosts 配置的 VM 模板。 字符串

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
resetToken 更新注册令牌。 bool
令牌 注册令牌 base64 编码的字符串。 字符串

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 hostPools 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DesktopVirtualization/hostPools 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2019-01-23-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"
        resetToken = bool
        token = "string"
      }
      ring = int
      ssoContext = "string"
      validationEnvironment = bool
      vmTemplate = "string"
    }
  })
}

属性值

hostPools

名称 说明 Value
type 资源类型 “Microsoft.DesktopVirtualization/hostPools@2019-01-23-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
ssoContext 包含 ssoContext 机密的 keyvault 的路径。 字符串
validationEnvironment 是验证环境。 bool
vmTemplate 主机池中用于 sessionhosts 配置的 VM 模板。 字符串

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
resetToken 更新注册令牌。 bool
令牌 注册令牌 base64 编码的字符串。 字符串