Condividi tramite

Invoke-RdsUserSessionLogoff

Modulo:
Microsoft.RDInfra.RDPowershell Module

Disconnette un utente dalla sessione attiva corrente.

Sintassi

Default (impostazione predefinita). 

Invoke-RdsUserSessionLogoff
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-SessionHostName] <String>
    [-SessionId] <Int32>
    [-NoUserPrompt]
    [-Force]
    [<CommonParameters>]

Descrizione

L'Invoke-RdsUserSessionLogoff disconnette un utente dalla sessione attiva corrente in esecuzione sull'host di sessione specificato. Poiché l'utente è disconnesso, tutte le applicazioni verranno terminate e c'è la possibilità che i dati vadano persi se l'utente o le applicazioni non hanno salvato i file aperti.

Esempio

Esempio 1: Disconnettere un utente fornendo tutte le informazioni necessarie

PS C:\> Invoke-RdsUserSessionLogoff -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1

Questo comando disconnette l'utente dall'host di sessione specificato associato all'ID di sessione fornito. Questo comando richiede che l'utente abbia cercato la sessione utente in precedenza per fornire tutte le informazioni richieste. Eseguendo il cmdlet Invoke-RdsUserSessionLogoff senza l'opzione NoUserPrompt, verrà chiesto di confermare la disconnessione dell'utente.

Esempio 2: Disconnettere un utente cercando la sua sessione utente

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Invoke-RdsUserSessionLogoff -NoUserPrompt

Questo comando utilizza il cmdlet Get-RdsUserSession per cercare la sessione dell'utente specifico, quindi lo reindirizza al cmdlet Invoke-RdsUserSessionLogoff per disconnettere l'utente. Eseguendo il cmdlet Invoke-RdsUserSessionLogoff con l'opzione NoUserPrompt, non verrà visualizzata alcuna richiesta aggiuntiva di conferma della disconnessione dell'utente.

Parametri

-Force

L'opzione indica che si desidera disconnettere l'utente e rimuovere la sessione dal database, anche se il servizio non è in grado di raggiungere l'host della sessione.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HostPoolName

Nome del pool di host.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:1
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-NoUserPrompt

L'opzione indica che si desidera disconnettere l'utente senza alcuna ulteriore conferma.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-SessionHostName

Nome dell'host della sessione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:2
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-SessionId

L'ID sessione correlato all'utente che si desidera disconnettere.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:3
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-TenantName

Nome del tenant.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

System.String

System.Int32

Output

System.Object