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 セクションを参照し、ハッシュテーブルを作成します。

型:	IMaintenanceWindowProperties[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AgentUpdateMaintenanceWindowTimeZone

https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyidで定義されているメンテナンスのタイムゾーン。 useLocalTime が true の場合は設定する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AgentUpdateType

セッションホストコンポーネントのメンテナンスの種類。

型:	SessionHostComponentUpdateType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AgentUpdateUseSessionHostLocalTime

仮想マシンの localTime を使用するかどうか。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CustomRdpProperty

HostPool のカスタム rdp プロパティ。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Description

HostPool の説明。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DesktopAppGroupName

デスクトップアプリグループ名

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ExpirationTime

登録トークンの有効期限。

型:	DateTime
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-FriendlyName

HostPool のフレンドリ名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HostPoolType

デスクトップ用の HostPool の種類。

型:	HostPoolType
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IdentityType

ID の種類。

型:	ResourceIdentityType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Kind

同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。たとえば、ApiApps は Microsoft.Web/sites の種類の一種です。サポートされている場合、リソースプロバイダーはこの値を検証して保持する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LoadBalancerType

ロードバランサーの種類。

型:	LoadBalancerType
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Location

リソースが存在する地理的な場所

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ManagedBy

このリソースを管理するリソースの完全修飾リソース ID。このリソースが別の Azure リソースによって管理されているかどうかを示します。これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MaxSessionLimit

HostPool の最大セッション制限。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

指定したリソースグループ内のホストプールの名前

型:	String
Aliases:	HostPoolName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PersonalDesktopAssignmentType

HostPool の PersonalDesktopAssignment 型。

型:	PersonalDesktopAssignmentType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PlanName

調達中のサードパーティ成果物のユーザー定義名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PlanProduct

調達中のサードパーティの成果物。例: NewRelic。製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PlanPromotionCode

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PlanPublisher

購入中のサードパーティ成果物の発行元。例: NewRelic

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PlanVersion

目的の製品/成果物のバージョン。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PreferredAppGroupType

優先するアプリケーショングループの種類 (既定はデスクトップアプリケーショングループ)

型:	PreferredAppGroupType
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PublicNetworkAccess

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

型:	HostpoolPublicNetworkAccess
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RegistrationInfoToken

登録トークン base64 でエンコードされた文字列。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RegistrationTokenOperation

トークンのリセットの種類。

型:	RegistrationTokenOperation
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前。名前の大文字と小文字は区別されます。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Ring

HostPool のリング番号。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkuCapacity

SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkuFamily

同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkuName

SKU の名前。例 - P3。通常は文字 + 数字のコードです

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkuSize

SKU サイズ。名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロンコードになります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkuTier

このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。

型:	SkuTier
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SsoadfsAuthority

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SsoClientId

WVD SSO 証明書の発行に使用される登録済み証明書利用者の ClientId。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SsoClientSecretKeyVaultPath

ADFS への通信に使用されるシークレットを格納する Azure KeyVault へのパス。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SsoSecretType

シークレットの種類に対するシングルサインオンの種類。

型:	SsoSecretType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StartVMOnConnect

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

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

型:	String
配置:	Named
規定値:	(Get-AzContext).Subscription.Id
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Tag

リソースタグ。

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ValidationEnvironment

検証環境です。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-VMTemplate

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceName

Workspace Name

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

出力

IHostPool

次の方法で共有