Update-AzWvdHostPool
语法
UpdateExpanded （默认值）
Update-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
[-AgentUpdateMaintenanceWindowTimeZone <String>]
[-AgentUpdateType <String>]
[-AgentUpdateUseSessionHostLocalTime]
[-CustomRdpProperty <String>]
[-Description <String>]
[-FriendlyName <String>]
[-LoadBalancerType <String>]
[-MaxSessionLimit <Int32>]
[-PersonalDesktopAssignmentType <String>]
[-PreferredAppGroupType <String>]
[-PublicNetworkAccess <String>]
[-RegistrationInfoExpirationTime <DateTime>]
[-RegistrationInfoRegistrationTokenOperation <String>]
[-Ring <Int32>]
[-SsoClientId <String>]
[-SsoClientSecretKeyVaultPath <String>]
[-SsoSecretType <String>]
[-SsoadfsAuthority <String>]
[-StartVMOnConnect]
[-Tag <Hashtable>]
[-VMTemplate <String>]
[-ValidationEnvironment]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzWvdHostPool
-InputObject <IDesktopVirtualizationIdentity>
[-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
[-AgentUpdateMaintenanceWindowTimeZone <String>]
[-AgentUpdateType <String>]
[-AgentUpdateUseSessionHostLocalTime]
[-CustomRdpProperty <String>]
[-Description <String>]
[-FriendlyName <String>]
[-LoadBalancerType <String>]
[-MaxSessionLimit <Int32>]
[-PersonalDesktopAssignmentType <String>]
[-PreferredAppGroupType <String>]
[-PublicNetworkAccess <String>]
[-RegistrationInfoExpirationTime <DateTime>]
[-RegistrationInfoRegistrationTokenOperation <String>]
[-Ring <Int32>]
[-SsoClientId <String>]
[-SsoClientSecretKeyVaultPath <String>]
[-SsoSecretType <String>]
[-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 小时。
参数属性
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-AgentUpdateMaintenanceWindowTimeZone
维护时区如 中定义 https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0。
如果 useLocalTime 为 true，则必须设置。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-AgentUpdateType
会话主机组件的维护类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-AgentUpdateUseSessionHostLocalTime
是否使用虚拟机的 localTime。
参数属性
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前，提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-CustomRdpProperty
HostPool 的自定义 rdp 属性。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-DefaultProfile
DefaultProfile 参数不起作用。
如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。
参数属性
| 类型: | PSObject
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | AzureRMContext, AzureCredential |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Description
HostPool 的说明。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-FriendlyName
HostPool 的友好名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
标识参数
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-JsonFilePath
提供给更新操作的 Json 文件的路径
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateViaJsonFilePath
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-JsonString
提供给更新操作的 Json 字符串
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateViaJsonString
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LoadBalancerType
负载均衡器的类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-MaxSessionLimit
HostPool 的最大会话限制。
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Name
指定资源组中主机池的名称
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | HostPoolName |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonString
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonFilePath
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-PersonalDesktopAssignmentType
HostPool 的 PersonalDesktopAssignment 类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-PreferredAppGroupType
首选应用程序组类型的类型，默认为桌面应用程序组
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-PublicNetworkAccess
启用以允许从公共网络访问此资源
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-RegistrationInfoExpirationTime
注册令牌的过期时间。
参数属性
| 类型: | DateTime
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-RegistrationInfoRegistrationTokenOperation
重置令牌的类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ResourceGroupName
资源组的名称。
此名称不区分大小写。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonString
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonFilePath
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Ring
HostPool 的环号。
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SsoadfsAuthority
用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SsoClientId
用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SsoClientSecretKeyVaultPath
存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SsoSecretType
单一登录机密类型的类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-StartVMOnConnect
要打开/关闭 StartVMOnConnect 功能的标志。
参数属性
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SubscriptionId
目标订阅的 ID。
该值必须是 UUID。
参数属性
| 类型: | String
|
| 默认值: | (Get-AzContext).Subscription.Id |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonString
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaJsonFilePath
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Tag
要更新的标签
参数属性
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ValidationEnvironment
验证环境。
参数属性
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-VMTemplate
主机池中会话主机配置的 VM 模板。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
UpdateExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
UpdateViaIdentityExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输出
