Get-EntraAgentUser

Get-EntraAgentUser

    [-AgentUserId <String>]
    [<CommonParameters>]

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Get-EntraAgentUser コマンドレットは、v1.0 API を使用してMicrosoft Graphからエージェント ユーザーを取得します。 -AgentUserIdと共に使用すると、1 人のエージェント ユーザーが返されます。 -AgentIdと共に使用すると、指定したエージェント ID に接続されているすべてのエージェント ユーザーが返されます。 GetById パラメーター セットにエージェント ユーザー ID が指定されていない場合は、現在のセッションの格納されたエージェント ユーザー ID を使用するか、エージェント ユーザー ID を要求します。

Connect-Entra -Scopes 'User.Read.All'
Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

次の使用例は、指定した ID を持つエージェント ユーザーを取得します。

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
New-EntraAgentUserForAgentId -DisplayName "My Agent User" -UserPrincipalName "myagent@contoso.onmicrosoft.com"
$agentUser = Get-EntraAgentUser
Write-Host "Agent User: $($agentUser.displayName)"

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

Connect-Entra -Scopes 'User.Read.All'
$agentUsers = Get-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd"
$agentUsers | ForEach-Object { Write-Host "$($_.displayName) ($($_.userPrincipalName))" }

この例では、指定したエージェント ID に接続されているすべてのエージェント ユーザーを取得します。

Connect-Entra -Scopes 'User.Read.All'
try {
    $agentUser = Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    Write-Host "Agent User found: $($agentUser.displayName) ($($agentUser.userPrincipalName))"
} catch {
    Write-Host "Agent User not found or error occurred: $_"
}

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

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

-AgentUserIdを使用する場合は、1 つの Agent User オブジェクトを返します。 -AgentIdを使用する場合は、エージェント ユーザー オブジェクトの配列を返します。 各オブジェクトには、id、displayName、userPrincipalName、mailNickname、accountEnabled、identityParentId などのプロパティが含まれています。

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

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

• User.Read.All