Get-EntraBetaAgentIdentity

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

エージェント ID を ID で取得します。

構文

Default (既定) 

Get-EntraBetaAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

説明

Get-EntraBetaAgentIdentity コマンドレットは、指定されたエージェント ID を使用して、Microsoft Graphからエージェント ID を取得します。 見つかった場合はエージェント ID オブジェクトを返し、見つからない場合はエラーをスローします。

例

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

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

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

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

Connect-Entra -Scopes 'Application.Read.All'
try {
    $agent = Get-EntraBetaAgentIdentity -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。

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

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

パラメーター セット

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

CommonParameters

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

入力

None

出力

System.Object

ID、displayName、appId、その他のエージェント ID の詳細などのプロパティを持つエージェント ID オブジェクトを返します。

メモ

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