Invoke-RdsUserSessionLogoff

Module:

Microsoft.RDInfra.RDPowershell Module

Déconnecte un utilisateur de sa session active actuelle.

Syntaxe

Default (Par défaut)

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

Description

Le Invoke-RdsUserSessionLogoff déconnecte un utilisateur de sa session active en cours d’exécution sur l’hôte de session spécifié. Étant donné que l’utilisateur est déconnecté, toutes les applications seront arrêtées et il existe un risque de perte de données si l’utilisateur ou les applications n’ont pas enregistré les fichiers ouverts.

Exemples

Exemple 1 : Déconnecter un utilisateur en fournissant toutes les informations requises

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

Cette commande déconnecte l’utilisateur sur l’hôte de session spécifié associé à l’ID de session fourni. Cette commande nécessite que vous ayez préalablement recherché la session utilisateur pour fournir toutes les informations requises. En exécutant l’applet de commande Invoke-RdsUserSessionLogoff sans le commutateur NoUserPrompt, vous êtes invité à confirmer la déconnexion de l’utilisateur.

Exemple 2 : Déconnexion d’un utilisateur en recherchant sa session utilisateur

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

Cette commande utilise l’applet de commande Get-RdsUserSession pour rechercher la session de l’utilisateur spécifique, puis la dirige vers l’applet de commande Invoke-RdsUserSessionLogoff pour déconnecter l’utilisateur. En exécutant l’applet de commande Invoke-RdsUserSessionLogoff avec le commutateur NoUserPrompt, vous ne recevrez aucune invite supplémentaire pour confirmer la déconnexion de l’utilisateur.

Paramètres

-Force

Le commutateur indiquant que vous souhaitez déconnecter l’utilisateur et supprimer la session de la base de données, même si le service ne peut pas atteindre l’hôte de session.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HostPoolName

Nom du pool d’hôtes.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	1
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-NoUserPrompt

Le commutateur indiquant que vous souhaitez déconnecter l’utilisateur sans aucune confirmation supplémentaire.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-SessionHostName

Nom de l’hôte de la session.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	2
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-SessionId

ID de session correspondant à l’utilisateur dont vous souhaitez vous déconnecter.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	3
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-TenantName

Nom du client.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	0
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

System.String

System.Int32

Sorties

System.Object