Get-EntraAgentIdentity

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

エージェント ID を ID で取得するか、エージェント ID ブループリントのすべてのエージェント ID を一覧表示します。

構文

GetById (既定) 

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint 

Get-EntraAgentIdentity

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

説明

Get-EntraAgentIdentity コマンドレットは、Microsoft Graphからエージェント ID を取得します。 -AgentIdと共に使用すると、1 つのエージェント ID が返されます。 -AgentIdentityBlueprintIdと共に使用すると、指定されたブループリントの子であるすべてのエージェント ID が返されます。 ブループリント ID が指定されていない場合は、現在のセッションの格納されたブループリント ID を使用するか、プロンプトを表示します。

例

例 1: ID でエージェント ID を取得する

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

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

例 2: ブループリントのすべてのエージェント ID を一覧表示する

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

この例では、指定したエージェント ID ブループリントの子であるすべてのエージェント ID を取得します。

例 3: 現在のセッション ブループリントのエージェント ID を一覧表示する

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

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

例 4: エラー処理を使用してエージェント ID を取得する

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

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

パラメーター

-AgentId

取得するエージェント ID の ID。 GetById パラメーター セットと共に使用されます。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetById
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AgentIdentityBlueprintId

子エージェント ID を一覧表示するエージェント ID ブループリントの ID。 指定しない場合は、現在のセッションから格納されているブループリント ID を使用するか、1 つを要求します。 GetByBlueprint パラメーター セットと共に使用されます。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetByBlueprint
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

None

出力

System.Object

-AgentIdを使用する場合は、単一のエージェント ID オブジェクトを返します。 -AgentIdentityBlueprintIdを使用する場合は、エージェント ID オブジェクトの配列を返します。 各オブジェクトには、id、displayName、appId、servicePrincipalType などのプロパティが含まれています。

メモ

指定した ID のエージェント ID またはブループリントが見つからない場合、コマンドレットはエラーをスローします。 ブループリントで一覧表示する場合、すべての結果を取得するための改ページがサポートされます。

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

  • Application.Read.All