Get-EntraAgentIdentityBlueprint

モジュール:
Microsoft.Entra.Applications Module v1.3

エージェント ID ブループリントを ID で取得します。

構文

Default (既定) 

Get-EntraAgentIdentityBlueprint

    [-BlueprintId <String>]
    [<CommonParameters>]

説明

Get-EntraAgentIdentityBlueprint コマンドレットは、v1.0 API と指定されたブループリント ID を使用して、Microsoft Graphからエージェント ID ブループリントを取得します。 ID が指定されていない場合は、現在のセッションの格納されたブループリント ID を使用するか、1 つを要求します。 ブループリント オブジェクトが見つかった場合は返し、見つからない場合はエラーをスローします。

例

例 1: ID によるエージェント ID ブループリントの取得

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

この例では、指定した ID を持つエージェント ID ブループリントを取得します。

例 2: 現在のセッションからブループリントを取得する

Connect-Entra -Scopes 'AgentIdentityBlueprint.Create'
New-EntraAgentIdentityBlueprint -DisplayName "My Blueprint" -SponsorUserIds @("admin@contoso.com")
$blueprint = Get-EntraAgentIdentityBlueprint
Write-Host "Blueprint: $($blueprint.displayName)"

この例では、格納されているブループリント ID を使用して、現在のセッションで作成されたエージェント ID ブループリントを取得します。

例 3: エラー処理を使用してエージェント ID ブループリントを取得する

Connect-Entra -Scopes 'Application.Read.All'
try {
    $blueprint = Get-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    Write-Host "Blueprint found: $($blueprint.displayName)"
} catch {
    Write-Host "Blueprint not found or error occurred: $_"
}

この例では、エラー処理を使用してエージェント ID ブループリントを取得し、ブループリントが存在しない場合をキャッチする方法を示します。

パラメーター

-BlueprintId

取得するエージェント 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、requiredResourceAccess などのプロパティを持つエージェント ID Blueprint オブジェクトを返します。

メモ

指定した ID を持つエージェント ID ブループリントが見つからない場合、コマンドレットはエラーをスローします。

このコマンドレットでは、Microsoft Graph v1.0 API エンドポイント (/v1.0/applications/microsoft.graph.agentIdentityBlueprint) を使用します。

このコマンドレットには、次のMicrosoft Graphアクセス許可が必要です。

  • Application.Read.All