Remove-EntraAgentIdentity

Module:
Microsoft.Entra.Applications Module v1.3

Supprime une identité d’agent par son ID ou supprime toutes les identités de l’agent (et leurs utilisateurs de l’agent) associées à un blueprint d’identité d’agent.

Syntaxe

ByAgentId (Par défaut) 

Remove-EntraAgentIdentity

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

ByBlueprintId 

Remove-EntraAgentIdentity

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

Description

L’applet Remove-EntraAgentIdentity de commande supprime les identités de l’agent de Microsoft Entra à l’aide de l’API v1.0. Lorsqu’il est utilisé avec -AgentId, il supprime une identité d’agent unique et tous les utilisateurs de l’agent associés. Lorsqu’il est utilisé avec -AgentIdentityBlueprintId, il recherche toutes les identités de l’agent pour le blueprint et supprime chacune d’elles ainsi que leurs utilisateurs de l’agent associés.

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 ressources qui seraient supprimées sans réellement effectuer la suppression.

Exemples

Exemple 1 : Supprimer une identité d’agent par ID

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

Cet exemple supprime l’identité de l’agent et tous les utilisateurs de l’agent associés.

Exemple 2 : Supprimer toutes les identités d’agent pour un blueprint

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force

Cet exemple recherche toutes les identités d’agent associées au blueprint spécifié, supprime leurs utilisateurs de l’agent, puis supprime les identités de l’agent elles-mêmes.

Exemple 3 : Suppression d’aperçu avec WhatIf

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

Cet exemple montre quelles identités d’agent et utilisateurs de l’agent sont supprimés sans effectuer la suppression.

Exemple 4 : Supprimer avec gestion des erreurs

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
try {
    $result = Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
    Write-Host "Deleted Agent Identity: $($result.DisplayName)"
    Write-Host "Also deleted $($result.DeletedAgentUsers.Count) Agent User(s)"
} catch {
    Write-Host "Failed to delete: $_"
}

Cet exemple montre comment supprimer une identité d’agent avec gestion des erreurs et inspecter les utilisateurs de l’agent supprimés.

Paramètres

-AgentId

ID de l’identité de l’agent à supprimer. L’applet de commande supprime également tous les utilisateurs de l’agent associés à cette identité d’agent. 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

-AgentIdentityBlueprintId

ID du blueprint d’identité de l’agent. Toutes les identités d’agent associées à ce blueprint sont supprimées, ainsi que leurs utilisateurs de l’agent. Utilisé avec le jeu de paramètres ByBlueprintId.

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

ByBlueprintId
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

Renvoie une table de hachage (ou tableau de tables de hachage lors de l’utilisation -AgentIdentityBlueprintId) avec des propriétés : Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (tableau d’informations utilisateur supprimées) et Status.

Notes

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

  • AgentIdentity.DeleteRestore.All
  • AgentIdUser.ReadWrite.All

L’applet de commande nécessite une connexion active Microsoft Entra. Utilisez Connect-Entra les étendues ci-dessus pour vous connecter en premier.

Lors de la suppression d’une identité d’agent, tous les utilisateurs de l’agent associés sont supprimés en premier. Si la suppression de l’utilisateur de l’agent échoue, l’erreur est enregistrée, mais la suppression de l’identité de l’agent continue.

Lors de l’utilisation -AgentIdentityBlueprintId, l’applet de commande prend en charge la pagination pour gérer les blueprints avec de nombreuses identités d’agent.