Get-EntraAgentIdentity

Module:
Microsoft.Entra.Applications Module v1.3

Hiermee haalt u een agent-id op met de bijbehorende id of geeft u een lijst weer met alle agentidentiteiten voor een agentidentiteitsblauwdruk.

Syntax

GetById (Standaard) 

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint 

Get-EntraAgentIdentity

    [-AgentIdentityBlueprintId <String>]
    [<CommonParameters>]

Description

Met de Get-EntraAgentIdentity cmdlet wordt een agent-id opgehaald uit Microsoft Graph. Wanneer deze wordt gebruikt, -AgentIdretourneert deze één agentidentiteit. Wanneer deze wordt gebruikt -AgentIdentityBlueprintId, worden alle agentidentiteiten geretourneerd die onderliggende elementen van de opgegeven blauwdruk zijn. Als er geen blauwdruk-id is opgegeven, gebruikt u de opgeslagen blauwdruk-id uit de huidige sessie of wordt u gevraagd om een blauwdruk-id.

Voorbeelden

Voorbeeld 1: Een agent-id ophalen op id

Connect-Entra -Scopes 'Application.Read.All'
Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"

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

Voorbeeld 2: alle agentidentiteiten voor een blauwdruk weergeven

Connect-Entra -Scopes 'Application.Read.All'
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
$agents | ForEach-Object { Write-Host "$($_.displayName) ($($_.id))" }

In dit voorbeeld worden alle agentidentiteiten opgehaald die onderliggende elementen zijn van de opgegeven agentidentiteitsblauwdruk.

Voorbeeld 3: Agentidentiteiten weergeven voor de huidige sessie blueprint

Connect-Entra -Scopes 'Application.Read.All'
New-EntraAgentIdentityBlueprint -DisplayName "My Blueprint" -SponsorUserIds @("admin@contoso.com")
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId
$agents | ForEach-Object { Write-Host "$($_.displayName)" }

In dit voorbeeld worden alle agentidentiteiten weergegeven voor de blauwdruk die in de huidige sessie is gemaakt met behulp van de opgeslagen blauwdruk-id.

Voorbeeld 4: Een agentidentiteit ophalen met foutafhandeling

Connect-Entra -Scopes 'Application.Read.All'
try {
    $agent = Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"
    Write-Host "Agent found: $($agent.displayName)"
} catch {
    Write-Host "Agent not found or error occurred: $_"
}

In dit voorbeeld ziet u hoe u een agentidentiteit met foutafhandeling ophaalt om gevallen te ondervangen waarin de agent niet bestaat.

Parameters

-AgentId

De id van de agent-id die moet worden opgehaald. Wordt gebruikt met de getById-parameterset.

Parametereigenschappen

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

Parametersets

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

-AgentIdentityBlueprintId

De id van de agentidentiteitsblauwdruk voor een lijst met onderliggende agentidentiteiten. Als dit niet is opgegeven, gebruikt u de opgeslagen blauwdruk-id uit de huidige sessie of wordt u gevraagd om een blauwdruk-id. Wordt gebruikt met de getByBlueprint-parameterset.

Parametereigenschappen

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

Parametersets

GetByBlueprint
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 -AgentId, wordt één agentidentiteitsobject geretourneerd. Als u deze functie gebruikt -AgentIdentityBlueprintId, wordt een matrix met agentidentiteitsobjecten geretourneerd. Elk object bevat eigenschappen zoals id, displayName, appId en servicePrincipalType.

Notities

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

Voor deze cmdlet zijn de volgende Microsoft Graph machtigingen vereist:

  • Application.Read.All