使用英语阅读

通过


你当前正在访问 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@2024-08-08-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
    }
    customRdpProperty: 'string'
    description: 'string'
    directUDP: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managedPrivateUDP: 'string'
    managementType: 'string'
    maxSessionLimit: int
    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'
  }
}

属性值

AgentUpdateProperties

名字 描述 价值
maintenanceWindows 维护时段列表。 维护时段长 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 中定义的维护时区。 如果 useLocalTime 为 true,则必须设置。 字符串
类型 会话主机组件的维护类型。 “Default”
“Scheduled”
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

HostPoolProperties

名字 描述 价值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
描述 HostPool 的说明。 字符串
directUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
friendlyName HostPool 的友好名称。 字符串
hostPoolType 适用于桌面的 HostPool 类型。 “BYODesktop”
“个人”
“Pooled”(必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
“MultiplePersistent”
“Persistent”(必需)
managedPrivateUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
managementType 此主机池、自动化或标准版的管理类型。 默认值为“自动”。 “自动化”
“Standard”
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 “Automatic”
“Direct”
preferredAppGroupType 首选应用程序组类型的类型,默认为桌面应用程序组 “Desktop”
“None”
“RailApplications”(必需)
publicNetworkAccess 启用后,可从公共和专用网络访问此资源,禁用后,只能通过专用终结点访问此资源 “Disabled”
“Enabled”
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
publicUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
registrationInfo HostPool 的注册信息。 这不会在 GET 上返回。 若要获取注册令牌,请使用 retrieveRegistrationToken 或 listRegistrationTokens POST 调用。 RegistrationInfo
relayUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
戒指 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 主机池中会话主机配置的 VM 模板。 字符串

MaintenanceWindowProperties

名字 描述 价值
dayOfWeek 一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
小时 当天的更新开始时间。 (0 - 23) int

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.DesktopVirtualization/hostPools

名字 描述 价值
身份 托管服务标识(系统分配和/或用户分配的标识) ManagedServiceIdentity
门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。 例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。 字符串

约束:
Pattern = ^[-\w\._,\(\)]+$
位置 资源所在的地理位置 string (必需)
managedBy 管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在,则完全模式部署不会删除资源(如果从模板中删除,因为它由另一个资源管理)。 字符串
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[A-Za-z0-9@.\-_ ]*$ (必需)
计划 规划资源。 计划
性能 HostPool 的详细属性 HostPoolProperties(必需)
sku 表示 SKU 的资源模型定义 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

计划

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

RegistrationInfo

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

Sku

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

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用 Microsoft Entra ID 联接创建 AVD 通过此模板,可以创建 Azure 虚拟桌面资源,例如主机池、应用程序组、工作区、测试会话主机及其扩展,Microsoft Entra ID 联接

ARM 模板资源定义

可以使用目标操作部署 hostPools 资源类型:

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

资源格式

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2024-08-08-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"
    },
    "customRdpProperty": "string",
    "description": "string",
    "directUDP": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managedPrivateUDP": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "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"
  }
}

属性值

AgentUpdateProperties

名字 描述 价值
maintenanceWindows 维护时段列表。 维护时段长 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 中定义的维护时区。 如果 useLocalTime 为 true,则必须设置。 字符串
类型 会话主机组件的维护类型。 “Default”
“Scheduled”
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

HostPoolProperties

名字 描述 价值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
描述 HostPool 的说明。 字符串
directUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
friendlyName HostPool 的友好名称。 字符串
hostPoolType 适用于桌面的 HostPool 类型。 “BYODesktop”
“个人”
“Pooled”(必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
“MultiplePersistent”
“Persistent”(必需)
managedPrivateUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
managementType 此主机池、自动化或标准版的管理类型。 默认值为“自动”。 “自动化”
“Standard”
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 “Automatic”
“Direct”
preferredAppGroupType 首选应用程序组类型的类型,默认为桌面应用程序组 “Desktop”
“None”
“RailApplications”(必需)
publicNetworkAccess 启用后,可从公共和专用网络访问此资源,禁用后,只能通过专用终结点访问此资源 “Disabled”
“Enabled”
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
publicUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
registrationInfo HostPool 的注册信息。 这不会在 GET 上返回。 若要获取注册令牌,请使用 retrieveRegistrationToken 或 listRegistrationTokens POST 调用。 RegistrationInfo
relayUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
戒指 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 主机池中会话主机配置的 VM 模板。 字符串

MaintenanceWindowProperties

名字 描述 价值
dayOfWeek 一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
小时 当天的更新开始时间。 (0 - 23) int

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.DesktopVirtualization/hostPools

名字 描述 价值
apiVersion API 版本 '2024-08-08-preview'
身份 托管服务标识(系统分配和/或用户分配的标识) ManagedServiceIdentity
门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。 例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。 字符串

约束:
Pattern = ^[-\w\._,\(\)]+$
位置 资源所在的地理位置 string (必需)
managedBy 管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在,则完全模式部署不会删除资源(如果从模板中删除,因为它由另一个资源管理)。 字符串
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[A-Za-z0-9@.\-_ ]*$ (必需)
计划 规划资源。 计划
性能 HostPool 的详细属性 HostPoolProperties(必需)
sku 表示 SKU 的资源模型定义 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DesktopVirtualization/hostPools”

计划

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

RegistrationInfo

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

Sku

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

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用 Microsoft Entra ID 联接创建 AVD

部署到 Azure
通过此模板,可以创建 Azure 虚拟桌面资源,例如主机池、应用程序组、工作区、测试会话主机及其扩展,Microsoft Entra ID 联接

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

可以使用目标操作部署 hostPools 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2024-08-08-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"
  }
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      agentUpdate = {
        maintenanceWindows = [
          {
            dayOfWeek = "string"
            hour = int
          }
        ]
        maintenanceWindowTimeZone = "string"
        type = "string"
        useSessionHostLocalTime = bool
      }
      customRdpProperty = "string"
      description = "string"
      directUDP = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managedPrivateUDP = "string"
      managementType = "string"
      maxSessionLimit = int
      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"
    }
  })
}

属性值

AgentUpdateProperties

名字 描述 价值
maintenanceWindows 维护时段列表。 维护时段长 2 小时。 MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 中定义的维护时区。 如果 useLocalTime 为 true,则必须设置。 字符串
类型 会话主机组件的维护类型。 “Default”
“Scheduled”
useSessionHostLocalTime 是否使用虚拟机的 localTime。 bool

HostPoolProperties

名字 描述 价值
agentUpdate 用于更新代理、监视代理和堆栈组件的会话主机配置。 AgentUpdateProperties
customRdpProperty HostPool 的自定义 rdp 属性。 字符串
描述 HostPool 的说明。 字符串
directUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
friendlyName HostPool 的友好名称。 字符串
hostPoolType 适用于桌面的 HostPool 类型。 “BYODesktop”
“个人”
“Pooled”(必需)
loadBalancerType 负载均衡器的类型。 “BreadthFirst”
“DepthFirst”
“MultiplePersistent”
“Persistent”(必需)
managedPrivateUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
managementType 此主机池、自动化或标准版的管理类型。 默认值为“自动”。 “自动化”
“Standard”
maxSessionLimit HostPool 的最大会话限制。 int
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 类型。 “Automatic”
“Direct”
preferredAppGroupType 首选应用程序组类型的类型,默认为桌面应用程序组 “Desktop”
“None”
“RailApplications”(必需)
publicNetworkAccess 启用后,可从公共和专用网络访问此资源,禁用后,只能通过专用终结点访问此资源 “Disabled”
“Enabled”
“EnabledForClientsOnly”
“EnabledForSessionHostsOnly”
publicUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
registrationInfo HostPool 的注册信息。 这不会在 GET 上返回。 若要获取注册令牌,请使用 retrieveRegistrationToken 或 listRegistrationTokens POST 调用。 RegistrationInfo
relayUDP 默认值:AVD 范围的设置用于确定连接可用性,已启用:UDP 将在建立连接时尝试此连接类型。 这意味着此连接是可能的,但不能保证,因为有其他因素可能会阻止此连接类型,禁用:UDP 不会尝试此连接类型时建立连接 “Default”
“Disabled”
“Enabled”
戒指 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 主机池中会话主机配置的 VM 模板。 字符串

MaintenanceWindowProperties

名字 描述 价值
dayOfWeek 一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
小时 当天的更新开始时间。 (0 - 23) int

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.DesktopVirtualization/hostPools

名字 描述 价值
身份 托管服务标识(系统分配和/或用户分配的标识) ManagedServiceIdentity
门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。 例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。 字符串

约束:
Pattern = ^[-\w\._,\(\)]+$
位置 资源所在的地理位置 string (必需)
managedBy 管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在,则完全模式部署不会删除资源(如果从模板中删除,因为它由另一个资源管理)。 字符串
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[A-Za-z0-9@.\-_ ]*$ (必需)
计划 规划资源。 计划
性能 HostPool 的详细属性 HostPoolProperties(必需)
sku 表示 SKU 的资源模型定义 Sku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DesktopVirtualization/hostPools@2024-08-08-preview”

计划

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

RegistrationInfo

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

Sku

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

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值