Get-EntraAgentUser

Modul:
Microsoft.Entra.Users Module v1.3

Lekéri az ügynökfelhasználót az azonosítója alapján, vagy felsorolja az ügynökidentitáshoz csatlakoztatott összes ügynökfelhasználót.

Syntax

GetById (Alapértelmezett) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

A Get-EntraAgentUser parancsmag lekéri az ügynökfelhasználókat a Microsoft Graph az 1.0-s verziós API használatával. A használat során -AgentUserIdegyetlen ügynökfelhasználót ad vissza. A használat során -AgentIda megadott ügynökidentitáshoz csatlakoztatott összes ügynökfelhasználót visszaadja. Ha nincs megadva ügynök felhasználói azonosítója a GetById paraméterkészletben, az az aktuális munkamenetben tárolt ügynök felhasználói azonosítóját használja, vagy egy felhasználót kér.

Példák

1. példa: Ügynökfelhasználó lekérése azonosító alapján

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

Ez a példa lekéri az ügynök felhasználóját a megadott azonosítóval.

2. példa: Az ügynök felhasználójának lekérése az aktuális munkamenetből

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

Ez a példa az aktuális munkamenetben létrehozott ügynökfelhasználót kéri le a tárolt ügynök felhasználói azonosítójával.

3. példa: Ügynökidentitás összes ügynökfelhasználójának listázása

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

Ez a példa lekéri az összes ügynökfelhasználót, aki a megadott ügynökidentitáshoz csatlakozik.

4. példa: Ügynökfelhasználó lekérése hibakezeléssel

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

Ez a példa bemutatja, hogyan kérdezhet le egy hibakezeléssel rendelkező ügynökfelhasználót, hogy elkapja azokat az eseteket, amikor a felhasználó nem létezik.

Paraméterek

-AgentId

A csatlakoztatott ügynökfelhasználók lekéréséhez használt ügynöki identitás azonosítója. A megadott ügynökidentitáshoz csatlakozó összes ügynökfelhasználót visszaadja. A GetByAgentId paraméterkészlettel használható.

Paramétertulajdonságok

Típus:System.String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

GetByAgentId
Position:Named
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-AgentUserId

A lekérni kívánt ügynökfelhasználó azonosítója. Ha nincs megadva, használja a tárolt ügynök felhasználói azonosítóját az aktuális munkamenetből, vagy kéri az egyiket. A GetById paraméterkészlettel használható.

Paramétertulajdonságok

Típus:System.String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

GetById
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Kimenetek

System.Object

A használat során -AgentUserIdegyetlen ügynökfelhasználói objektumot ad vissza. A használat során -AgentIdaz ügynök felhasználói objektumainak tömbje lesz visszaadva. Minden objektum olyan tulajdonságokat tartalmaz, mint az azonosító, a displayName, a userPrincipalName, a mailNickname, az accountEnabled és az identityParentId.

Jegyzetek

Ha a megadott azonosítóval rendelkező ügynökfelhasználói vagy ügynökidentitás nem található, a parancsmag hibát jelez. Ha ügynökidentitás szerint listáz, támogatja a lapozást az összes eredmény lekéréséhez.

Ehhez a parancsmaghoz a következő Microsoft Graph engedélyek szükségesek:

  • Felhasználó.Olvass.Mindent