Get-EntraAgentIdentityBlueprintPrincipal

Módulo:
Microsoft.Entra.Applications Module v1.3

Obtém uma Entidade de Serviço de Blueprint de Identidade do Agente por sua ID.

Sintaxe

Default (Default) 

Get-EntraAgentIdentityBlueprintPrincipal

    [-ServicePrincipalId <String>]
    [<CommonParameters>]

Description

O Get-EntraAgentIdentityBlueprintPrincipal cmdlet recupera uma Entidade de Serviço de Blueprint de Identidade do Agente de Microsoft Graph usando a ID da Entidade de Serviço fornecida. Se nenhuma ID for fornecida, ela usará a ID da entidade de serviço armazenada da sessão atual ou solicitará uma. Retorna o objeto da entidade de serviço se encontrado ou lança um erro se não for encontrado.

Exemplos

Exemplo 1: Obter uma entidade de serviço blueprint por ID

Connect-Entra -Scopes 'Application.Read.All'
Get-EntraAgentIdentityBlueprintPrincipal -ServicePrincipalId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Name                           Value
----                           -----
id                             aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
appId                          bbbbbbbb-1111-2222-3333-cccccccccccc
displayName                    My Blueprint
servicePrincipalType           AgentIdentityBlueprintPrincipal
createdDateTime                2026-04-26T00:00:00Z

Este exemplo recupera a Entidade de Serviço de Blueprint de Identidade do Agente com a ID especificada.

Exemplo 2: Obter a Entidade de Serviço blueprint da sessão atual

Connect-Entra -Scopes 'AgentIdentityBlueprintPrincipal.Create'
New-EntraAgentIdentityBlueprintPrincipal
$sp = Get-EntraAgentIdentityBlueprintPrincipal
Write-Host "Service Principal: $($sp.displayName)"

Este exemplo recupera a Entidade de Serviço de Blueprint de Identidade do Agente que foi criada na sessão atual usando a ID da entidade de serviço armazenada.

Exemplo 3: Obter uma entidade de serviço blueprint com tratamento de erros

Connect-Entra -Scopes 'Application.Read.All'
try {
    $sp = Get-EntraAgentIdentityBlueprintPrincipal -ServicePrincipalId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    Write-Host "Service Principal found: $($sp.displayName)"
} catch {
    Write-Host "Service Principal not found or error occurred: $_"
}

Este exemplo demonstra como recuperar uma Entidade de Serviço de Blueprint de Identidade do Agente com tratamento de erro para capturar casos em que ela não existe.

Parâmetros

-ServicePrincipalId

A ID da Entidade de Serviço de Blueprint de Identidade do Agente a ser recuperada. Se não for fornecido, usará a ID da entidade de serviço armazenada da sessão atual ou solicitará uma.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

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.

Entradas

None

Saídas

System.Object

Retorna o objeto Agent Identity Blueprint Service Principal com propriedades incluindo id, appId, displayName, createdDateTime e servicePrincipalType.

Observações

Se a Entidade de Serviço de Blueprint de Identidade do Agente com a ID especificada não for encontrada, o cmdlet gerará um erro.

Esse cmdlet usa o ponto de extremidade da API Microsoft Graph v1.0 (/v1.0/servicePrincipals/graph.agentIdentityBlueprintPrincipal).

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

  • Application.Read.All