New-AzWvdHostPool

參考

模組:: Az.DesktopVirtualization

建立或更新主機集區。

Syntax

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>]

Description

建立或更新主機集區。

範例

範例 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 一節。

Type:	IMaintenanceWindowProperties[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AgentUpdateMaintenanceWindowTimeZone

維護的時區，如中所 https://learn.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid定義。如果 useLocalTime 為 true，則必須設定。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AgentUpdateType

會話主機組件的維護類型。

Type:	SessionHostComponentUpdateType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AgentUpdateUseSessionHostLocalTime

是否要使用虛擬機的localTime。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

執行 Cmdlet 之前先提示您確認。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomRdpProperty

HostPool 的自定義 rdp 屬性。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

DefaultProfile 參數無法運作。如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

HostPool 的描述。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DesktopAppGroupName

傳統型應用程式組名

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpirationTime

註冊令牌的到期時間。

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FriendlyName

HostPool 的易記名稱。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostPoolType

桌面的 HostPool 類型。

Type:	HostPoolType
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

識別類型。

Type:	ResourceIdentityType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Kind

入口網站/工具等用來轉譯相同類型資源的不同UX體驗的元數據;例如，ApiApps 是一種 Microsoft.Web/sites 類型。如果支援，資源提供者必須驗證並保存此值。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerType

負載平衡器的型別。

Type:	LoadBalancerType
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

資源所在的地理位置

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedBy

管理此資源之資源的完整資源標識碼。指出此資源是否由另一個 Azure 資源管理。如果存在，如果從範本中移除，則完整模式部署將不會刪除資源，因為該資源是由另一個資源管理。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxSessionLimit

HostPool 的最大會話限制。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

指定資源群組內的主機集區名稱

Type:	String
Aliases:	HostPoolName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PersonalDesktopAssignmentType

HostPool 的個人DesktopAssignment 類型。

Type:	PersonalDesktopAssignmentType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlanName

正在採購的第三方成品的用戶定義名稱。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlanProduct

正在採購的第三方成品。例如 NewRelic。產品會對應至數據市場上線時為成品指定的 OfferID。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlanPromotionCode

發行者提供在數據市場為上述產品/成品布建的促銷碼。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlanPublisher

要購買的第三方成品發行者。例如 NewRelic

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlanVersion

所需產品/成品的版本。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreferredAppGroupType

慣用應用程式群組類型的類型，預設為傳統型應用程式群組

Type:	PreferredAppGroupType
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

Enabled 允許從公用和專用網存取此資源，[已停用] 可讓此資源只能透過私人端點存取

Type:	HostpoolPublicNetworkAccess
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistrationInfoToken

註冊令牌 base64 編碼字串。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistrationTokenOperation

重設令牌的類型。

Type:	RegistrationTokenOperation
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

資源群組的名稱。名稱不區分大小寫。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Ring

HostPool 的通道編號。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuCapacity

如果 SKU 支援相應放大/縮小，則應該包含容量整數。如果資源無法相應放大/縮小，可能會省略此專案。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuFamily

如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuName

SKU 的名稱。例如 - P3。通常是字母+數位碼

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuSize

SKU 大小。當名稱欄位是階層和其他一些值的組合時，這會是獨立程序代碼。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuTier

如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

Type:	SkuTier
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SsoadfsAuthority

客戶 ADFS 伺服器的 URL，用於簽署 WVD SSO 憑證。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SsoClientId

用來發出 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SsoClientSecretKeyVaultPath

儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SsoSecretType

密碼類型上的單一登錄類型。

Type:	SsoSecretType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StartVMOnConnect

開啟/關閉 StartVMOn 連線功能的旗標。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

目標訂用帳戶的標識碼。

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

資源標籤。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ValidationEnvironment

這是驗證環境。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VMTemplate

主機集區內會話主機設定的 VM 範本。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

工作區名稱

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸出

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20231004Preview.IHostPool