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

HostPoolPatch interface

包:

@azure/arm-desktopvirtualization

可以修补的 HostPool 属性。

扩展

Resource

属性

agentUpdate	用于更新代理、监视代理和堆栈组件的会话主机配置。
customRdpProperty	HostPool 的自定义 rdp 属性。
description	HostPool 的说明。
friendlyName	HostPool 的友好名称。
loadBalancerType	负载均衡器的类型。
maxSessionLimit	HostPool 的最大会话限制。
personalDesktopAssignmentType	HostPool 的 PersonalDesktopAssignment 类型。
preferredAppGroupType	首选应用程序组类型的类型，默认为桌面应用程序组
publicNetworkAccess	启用允许从公共网络访问此资源
registrationInfo	HostPool 的注册信息。
ring	HostPool 的环号。
ssoadfsAuthority	用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。
ssoClientId	用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。
ssoClientSecretKeyVaultPath	存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。
ssoSecretType	单一登录机密类型的类型。
startVMOnConnect	要打开/关闭 StartVMOnConnect 功能的标志。
tags	要更新的标记
validationEnvironment	验证环境。
vmTemplate	主机池中会话主机配置的 VM 模板。

继承属性

id	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

agentUpdate

用于更新代理、监视代理和堆栈组件的会话主机配置。

agentUpdate?: AgentUpdatePatchProperties

属性值

AgentUpdatePatchProperties

customRdpProperty

HostPool 的自定义 rdp 属性。

customRdpProperty?: string

属性值

string

description

HostPool 的说明。

description?: string

属性值

string

friendlyName

HostPool 的友好名称。

friendlyName?: string

属性值

string

loadBalancerType

负载均衡器的类型。

loadBalancerType?: string

属性值

string

maxSessionLimit

HostPool 的最大会话限制。

maxSessionLimit?: number

属性值

number

personalDesktopAssignmentType

HostPool 的 PersonalDesktopAssignment 类型。

personalDesktopAssignmentType?: string

属性值

string

preferredAppGroupType

首选应用程序组类型的类型，默认为桌面应用程序组

preferredAppGroupType?: string

属性值

string

publicNetworkAccess

启用允许从公共网络访问此资源

publicNetworkAccess?: string

属性值

string

registrationInfo

HostPool 的注册信息。

registrationInfo?: RegistrationInfoPatch

属性值

RegistrationInfoPatch

ring

HostPool 的环号。

ring?: number

属性值

number

ssoadfsAuthority

用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。

ssoadfsAuthority?: string

属性值

string

ssoClientId

用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。

ssoClientId?: string

属性值

string

ssoClientSecretKeyVaultPath

存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。

ssoClientSecretKeyVaultPath?: string

属性值

string

ssoSecretType

单一登录机密类型的类型。

ssoSecretType?: string

属性值

string

startVMOnConnect

要打开/关闭 StartVMOnConnect 功能的标志。

startVMOnConnect?: boolean

属性值

boolean

tags

要更新的标记

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

validationEnvironment

验证环境。

validationEnvironment?: boolean

属性值

boolean

vmTemplate

主机池中会话主机配置的 VM 模板。

vmTemplate?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自Resource.id 的

name

资源说明的名称：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自Resource.name 的

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

继承自Resource.systemData

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自resource.type