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

New-AzWvdHostPool

模块:

Az.DesktopVirtualization

创建或更新主机池。

语法

New-AzWvdHostPool
   -Name <String>
   -ResourceGroupName <String>
   -HostPoolType <HostPoolType>
   -LoadBalancerType <LoadBalancerType>
   -PreferredAppGroupType <PreferredAppGroupType>
   [-Location <String>]
   [-SubscriptionId <String>]
   [-AgentUpdateMaintenanceWindow <IMaintenanceWindowProperties[]>]
   [-AgentUpdateMaintenanceWindowTimeZone <String>]
   [-AgentUpdateType <SessionHostComponentUpdateType>]
   [-AgentUpdateUseSessionHostLocalTime]
   [-CustomRdpProperty <String>]
   [-Description <String>]
   [-ExpirationTime <DateTime>]
   [-FriendlyName <String>]
   [-IdentityType <ResourceIdentityType>]
   [-Kind <String>]
   [-ManagedBy <String>]
   [-MaxSessionLimit <Int32>]
   [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
   [-PlanName <String>]
   [-PlanProduct <String>]
   [-PlanPromotionCode <String>]
   [-PlanPublisher <String>]
   [-PlanVersion <String>]
   [-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
   [-RegistrationInfoToken <String>]
   [-RegistrationTokenOperation <RegistrationTokenOperation>]
   [-Ring <Int32>]
   [-SkuCapacity <Int32>]
   [-SkuFamily <String>]
   [-SkuName <String>]
   [-SkuSize <String>]
   [-SkuTier <SkuTier>]
   [-SsoClientId <String>]
   [-SsoClientSecretKeyVaultPath <String>]
   [-SsoSecretType <SsoSecretType>]
   [-SsoadfsAuthority <String>]
   [-StartVMOnConnect]
   [-Tag <Hashtable>]
   [-VMTemplate <String>]
   [-ValidationEnvironment]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzWvdHostPool
   -Name <String>
   -ResourceGroupName <String>
   -HostPoolType <HostPoolType>
   -LoadBalancerType <LoadBalancerType>
   -PreferredAppGroupType <PreferredAppGroupType>
   [-Location <String>]
   [-SubscriptionId <String>]
   [-DesktopAppGroupName <String>]
   [-WorkspaceName <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

创建或更新主机池。

示例

示例 1：按名称创建 Windows 虚拟桌面 HostPool

New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
                            -Name HostPoolName `
                            -Location 'eastus' `
                            -HostPoolType 'Pooled' `
                            -LoadBalancerType 'DepthFirst' `
                            -RegistrationTokenOperation 'Update' `
                            -ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) `
                            -Description 'Description' `
                            -FriendlyName 'Friendly Name' `
                            -MaxSessionLimit 5 `
                            -VMTemplate $null `
                            -SsoClientId $null `
                            -SsoClientSecretKeyVaultPath $null `
                            -SsoSecretType $null `
                            -SsoadfsAuthority $null `
                            -CustomRdpProperty $null `
                            -Ring $null `
                            -ValidationEnvironment:$false

Location   Name                 Type
--------   ----                 ----
eastus     HostPoolName Microsoft.DesktopVirtualization/hostpools

此命令在资源组中创建 Windows 虚拟桌面 HostPool。

示例 2：按名称创建 Windows 虚拟桌面 HostPool

New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
                            -Name HostPoolName `
                            -Location 'eastus' `
                            -HostPoolType 'Personal' `
                            -LoadBalancerType 'Persistent' `
                            -RegistrationTokenOperation 'Update' `
                            -ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) `
                            -Description 'Description' `
                            -FriendlyName 'Friendly Name' `
                            -MaxSessionLimit 5 `
                            -VMTemplate $null `
                            -SsoClientId $null `
                            -SsoClientSecretKeyVaultPath $null `
                            -SsoSecretType $null `
                            -SsoadfsAuthority $null `
                            -CustomRdpProperty $null `
                            -Ring $null `
                            -ValidationEnvironment:$false

Location   Name                 Type
--------   ----                 ----
eastus     HostPoolName Microsoft.DesktopVirtualization/hostpools

此命令在资源组中创建 Windows 虚拟桌面 HostPool。

参数

-AgentUpdateMaintenanceWindow

维护时段列表。 维护时段长 2 小时。 若要构造，请参阅 AGENTUPDATEMAINTENANCEWINDOW 属性的 NOTES 部分并创建哈希表。

类型:	IMaintenanceWindowProperties[]
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

-DesktopAppGroupName

桌面应用组名称

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ExpirationTime

注册令牌的过期时间。

类型:	DateTime
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FriendlyName

HostPool 的友好名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HostPoolType

适用于桌面的 HostPool 类型。

类型:	HostPoolType
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-IdentityType

标识类型。

类型:	ResourceIdentityType
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Kind

门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据;例如，ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持，资源提供程序必须验证并保留此值。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-LoadBalancerType

负载均衡器的类型。

类型:	LoadBalancerType
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Location

资源所在的地理位置

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ManagedBy

管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在，则完全模式部署不会删除资源（如果从模板中删除，因为它由另一个资源管理）。

类型:	String
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

-PlanName

正在采购的第三方项目的用户定义的名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PlanProduct

正在采购的第三方项目。 例如 NewRelic。 产品映射到在数据市场载入时为项目指定的 OfferID。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PlanPromotionCode

发布者为上述产品/项目提供数据市场中预配的促销代码。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PlanPublisher

正在购买的第三方项目的发布者。 例如 NewRelic

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PlanVersion

所需产品/项目的版本。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PreferredAppGroupType

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

类型:	PreferredAppGroupType
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-PublicNetworkAccess

启用后，可从公共和专用网络访问此资源，禁用后，只能通过专用终结点访问此资源

类型:	HostpoolPublicNetworkAccess
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RegistrationInfoToken

注册令牌 base64 编码字符串。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RegistrationTokenOperation

重置令牌的类型。

类型:	RegistrationTokenOperation
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ResourceGroupName

资源组的名称。 此名称不区分大小写。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Ring

HostPool 的环号。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SkuCapacity

如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果资源无法横向扩展/缩小，则可能会省略此范围。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SkuFamily

如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SkuName

SKU 的名称。 Ex - P3. 它通常是字母+数字代码

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SkuSize

SKU 大小。 当名称字段是层和其他一些值的组合时，这将是独立的代码。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SkuTier

如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

类型:	SkuTier
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

-WorkspaceName

工作区名称

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输出

IHostPool