Get-EntraAgentUser

모듈:
Microsoft.Entra.Users Module v1.3

해당 ID로 에이전트 사용자를 가져오거나 에이전트 ID에 연결된 모든 에이전트 사용자를 나열합니다.

구문

GetById (기본값) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

cmdlet은 Get-EntraAgentUser v1.0 API를 사용하여 Microsoft Graph 에이전트 사용자를 검색합니다. 함께 -AgentUserId사용하면 단일 에이전트 사용자를 반환합니다. 함께 -AgentId사용하면 지정된 에이전트 ID에 연결된 모든 에이전트 사용자를 반환합니다. GetById 매개 변수 집합에 에이전트 사용자 ID가 제공되지 않으면 현재 세션의 저장된 에이전트 사용자 ID를 사용하거나 메시지를 표시합니다.

예제

예제 1: ID로 에이전트 사용자 가져오기

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

이 예제에서는 지정된 ID를 사용하여 에이전트 사용자를 검색합니다.

예제 2: 현재 세션에서 에이전트 사용자 가져오기

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를 사용하여 현재 세션에서 만든 에이전트 사용자를 검색하는 예제입니다.

예제 3: 에이전트 ID에 대한 모든 에이전트 사용자 나열

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

이 예제에서는 지정된 에이전트 ID에 연결된 모든 에이전트 사용자를 검색합니다.

예제 4: 오류 처리가 있는 에이전트 사용자 가져오기

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

이 예제에서는 오류 처리가 있는 에이전트 사용자를 검색하여 사용자가 없는 경우를 catch하는 방법을 보여 줍니다.

매개 변수

-AgentId

연결된 에이전트 사용자를 검색할 에이전트 ID입니다. 지정된 에이전트 ID에 연결된 모든 에이전트 사용자를 반환합니다. GetByAgentId 매개 변수 집합과 함께 사용됩니다.

매개 변수 속성

형식:System.String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

GetByAgentId
Position:Named
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-AgentUserId

검색할 에이전트 사용자의 ID입니다. 제공되지 않은 경우 현재 세션의 저장된 에이전트 사용자 ID를 사용하거나 메시지를 표시합니다. GetById 매개 변수 집합과 함께 사용됩니다.

매개 변수 속성

형식:System.String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

GetById
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

CommonParameters

이 cmdlet은 일반적인 매개 변수인 -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction 및 -WarningVariable 매개 변수를 지원합니다. 자세한 내용은 about_CommonParameters를 참조하세요.

입력

None

출력

System.Object

사용하는 -AgentUserId경우 단일 에이전트 사용자 개체를 반환합니다. 사용하는 -AgentId경우 에이전트 사용자 개체의 배열을 반환합니다. 각 개체에는 id, displayName, userPrincipalName, mailNickname, accountEnabled 및 identityParentId와 같은 속성이 포함됩니다.

참고

지정된 ID를 가진 에이전트 사용자 또는 에이전트 ID를 찾을 수 없으면 cmdlet에서 오류가 발생합니다. 에이전트 ID별로 나열할 때 모든 결과를 검색하기 위한 페이지 매김을 지원합니다.

이 cmdlet에는 다음 Microsoft Graph 권한이 필요합니다.

  • User.Read.All (사용자 읽기 권한 전체)