Disconnect-RdsUserSession
Déconnecte un utilisateur de sa session active actuelle.
Syntaxe
Default (Par défaut)
Disconnect-RdsUserSession
[-TenantName] <String>
[-HostPoolName] <String>
[-SessionHostName] <String>
[-SessionId] <Int32>
[-NoUserPrompt]
[<CommonParameters>]
Description
L’applet de commande Disconnect-RdsUserSession déconnecte l’utilisateur de sa session active en cours d’exécution sur l’hôte de session spécifié. L’utilisateur n’est pas déconnecté, de sorte que toutes les applications continuent de s’exécuter. L’utilisateur peut se reconnecter à sa session en relançant une connexion dans son client Bureau à distance.
Exemples
Exemple 1 : Déconnecter un utilisateur en fournissant toutes les informations requises
PS C:\> Disconnect-RdsUserSession -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 Disconnect-RdsUserSession sans le commutateur NoUserPrompt, vous êtes invité à confirmer la déconnexion de l’utilisateur.
Exemple 2 : Déconnecter un utilisateur en recherchant sa session utilisateur
PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Disconnect-RdsUserSession -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 Disconnect-RdsUserSession pour déconnecter l’utilisateur. En exécutant l’applet de commande Disconnect-RdsUserSession avec le commutateur NoUserPrompt, vous ne recevrez aucune invite supplémentaire pour confirmer la déconnexion de l’utilisateur.
Paramètres
-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 que vous souhaitez 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.