Get-EntraAgentUser

Modul:
Microsoft.Entra.Users Module v1.3

Ruft einen Agent-Benutzer anhand seiner ID ab oder listet alle Agentbenutzer auf, die mit einer Agent-Identität verbunden sind.

Syntax

GetById (Standard) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Beschreibung

Das Get-EntraAgentUser Cmdlet ruft Agentbenutzer mithilfe der v1.0-API von Microsoft Graph ab. Bei Verwendung mit -AgentUserId, wird ein einzelner Agent-Benutzer zurückgegeben. Bei Verwendung mit -AgentId, gibt es alle Agentbenutzer zurück, die mit der angegebenen Agent-Identität verbunden sind. Wenn im Parametersatz "GetById" keine Agent-Benutzer-ID angegeben wird, verwendet sie die gespeicherte Agent-Benutzer-ID aus der aktuellen Sitzung oder fordert sie zur Eingabe auf.

Beispiele

Beispiel 1: Abrufen eines Agent-Benutzers nach ID

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

In diesem Beispiel wird der Agent-Benutzer mit der angegebenen ID abgerufen.

Beispiel 2: Abrufen des Agent-Benutzers aus der aktuellen Sitzung

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

In diesem Beispiel wird der Agent-Benutzer abgerufen, der in der aktuellen Sitzung mithilfe der gespeicherten Agent-Benutzer-ID erstellt wurde.

Beispiel 3: Auflisten aller Agentbenutzer für eine Agent-Identität

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

In diesem Beispiel werden alle Agentbenutzer abgerufen, die mit der angegebenen Agent-Identität verbunden sind.

Beispiel 4: Abrufen eines Agentbenutzers mit Fehlerbehandlung

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

In diesem Beispiel wird veranschaulicht, wie Sie einen Agent-Benutzer mit Fehlerbehandlung abrufen, um Fälle abzufangen, in denen der Benutzer nicht vorhanden ist.

Parameter

-AgentId

Die ID der Agent-Identität, für die verbundene Agentbenutzer abgerufen werden sollen. Gibt alle Agentbenutzer zurück, die mit der angegebenen Agentidentität verbunden sind. Wird mit dem Parametersatz "GetByAgentId" verwendet.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

GetByAgentId
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AgentUserId

Die ID des abzurufenden Agent-Benutzers. Wenn nicht angegeben, verwendet die gespeicherte Agent-Benutzer-ID aus der aktuellen Sitzung oder aufforderungen für eine. Wird mit dem Parametersatz "GetById" verwendet.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

GetById
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Ausgaben

System.Object

Gibt bei Verwendung -AgentUserIdein einzelnes Agent-Benutzerobjekt zurück. Gibt bei Verwendung -AgentIdeines Arrays von Agent-Benutzerobjekten zurück. Jedes Objekt enthält Eigenschaften wie id, displayName, userPrincipalName, mailNickname, accountEnabled und identityParentId.

Hinweise

Wenn der Agent-Benutzer oder die Agent-Identität mit der angegebenen ID nicht gefunden wird, löst das Cmdlet einen Fehler aus. Bei der Auflistung nach Agent-Identität unterstützt die Paginierung, um alle Ergebnisse abzurufen.

Für dieses Cmdlet sind die folgenden Microsoft Graph Berechtigungen erforderlich:

  • User.Read.All