Get-EntraAgentUser

Get-EntraAgentUser

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

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

该 Get-EntraAgentUser cmdlet 使用 v1.0 API 从 Microsoft Graph检索代理用户。 使用 -AgentUserId时，它将返回单个代理用户。 使用 -AgentId时，它将返回连接到指定代理标识的所有代理用户。 如果在 GetById 参数集中未提供代理用户 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))" }

此示例检索连接到指定代理标识的所有代理用户。

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

此示例演示如何检索具有错误处理的代理用户，以捕获用户不存在的情况。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

使用 -AgentUserId时，返回单个代理用户对象。 使用 -AgentId时，返回代理用户对象的数组。 每个对象都包含 id、displayName、userPrincipalName、mailNickname、accountEnabled 和 identityParentId 等属性。

如果未找到具有指定 ID 的代理用户或代理标识，则 cmdlet 将引发错误。 按代理标识列出时，支持分页检索所有结果。

此 cmdlet 需要以下Microsoft Graph权限：

• User.Read.All