Get-EntraAgentUser

Module:
Microsoft.Entra.Users Module v1.3

Obtient un utilisateur agent par son ID ou répertorie tous les utilisateurs de l’agent connectés à une identité d’agent.

Syntaxe

GetById (Par défaut) 

Get-EntraAgentUser

    [-AgentUserId <String>]
    [<CommonParameters>]

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

L’applet Get-EntraAgentUser de commande récupère les utilisateurs de l’agent à partir de Microsoft Graph à l’aide de l’API v1.0. Lorsqu’il est utilisé avec -AgentUserId, il retourne un utilisateur d’agent unique. Lorsqu’il est utilisé avec -AgentId, il retourne tous les utilisateurs de l’agent connectés à l’identité de l’agent spécifiée. Si aucun ID d’utilisateur de l’agent n’est fourni dans le jeu de paramètres GetById, il utilise l’ID utilisateur de l’agent stocké à partir de la session active ou demande un.

Exemples

Exemple 1 : Obtenir un utilisateur d’agent par ID

Connect-Entra -Scopes 'User.Read.All'
Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Cet exemple récupère l’utilisateur de l’agent avec l’ID spécifié.

Exemple 2 : Obtenir l’utilisateur de l’agent à partir de la session active

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
New-EntraAgentUserForAgentId -DisplayName "My Agent User" -UserPrincipalName "myagent@contoso.onmicrosoft.com"
$agentUser = Get-EntraAgentUser
Write-Host "Agent User: $($agentUser.displayName)"

Cet exemple récupère l’utilisateur agent qui a été créé dans la session active à l’aide de l’ID d’utilisateur de l’agent stocké.

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

Connect-Entra -Scopes 'User.Read.All'
$agentUsers = Get-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd"
$agentUsers | ForEach-Object { Write-Host "$($_.displayName) ($($_.userPrincipalName))" }

Cet exemple récupère tous les utilisateurs de l’agent connectés à l’identité de l’agent spécifiée.

Exemple 4 : Obtenir un utilisateur agent avec gestion des erreurs

Connect-Entra -Scopes 'User.Read.All'
try {
    $agentUser = Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    Write-Host "Agent User found: $($agentUser.displayName) ($($agentUser.userPrincipalName))"
} catch {
    Write-Host "Agent User not found or error occurred: $_"
}

Cet exemple montre comment récupérer un utilisateur agent avec gestion des erreurs pour intercepter les cas où l’utilisateur n’existe pas.

Paramètres

-AgentId

ID de l’identité de l’agent pour lequel récupérer les utilisateurs de l’agent connecté. Retourne tous les utilisateurs de l’agent connectés à l’identité de l’agent spécifiée. Utilisé avec le jeu de paramètres GetByAgentId.

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

GetByAgentId
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 à récupérer. S’il n’est pas fourni, utilise l’ID d’utilisateur de l’agent stocké à partir de la session active ou demande un. Utilisé avec le jeu de paramètres GetById.

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

GetById
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.Object

Lors de l’utilisation -AgentUserId, retourne un seul objet Utilisateur de l’agent. Lors de l’utilisation -AgentId, retourne un tableau d’objets Utilisateur de l’agent. Chaque objet inclut des propriétés telles que l’ID, displayName, userPrincipalName, mailNickname, accountEnabled et identityParentId.

Notes

Si l’identité de l’utilisateur ou de l’agent avec l’ID spécifié est introuvable, l’applet de commande génère une erreur. Lors de la liste par Identité de l’agent, prend en charge la pagination pour récupérer tous les résultats.

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

  • User.Read.All