你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Update-AzWvdHostPool
更新主机池。
语法
Update-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
[-AgentUpdateMaintenanceWindowTimeZone <String>]
[-AgentUpdateType <SessionHostComponentUpdateType>]
[-AgentUpdateUseSessionHostLocalTime]
[-CustomRdpProperty <String>]
[-Description <String>]
[-FriendlyName <String>]
[-LoadBalancerType <LoadBalancerType>]
[-MaxSessionLimit <Int32>]
[-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
[-PreferredAppGroupType <PreferredAppGroupType>]
[-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
[-RegistrationInfoExpirationTime <DateTime>]
[-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
[-Ring <Int32>]
[-SsoClientId <String>]
[-SsoClientSecretKeyVaultPath <String>]
[-SsoSecretType <SsoSecretType>]
[-SsoadfsAuthority <String>]
[-StartVMOnConnect]
[-Tag <Hashtable>]
[-VMTemplate <String>]
[-ValidationEnvironment]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzWvdHostPool
-InputObject <IDesktopVirtualizationIdentity>
[-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
[-AgentUpdateMaintenanceWindowTimeZone <String>]
[-AgentUpdateType <SessionHostComponentUpdateType>]
[-AgentUpdateUseSessionHostLocalTime]
[-CustomRdpProperty <String>]
[-Description <String>]
[-FriendlyName <String>]
[-LoadBalancerType <LoadBalancerType>]
[-MaxSessionLimit <Int32>]
[-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
[-PreferredAppGroupType <PreferredAppGroupType>]
[-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
[-RegistrationInfoExpirationTime <DateTime>]
[-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
[-Ring <Int32>]
[-SsoClientId <String>]
[-SsoClientSecretKeyVaultPath <String>]
[-SsoSecretType <SsoSecretType>]
[-SsoadfsAuthority <String>]
[-StartVMOnConnect]
[-Tag <Hashtable>]
[-VMTemplate <String>]
[-ValidationEnvironment]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 说明
更新主机池。
示例
示例 1：按名称更新 Windows 虚拟桌面 HostPool
Update-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-Name HostPoolName `
-LoadBalancerType 'BreadthFirst' `
-Description 'Description' `
-FriendlyName 'Friendly Name' `
-MaxSessionLimit 6 `
-CustomRdpProperty $null `
-Ring $null `
-ValidationEnvironment:$false
Location Name Type
-------- ---- ----
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools此命令更新资源组中的 Windows 虚拟桌面 HostPool。
参数
-AgentUpdateMaintenanceWindow
维护时段列表。 维护时段长 2 小时。 若要构造，请参阅 AGENTUPDATEMAINTENANCEWINDOW 属性的 NOTES 部分并创建哈希表。
| 类型: | IMaintenanceWindowPatchProperties[] |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-AgentUpdateMaintenanceWindowTimeZone
中 https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid定义的维护时区。 如果 useLocalTime 为 true，则必须设置。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-AgentUpdateType
会话主机组件的维护类型。
| 类型: | SessionHostComponentUpdateType |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-AgentUpdateUseSessionHostLocalTime
是否使用虚拟机的 localTime。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
| 类型: | SwitchParameter |
| 别名: | cf |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-CustomRdpProperty
HostPool 的自定义 rdp 属性。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-DefaultProfile
DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。
| 类型: | PSObject |
| 别名: | AzureRMContext, AzureCredential |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Description
HostPool 的说明。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-FriendlyName
HostPool 的友好名称。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-InputObject
要构造的标识参数，请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。
| 类型: | IDesktopVirtualizationIdentity |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-LoadBalancerType
负载均衡器的类型。
| 类型: | LoadBalancerType |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-MaxSessionLimit
HostPool 的最大会话限制。
| 类型: | Int32 |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Name
指定资源组中的主机池的名称
| 类型: | String |
| 别名: | HostPoolName |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-PersonalDesktopAssignmentType
HostPool 的 PersonalDesktopAssignment 类型。
| 类型: | PersonalDesktopAssignmentType |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-PreferredAppGroupType
首选应用程序组类型的类型，默认为桌面应用程序组
| 类型: | PreferredAppGroupType |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-PublicNetworkAccess
启用允许从公共网络访问此资源
| 类型: | HostpoolPublicNetworkAccess |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-RegistrationInfoExpirationTime
注册令牌的过期时间。
| 类型: | DateTime |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-RegistrationInfoRegistrationTokenOperation
重置令牌的类型。
| 类型: | RegistrationTokenOperation |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ResourceGroupName
资源组的名称。 此名称不区分大小写。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-Ring
HostPool 的环号。
| 类型: | Int32 |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SsoadfsAuthority
用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SsoClientId
用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SsoClientSecretKeyVaultPath
存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SsoSecretType
单一登录机密类型的类型。
| 类型: | SsoSecretType |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-StartVMOnConnect
要打开/关闭 StartVMOnConnect 功能的标志。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SubscriptionId
目标订阅的 ID。
| 类型: | String |
| Position: | Named |
| 默认值: | (Get-AzContext).Subscription.Id |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Tag
要更新的标记
| 类型: | Hashtable |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ValidationEnvironment
验证环境。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-VMTemplate
主机池中会话主机配置的 VM 模板。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
| 类型: | SwitchParameter |
| 别名: | wi |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
IDesktopVirtualizationIdentity