Remove-AzWvdUserSession

モジュール:

Az.DesktopVirtualization

userSession を削除します。

構文

Remove-AzWvdUserSession
      -HostPoolName <String>
      -Id <String>
      -ResourceGroupName <String>
      -SessionHostName <String>
      [-SubscriptionId <String>]
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzWvdUserSession
      -Id <String>
      -SessionHostInputObject <IDesktopVirtualizationIdentity>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzWvdUserSession
      -Id <String>
      -SessionHostName <String>
      -HostPoolInputObject <IDesktopVirtualizationIdentity>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzWvdUserSession
      -InputObject <IDesktopVirtualizationIdentity>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

userSession を削除します。

例

例 1: Windows Virtual Desktop UserSession を名前で削除する

Remove-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2

このコマンドは、セッション ホスト内の Windows Virtual Desktop UserSession を削除します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-Force

userSession を強制的に削除するように指定します。

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

-HostPoolInputObject

IDENTITY パラメーター

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

-HostPoolName

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

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

-Id

指定したセッション ホスト内のユーザー セッションの名前

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

-InputObject

IDENTITY パラメーター

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

-PassThru

コマンドが成功したときに true を返します。

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

-ResourceGroupName

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

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

-SessionHostInputObject

IDENTITY パラメーター

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

-SessionHostName

指定したホスト プール内のセッション ホストの名前

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

-SubscriptionId

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

入力

IDesktopVirtualizationIdentity

出力

Boolean