Get-EntraAgentIdentity

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

Get-EntraAgentIdentity

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

O Get-EntraAgentIdentity cmdlet recupera uma identidade do agente de Microsoft Graph. Quando usado com -AgentId, ele retorna uma única identidade de agente. Quando usado com -AgentIdentityBlueprintId, ele retorna todas as identidades de agente que são filhos do blueprint especificado. Se nenhuma ID de blueprint for fornecida, use a ID de blueprint armazenada da sessão atual ou solicitará uma.

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

Este exemplo recupera a Identidade do Agente com a ID especificada.

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

Este exemplo recupera todas as Identidades do Agente que são filhos do Blueprint de Identidade do Agente especificado.

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)" }

Este exemplo lista todas as Identidades do Agente para o blueprint criado na sessão atual usando a ID de blueprint armazenada.

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: $_"
}

Este exemplo demonstra como recuperar uma Identidade do Agente com tratamento de erros para capturar casos em que o agente não existe.

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Ao usar -AgentId, retorna um único objeto de Identidade do Agente. Ao usar -AgentIdentityBlueprintId, retorna uma matriz de objetos de Identidade do Agente. Cada objeto inclui propriedades como id, displayName, appId e servicePrincipalType.

Se a Identidade do Agente ou Blueprint com a ID especificada não for encontrada, o cmdlet gerará um erro. Ao listar por blueprint, dá suporte à paginação para recuperar todos os resultados.

Esse cmdlet requer as seguintes permissões de Microsoft Graph:

• Application.Read.All