Get-EntraAgentIdentity

Obtient une identité d’agent par son ID ou répertorie toutes les identités d’agent pour un blueprint d’identité d’agent.

Syntaxe

GetById (Par défaut)

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint

Get-EntraAgentIdentity

    [-AgentIdentityBlueprintId <String>]
    [<CommonParameters>]

Description

L’applet Get-EntraAgentIdentity de commande récupère une identité d’agent à partir de Microsoft Graph. Lorsqu’elle est utilisée avec -AgentId, elle retourne une identité d’agent unique. Lorsqu’elle est utilisée avec -AgentIdentityBlueprintId, elle retourne toutes les identités d’agent qui sont des enfants du blueprint spécifié. Si aucun ID de blueprint n’est fourni, utilise l’ID de blueprint stocké à partir de la session active ou demande un id de blueprint.

Exemples

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

Connect-Entra -Scopes 'Application.Read.All'
Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"

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

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

Connect-Entra -Scopes 'Application.Read.All'
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
$agents | ForEach-Object { Write-Host "$($_.displayName) ($($_.id))" }

Cet exemple récupère toutes les identités d’agent qui sont des enfants du blueprint d’identité de l’agent spécifié.

Exemple 3 : Répertorier les identités de l’agent pour le blueprint de session actuel

Connect-Entra -Scopes 'Application.Read.All'
New-EntraAgentIdentityBlueprint -DisplayName "My Blueprint" -SponsorUserIds @("admin@contoso.com")
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId
$agents | ForEach-Object { Write-Host "$($_.displayName)" }

Cet exemple répertorie toutes les identités de l’agent pour le blueprint créé dans la session active à l’aide de l’ID de blueprint stocké.

Exemple 4 : Obtenir une identité d’agent avec gestion des erreurs

Connect-Entra -Scopes 'Application.Read.All'
try {
    $agent = Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"
    Write-Host "Agent found: $($agent.displayName)"
} catch {
    Write-Host "Agent not found or error occurred: $_"
}

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

Paramètres

-AgentId

ID de l’identité de l’agent à récupérer. 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: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 pour lequel répertorier les identités de l’agent enfant. S’il n’est pas fourni, utilise l’ID de blueprint stocké à partir de la session active ou demande une. Utilisé avec le jeu de paramètres GetByBlueprint.

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

GetByBlueprint
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 -AgentId, retourne un seul objet Agent Identity. Lors de l’utilisation -AgentIdentityBlueprintId, retourne un tableau d’objets Agent Identity. Chaque objet inclut des propriétés telles que l’ID, displayName, appId et servicePrincipalType.

Notes

Si l’identité ou le blueprint de l’agent avec l’ID spécifié est introuvable, l’applet de commande génère une erreur. Lors de la liste par blueprint, 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 :

  • Application.Read.All