Remove-EntraAgentUser

Module:
Microsoft.Entra.Users Module v1.3

Supprime un utilisateur agent par son ID ou supprime tous les utilisateurs de l’agent associés à une identité d’agent.

Syntaxe

ByUserId (Par défaut) 

Remove-EntraAgentUser

    -AgentUserId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAgentId 

Remove-EntraAgentUser

    -AgentId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet Remove-EntraAgentUser de commande supprime les utilisateurs de l’agent de Microsoft Entra. Lorsqu’il est utilisé avec -AgentUserId, il supprime un utilisateur d’agent unique par ID. Lorsqu’il est utilisé avec -AgentId, il recherche et supprime tous les utilisateurs de l’agent associés à l’identité de l’agent spécifiée.

L’applet de commande nécessite une confirmation avant de supprimer, sauf si le -Force commutateur est utilisé. Permet -WhatIf d’afficher un aperçu des utilisateurs qui seraient supprimés sans réellement effectuer la suppression.

Exemples

Exemple 1 : Supprimer un utilisateur d’agent par ID

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Cet exemple montre comment supprimer l’utilisateur de l’agent avec l’ID spécifié. Vous serez invité à confirmer.

Exemple 2 : Supprimer un utilisateur de l’agent par ID sans confirmation

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

Cet exemple montre comment supprimer l’utilisateur de l’agent sans demander de confirmation.

Exemple 3 : Supprimer tous les utilisateurs de l’agent pour une identité d’agent

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force

Cet exemple recherche tous les utilisateurs de l’agent associés à l’identité de l’agent spécifiée et les supprime.

Exemple 4 : Suppression d’aperçu avec WhatIf

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

Cet exemple montre quels utilisateurs de l’agent seraient supprimés sans effectuer réellement la suppression.

Exemple 5 : Supprimer avec gestion des erreurs

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
try {
    $result = Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
    Write-Host "Deleted: $($result.DisplayName)"
} catch {
    Write-Host "Failed to delete: $_"
}

Cet exemple montre comment supprimer un utilisateur agent avec gestion des erreurs.

Paramètres

-AgentId

ID de l’identité de l’agent dont les utilisateurs de l’agent associés doivent être supprimés. L’applet de commande recherche tous les utilisateurs de l’agent connectés à cette identité de l’agent et les supprime. Utilisé avec le jeu de paramètres ByAgentId.

Propriétés du paramètre

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

Jeux de paramètres

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

-AgentUserId

ID de l’utilisateur agent à supprimer. Utilisé avec le jeu de paramètres ByUserId.

Propriétés du paramètre

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

Jeux de paramètres

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

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:True
Prend en charge les caractères génériques:False
DontShow:False
Alias:Cf

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

-Force

Supprime l’invite de confirmation avant la suppression.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:False
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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

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

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

None

Sorties

System.Collections.Hashtable

Retourne une table de hachage (ou tableau de tables de hachage lors de l’utilisation -AgentId) avec les propriétés suivantes : ID, DisplayName, AgentId et Status.

Notes

Cette applet de commande nécessite les autorisations de Microsoft Graph suivantes :

  • AgentIdUser.ReadWrite.All

L’applet de commande nécessite une connexion active Microsoft Entra. Utilisez Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' pour vous connecter en premier.

Lors de l’utilisation -AgentId, l’applet de commande interroge d’abord tous les utilisateurs de l’agent associés à l’identité de l’agent, puis supprime chacune d’elles. Si l’identité de l’agent n’a pas d’utilisateurs de l’agent associé, un avertissement s’affiche.