Compartilhar via

Remove-AzWvdUserSession

Módulo:
Az.DesktopVirtualization Module

Remova uma userSession.

Sintaxe

Delete (Default) 

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>]

Description

Remova uma userSession.

Exemplos

Exemplo 1: Excluir uma UserSession da Área de Trabalho Virtual do Windows por nome

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

Esse comando exclui uma UserSession da Área de Trabalho Virtual do Windows em um Host de Sessão.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Especifique para forçar a exclusão de userSession.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HostPoolInputObject

Parâmetro de identidade

Propriedades do parâmetro

Tipo:IDesktopVirtualizationIdentity
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteViaIdentityHostPool
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HostPoolName

O nome do pool de host dentro do grupo de recursos especificado

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Delete
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Id

O nome da sessão do usuário dentro do host da sessão especificado

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:UserSessionId

Conjuntos de parâmetros

Delete
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
DeleteViaIdentitySessionHost
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
DeleteViaIdentityHostPool
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Parâmetro de identidade

Propriedades do parâmetro

Tipo:IDesktopVirtualizationIdentity
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteViaIdentity
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Retorna true quando o comando é bem-sucedido

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Delete
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SessionHostInputObject

Parâmetro de identidade

Propriedades do parâmetro

Tipo:IDesktopVirtualizationIdentity
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteViaIdentitySessionHost
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SessionHostName

O nome do host da sessão dentro do pool de host especificado

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Delete
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
DeleteViaIdentityHostPool
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SubscriptionId

A ID da assinatura de destino. O valor deve ser uma UUID.

Propriedades do parâmetro

Tipo:String
Valor padrão:(Get-AzContext).Subscription.Id
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Delete
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

IDesktopVirtualizationIdentity

Saídas

Boolean