Get-EntraAgentUser

Module:
Microsoft.Entra.Users Module v1.3

Hiermee haalt u een agentgebruiker op met de id of geeft u een lijst weer van alle agentgebruikers die zijn verbonden met een agentidentiteit.

Syntax

GetById (Standaard) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

De Get-EntraAgentUser cmdlet haalt agentgebruikers op uit Microsoft Graph met behulp van de v1.0-API. Wanneer deze wordt gebruikt, -AgentUserIdwordt één agentgebruiker geretourneerd. Wanneer deze wordt gebruikt -AgentId, worden alle agentgebruikers geretourneerd die zijn verbonden met de opgegeven agentidentiteit. Als er geen agentgebruikers-id is opgegeven in de getById-parameterset, wordt de opgeslagen agentgebruikers-id van de huidige sessie gebruikt of wordt er om een gevraagd.

Voorbeelden

Voorbeeld 1: Een agentgebruiker ophalen op id

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

In dit voorbeeld wordt de agentgebruiker met de opgegeven id opgehaald.

Voorbeeld 2: de agentgebruiker ophalen uit de huidige sessie

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 dit voorbeeld wordt de agentgebruiker opgehaald die in de huidige sessie is gemaakt met behulp van de gebruikers-id van de opgeslagen agent.

Voorbeeld 3: alle agentgebruikers weergeven voor een agent-id

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

In dit voorbeeld worden alle agentgebruikers opgehaald die zijn verbonden met de opgegeven agentidentiteit.

Voorbeeld 4: Een agentgebruiker ophalen met foutafhandeling

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 dit voorbeeld ziet u hoe u een agentgebruiker met foutafhandeling ophaalt om gevallen te ondervangen waarin de gebruiker niet bestaat.

Parameters

-AgentId

De id van de agent-id voor het ophalen van verbonden agentgebruikers. Retourneert alle agentgebruikers die zijn verbonden met de opgegeven agentidentiteit. Wordt gebruikt met de parameterset GetByAgentId.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

GetByAgentId
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-AgentUserId

De id van de agentgebruiker die moet worden opgehaald. Als dit niet is opgegeven, gebruikt u de gebruikers-id van de opgeslagen agent uit de huidige sessie of wordt u gevraagd om een id. Wordt gebruikt met de getById-parameterset.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

GetById
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

Uitvoerwaarden

System.Object

Als u dit gebruikt -AgentUserId, wordt één Agent User-object geretourneerd. Als u dit gebruikt -AgentId, wordt een matrix geretourneerd met agentgebruikersobjecten. Elk object bevat eigenschappen zoals id, displayName, userPrincipalName, mailNickname, accountEnabled en identityParentId.

Notities

Als de agentgebruiker of agentidentiteit met de opgegeven id niet wordt gevonden, genereert de cmdlet een fout. Bij vermelding door agentidentiteit ondersteunt paginering om alle resultaten op te halen.

Voor deze cmdlet zijn de volgende Microsoft Graph machtigingen vereist:

  • User.Read.All