Update-AzWvdHostPool

  • リファレンス
モジュール:
Az.DesktopVirtualization

ホスト プールを更新します。

構文

Update-AzWvdHostPool
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <SessionHostComponentUpdateType>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <LoadBalancerType>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
      [-PreferredAppGroupType <PreferredAppGroupType>]
      [-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <SsoSecretType>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzWvdHostPool
      -InputObject <IDesktopVirtualizationIdentity>
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <SessionHostComponentUpdateType>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <LoadBalancerType>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
      [-PreferredAppGroupType <PreferredAppGroupType>]
      [-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <SsoSecretType>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

ホスト プールを更新します。

例

例 1: Windows Virtual Desktop 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 Virtual Desktop HostPool を更新します。

パラメーター

-AgentUpdateMaintenanceWindow

メインテナント ウィンドウの一覧。 メンテナンス期間は 2 時間です。 構築するには、AGENTUPDATEMAINTENANCEWINDOW プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

Type:IMaintenanceWindowPatchProperties[]
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

-FriendlyName

HostPool のフレンドリ名。

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

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-LoadBalancerType

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

Type:LoadBalancerType
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

-PreferredAppGroupType

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

Type:PreferredAppGroupType
Position:Named
Default value:None
Required:False
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

-RegistrationInfoExpirationTime

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

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

-RegistrationInfoRegistrationTokenOperation

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

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

-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

入力

IDesktopVirtualizationIdentity

出力

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