Get-EntraAgentIdentityBlueprintPrincipal
エージェント ID ブループリント サービス プリンシパルを ID で取得します。
構文
Default (既定)
Get-EntraAgentIdentityBlueprintPrincipal
[-ServicePrincipalId <String>]
[<CommonParameters>]
説明
Get-EntraAgentIdentityBlueprintPrincipal コマンドレットは、指定されたサービス プリンシパル ID を使用して、Microsoft Graphからエージェント ID ブループリント サービス プリンシパルを取得します。 ID が指定されていない場合は、現在のセッションの格納されたサービス プリンシパル ID を使用するか、1 つを要求します。 見つかった場合はサービス プリンシパル オブジェクトを返し、見つからない場合はエラーをスローします。
例
例 1: 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
この例では、指定した ID を持つエージェント ID ブループリント サービス プリンシパルを取得します。
例 2: 現在のセッションからブループリント サービス プリンシパルを取得する
Connect-Entra -Scopes 'AgentIdentityBlueprintPrincipal.Create'
New-EntraAgentIdentityBlueprintPrincipal
$sp = Get-EntraAgentIdentityBlueprintPrincipal
Write-Host "Service Principal: $($sp.displayName)"
この例では、格納されているサービス プリンシパル ID を使用して、現在のセッションで作成されたエージェント ID ブループリント サービス プリンシパルを取得します。
例 3: エラー処理を含むブループリント サービス プリンシパルを取得する
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: $_"
}
この例では、エラー処理を使用してエージェント ID ブループリント サービス プリンシパルを取得し、存在しないケースをキャッチする方法を示します。
パラメーター
-ServicePrincipalId
取得するエージェント ID ブループリント サービス プリンシパルの ID。 指定しない場合は、現在のセッションから保存されているサービス プリンシパル ID を使用するか、1 つを要求します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
None
出力
System.Object
ID、appId、displayName、createdDateTime、servicePrincipalType などのプロパティを持つエージェント ID ブループリント サービス プリンシパル オブジェクトを返します。
メモ
指定した ID を持つエージェント ID ブループリント サービス プリンシパルが見つからない場合、コマンドレットはエラーをスローします。
このコマンドレットでは、Microsoft Graph v1.0 API エンドポイント (/v1.0/servicePrincipals/graph.agentIdentityBlueprintPrincipal) を使用します。
このコマンドレットには、次のMicrosoft Graphアクセス許可が必要です。
- Application.Read.All