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

Microsoft.DesktopVirtualization hostPools

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  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
    }
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managementType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    publicNetworkAccess: '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 资源所在的地理位置 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku ResourceModelWithAllowedPropertySetSku
kind 门户/工具等用于呈现相同类型资源的不同 UX 体验的元数据;例如，ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持，资源提供程序必须验证并保留此值。 字符串

约束：
模式 = ^[-\w\._,\(\)]+$
标识 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此资源的资源的完全限定的资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况，如果从模板中删除资源，则完整模式部署不会删除该资源，因为它由另一个资源管理。 字符串
plan ResourceModelWithAllowedPropertySetPlan
properties HostPool 的详细属性 需要 hostPoolProperties ()

ResourceModelWithAllowedPropertySetIdentity

名称 说明 Value
type 标识类型。 “SystemAssigned”

ResourceModelWithAllowedPropertySetPlan

名称 说明 值
name 正在采购的第三方项目的用户定义名称。 字符串 (必需)
product 正在采购的第三方项目。 例如 NewRelic。 产品映射到加入数据市场时为项目指定的 OfferID。 字符串 (必需)
promotionCode 发布者为上述产品/项目提供了在数据市场中预配的促销代码。 字符串
发布者 正在购买的第三方项目的发布者。 例如，NewRelic 字符串 (必需)
版本 所需产品/项目的版本。 字符串

HostPoolProperties

名称 说明 值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
description HostPool 的说明。 字符串
friendlyName HostPool 的友好名称。 字符串
hostPoolType 适用于桌面的 HostPool 类型。 “BYODesktop”
“个人”
“共用” (必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
“持久性” (必需)
managementType 此主机池的管理类型，“自动”或“标准”。 默认值为“自动”。 “自动化”
“Standard”
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 “自动”
“Direct”
preferredAppGroupType 首选应用程序组类型的类型，默认为桌面应用程序组 “桌面”
“None”
“RailApplications” (必需)
publicNetworkAccess 启用允许从公共和专用网络访问此资源，禁用允许仅通过专用终结点访问此资源 “Disabled”
“已启用”
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
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 模板。 字符串

AgentUpdateProperties

名称 说明 值
maintenanceWindows 维护时段列表。 维护时段长达 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone 如果 useLocalTime 为 true，则必须设置中 https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid 定义的维护时区。 字符串
type 会话主机组件的维护类型。 'Default'
“Scheduled”
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

MaintenanceWindowProperties

名称 说明 值
dayOfWeek 一周中的某一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
hour 一天的更新开始时间。 (0 - 23) int

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
registrationTokenOperation 重置令牌的类型。 'Delete'
“None”
'Update'
令牌 注册令牌 base64 编码的字符串。 字符串

ResourceModelWithAllowedPropertySetSku

名称 说明 值
容量 如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果无法对资源进行横向扩展/缩减，则可能会省略此项。 int
family 如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和一些其他值的组合时，这将是独立代码。 字符串
层 如果服务具有多个层，但 PUT 上不需要此字段，则资源提供程序需要实现此字段。 'Basic'
“免费”
“Premium”
'Standard'

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "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"
    },
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "publicNetworkAccess": "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 版本 “2023-11-01-preview”
name 资源名称 字符串 (必需)

字符限制：3-64

有效字符：
字母数字、下划线字符、句点和连字符。

以字母或数字开头。 以字母、数字或下划线结尾。
location 资源所在的地理位置 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku ResourceModelWithAllowedPropertySetSku
kind 门户/工具等用于呈现相同类型资源的不同 UX 体验的元数据;例如，ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持，资源提供程序必须验证并保留此值。 字符串

约束：
模式 = ^[-\w\._,\(\)]+$
标识 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此资源的资源的完全限定的资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况，如果从模板中删除资源，则完整模式部署不会删除该资源，因为它由另一个资源管理。 字符串
plan ResourceModelWithAllowedPropertySetPlan
properties HostPool 的详细属性 需要 hostPoolProperties ()

ResourceModelWithAllowedPropertySetIdentity

名称 说明 Value
type 标识类型。 “SystemAssigned”

ResourceModelWithAllowedPropertySetPlan

名称 说明 值
name 正在采购的第三方项目的用户定义名称。 字符串 (必需)
product 正在采购的第三方项目。 例如 NewRelic。 产品映射到加入数据市场时为项目指定的 OfferID。 字符串 (必需)
promotionCode 发布者为上述产品/项目提供了在数据市场中预配的促销代码。 字符串
发布者 正在购买的第三方项目的发布者。 例如，NewRelic 字符串 (必需)
版本 所需产品/项目的版本。 字符串

HostPoolProperties

名称 说明 值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
description HostPool 的说明。 字符串
friendlyName HostPool 的友好名称。 字符串
hostPoolType 桌面的 HostPool 类型。 'BYODesktop'
“个人”
“共用” (必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
需要“持久” ()
managementType 此主机池的管理类型，自动或标准。 默认值为 Automated。 “自动化”
'Standard'
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 'Automatic'
“Direct”
preferredAppGroupType 首选应用程序组类型的类型，默认为桌面应用程序组 “Desktop”
“None”
“RailApplications” (必需)
publicNetworkAccess 启用允许从公共和专用网络访问此资源，禁用则允许仅通过专用终结点访问此资源 'Disabled'
'Enabled'
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
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 模板。 字符串

AgentUpdateProperties

名称 说明 值
maintenanceWindows 维护时段列表。 维护时段为 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone 如果 useLocalTime 为 true，则必须设置中 https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid 定义的维护时区。 字符串
type 会话主机组件的维护类型。 'Default'
'Scheduled'
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

MaintenanceWindowProperties

名称 说明 值
dayOfWeek 一周中的某一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
hour 一天的更新开始时间。 (0 - 23) int

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
registrationTokenOperation 重置令牌的类型。 'Delete'
“None”
'Update'
令牌 注册令牌 base64 编码的字符串。 字符串

ResourceModelWithAllowedPropertySetSku

名称 说明 值
容量 如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果无法对资源进行横向扩展/缩减，则可能会省略此项。 int
family 如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和一些其他值的组合时，这将是独立代码。 字符串
层 如果服务具有多个层，但 PUT 上不需要此字段，则资源提供程序需要实现此字段。 'Basic'
“免费”
“Premium”
'Standard'

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      agentUpdate = {
        maintenanceWindows = [
          {
            dayOfWeek = "string"
            hour = int
          }
        ]
        maintenanceWindowTimeZone = "string"
        type = "string"
        useSessionHostLocalTime = bool
      }
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managementType = "string"
      maxSessionLimit = int
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      publicNetworkAccess = "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"
    }
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
  })
}

属性值

hostPools

名称 说明 Value
type 资源类型 “Microsoft.DesktopVirtualization/hostPools@2023-11-01-preview”
name 资源名称 字符串 (必需)

字符限制：3-64

有效字符：
字母数字、下划线字符、句点和连字符。

以字母或数字开头。 以字母、数字或下划线结尾。
location 资源所在的地理位置 字符串
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku ResourceModelWithAllowedPropertySetSku
kind 门户/工具等用于呈现相同类型资源的不同 UX 体验的元数据;例如，ApiApps 是一种 Microsoft.Web/sites 类型。 如果支持，资源提供程序必须验证并保留此值。 字符串

约束：
Pattern = ^[-\w\._,\(\)]+$
标识 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况，如果从模板中删除资源，则完整模式部署不会删除该资源，因为它由其他资源管理。 字符串
plan ResourceModelWithAllowedPropertySetPlan
properties HostPool 的详细属性 HostPoolProperties (必需)

ResourceModelWithAllowedPropertySetIdentity

名称 说明 Value
type 标识类型。 “SystemAssigned”

ResourceModelWithAllowedPropertySetPlan

名称 说明 值
name 正在采购的第三方项目的用户定义的名称。 字符串 (必需)
product 正在采购的第三方项目。 例如 NewRelic。 产品映射到在数据市场载入时为项目指定的 OfferID。 字符串 (必需)
promotionCode 发布者为所述产品/项目提供了数据市场中预配的促销代码。 字符串
发布者 正在购买的第三方项目的发布者。 例如 NewRelic 字符串 (必需)
版本 所需产品/项目的版本。 字符串

HostPoolProperties

名称 说明 值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
description HostPool 的说明。 字符串
friendlyName HostPool 的友好名称。 字符串
hostPoolType 适用于桌面的 HostPool 类型。 “BYODesktop”
“个人”
“共用” (必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
“持久性” (必需)
managementType 此主机池的管理类型，“自动”或“标准”。 默认值为 Automated。 “自动化”
“Standard”
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 “Automatic”
“Direct”
preferredAppGroupType 首选应用程序组类型的类型，默认为桌面应用程序组 “桌面”
"None"
“RailApplications” (必需)
publicNetworkAccess 启用允许从公共和专用网络访问此资源，禁用则允许仅通过专用终结点访问此资源 “Disabled”
“Enabled”
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
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 模板。 字符串

AgentUpdateProperties

名称 说明 值
maintenanceWindows 维护时段列表。 维护时段为 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone 如果 useLocalTime 为 true，则必须设置中 https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid 定义的维护时区。 字符串
type 会话主机组件的维护类型。 “Default”
“Scheduled”
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

MaintenanceWindowProperties

名称 说明 值
dayOfWeek 一周中的某一天。 "Friday"
“星期一”
“星期六”
"Sunday"
"Thursday"
"Tuesday"
"Wednesday"
hour 一天的更新开始时间。 (0 - 23) int

RegistrationInfo

名称 说明 值
expirationTime 注册令牌的过期时间。 字符串
registrationTokenOperation 重置令牌的类型。 “Delete”
"None"
“Update”
令牌 注册令牌 base64 编码的字符串。 字符串

ResourceModelWithAllowedPropertySetSku

名称 说明 值
容量 如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果无法对资源进行横向扩展/缩减，则可能会省略此项。 int
family 如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和一些其他值的组合时，这将是独立代码。 字符串
层 如果服务具有多个层，但 PUT 上不需要此字段，则资源提供程序需要实现此字段。 "Basic"
"Free"
“Premium”
“Standard”