你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Remove-AzWvdUserSession

删除 userSession。

语法

Delete (默认值)

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

DeleteViaIdentitySessionHost

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

DeleteViaIdentityHostPool

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

DeleteViaIdentity

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

说明

删除 userSession。

示例

示例 1:按名称删除 Windows 虚拟桌面 UserSession

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

此命令删除会话主机中的 Windows 虚拟桌面 UserSession。

参数

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet,请使用 SubscriptionId 参数。

参数属性

类型:PSObject
默认值:None
支持通配符:False
不显示:False
别名:AzureRMContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Force

指定以强制删除 userSession。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HostPoolInputObject

标识参数

参数属性

类型:IDesktopVirtualizationIdentity
默认值:None
支持通配符:False
不显示:False

参数集

DeleteViaIdentityHostPool
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HostPoolName

指定资源组中主机池的名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Delete
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Id

指定会话主机内用户会话的名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:UserSessionId

参数集

Delete
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
DeleteViaIdentitySessionHost
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
DeleteViaIdentityHostPool
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

标识参数

参数属性

类型:IDesktopVirtualizationIdentity
默认值:None
支持通配符:False
不显示:False

参数集

DeleteViaIdentity
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PassThru

当命令成功时返回 true

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

资源组的名称。 此名称不区分大小写。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Delete
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SessionHostInputObject

标识参数

参数属性

类型:IDesktopVirtualizationIdentity
默认值:None
支持通配符:False
不显示:False

参数集

DeleteViaIdentitySessionHost
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SessionHostName

指定主机池中会话主机的名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Delete
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
DeleteViaIdentityHostPool
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SubscriptionId

目标订阅的 ID。 该值必须是 UUID。

参数属性

类型:String
默认值:(Get-AzContext).Subscription.Id
支持通配符:False
不显示:False

参数集

Delete
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

IDesktopVirtualizationIdentity

输出

Boolean