Get-EntraAgentUser

Modul:
Microsoft.Entra.Users Module v1.3

Získá uživatele agenta podle jeho ID nebo zobrazí seznam všech uživatelů agenta připojených k identitě agenta.

Syntax

GetById (Výchozí) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

Rutina Get-EntraAgentUser načte uživatele agenta z Microsoft Graph pomocí rozhraní API verze 1.0. Při použití se -AgentUserIdslužbou vrátí jednoho uživatele agenta. Při použití -AgentIdvrátí všechny uživatele agenta připojeného k zadané identitě agenta. Pokud v sadě parametrů GetById není zadané žádné ID uživatele agenta, použije se v aktuální relaci ID uživatele uloženého agenta nebo se zobrazí výzva k zadání.

Příklady

Příklad 1: Získání uživatele agenta podle ID

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

Tento příklad načte uživatele agenta se zadaným ID.

Příklad 2: Získání uživatele agenta z aktuální relace

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

Tento příklad načte uživatele agenta vytvořeného v aktuální relaci pomocí ID uživatele uloženého agenta.

Příklad 3: Výpis všech uživatelů agenta pro identitu agenta

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

Tento příklad načte všechny uživatele agenta, kteří jsou připojení k zadané identitě agenta.

Příklad 4: Získání uživatele agenta s zpracováním chyb

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

Tento příklad ukazuje, jak načíst uživatele agenta s zpracováním chyb, aby zachytil případy, kdy uživatel neexistuje.

Parametry

-AgentId

ID identity agenta pro načtení připojených uživatelů agenta. Vrátí všechny uživatele agenta, kteří jsou připojení k zadané identitě agenta. Používá se se sadou parametrů GetByAgentId.

Vlastnosti parametru

Typ:System.String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

GetByAgentId
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-AgentUserId

ID uživatele agenta, který se má načíst. Pokud ho nezadáte, použije se ID uživatele uloženého agenta z aktuální relace nebo se zobrazí výzva k zadání. Používá se se sadou parametrů GetById.

Vlastnosti parametru

Typ:System.String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

GetById
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Výstupy

System.Object

Při použití -AgentUserIdvrátí jeden objekt uživatele agenta. Při použití -AgentIdvrátí pole uživatelských objektů agenta. Každý objekt obsahuje vlastnosti, jako je id, displayName, userPrincipalName, mailNickname, accountEnabled a identityParentId.

Poznámky

Pokud není nalezena identita uživatele nebo agenta agenta se zadaným ID, rutina vyvolá chybu. Při výpisu podle identity agenta podporuje stránkování pro načtení všech výsledků.

Tato rutina vyžaduje následující Microsoft Graph oprávnění:

  • User.Read.All