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 Virtual Desktop 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 Virtual Desktop HostPool を作成します。

例 2: 名前で Windows Virtual Desktop 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 Virtual Desktop 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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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 パラメーターは機能しません。別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は 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

ID の種類。

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

-Kind

同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。たとえば、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

このリソースを管理するリソースの完全修飾リソース ID。このリソースが別の 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 の PersonalDesktopAssignment 型。

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。製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。

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

-PlanPromotionCode

パブリッシャーは、その製品/成果物に対して Data Market でプロビジョニングされたプロモーションコードを提供しました。

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

有効にすると、パブリックネットワークとプライベートネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベートエンドポイント経由でのみアクセスできます

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

WVD SSO 証明書に署名するための顧客 ADFS サーバーへの URL。

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

StartVMOnConnect 機能のオン/オフを切り替えるフラグ。

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

-SubscriptionId

ターゲットサブスクリプションの ID。

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

hostpool 内の sessionhosts 構成用の VM テンプレート。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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