Get-EntraAgentUser

Modul:
Microsoft.Entra.Users Module v1.3

Hämtar en agentanvändare efter dess ID eller visar en lista över alla agentanvändare som är anslutna till en agentidentitet.

Syntax

GetById (Standard) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

Cmdleten Get-EntraAgentUser hämtar agentanvändare från Microsoft Graph med hjälp av v1.0-API:et. När den används med -AgentUserIdreturneras en enskild agentanvändare. När den används med -AgentIdreturneras alla agentanvändare som är anslutna till den angivna agentidentiteten. Om inget agentanvändar-ID anges i parameteruppsättningen GetById använder den lagrade agentens användar-ID från den aktuella sessionen eller frågar efter ett.

Exempel

Exempel 1: Hämta en agentanvändare efter ID

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

Det här exemplet hämtar agentanvändaren med det angivna ID:t.

Exempel 2: Hämta agentanvändaren från den aktuella sessionen

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

Det här exemplet hämtar agentanvändaren som skapades i den aktuella sessionen med hjälp av det lagrade agentanvändar-ID:t.

Exempel 3: Lista alla agentanvändare för en agentidentitet

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

Det här exemplet hämtar alla agentanvändare som är anslutna till den angivna agentidentiteten.

Exempel 4: Hämta en agentanvändare med felhantering

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

Det här exemplet visar hur du hämtar en agentanvändare med felhantering för att fånga upp fall där användaren inte finns.

Parametrar

-AgentId

ID:t för agentidentiteten som ska hämta anslutna agentanvändare för. Returnerar alla agentanvändare som är anslutna till den angivna agentidentiteten. Används med parameteruppsättningen GetByAgentId.

Parameteregenskaper

Typ:System.String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

GetByAgentId
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-AgentUserId

ID:t för agentanvändaren som ska hämtas. Om det inte anges använder du det lagrade agentanvändar-ID:t från den aktuella sessionen eller frågar efter ett. Används med parameteruppsättningen GetById.

Parameteregenskaper

Typ:System.String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

GetById
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

None

Utdata

System.Object

När du använder -AgentUserIdreturnerar ett enda agentanvändarobjekt. När du använder -AgentIdreturnerar en matris med agentanvändarobjekt. Varje objekt innehåller egenskaper som id, displayName, userPrincipalName, mailNickname, accountEnabled och identityParentId.

Kommentarer

Om agentanvändaren eller agentidentiteten med det angivna ID:t inte hittas utlöser cmdleten ett fel. När du listar efter agentidentitet har stöd för sidnumrering för att hämta alla resultat.

Den här cmdleten kräver följande Microsoft Graph behörigheter:

  • User.Read.All