Get-EntraAgentIdentity

Modul:
Microsoft.Entra.Applications Module v1.3

Hämtar en agentidentitet efter sitt ID eller visar en lista över alla agentidentiteter för en agentidentitetsritning.

Syntax

GetById (Standard) 

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint 

Get-EntraAgentIdentity

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

Description

Cmdleten Get-EntraAgentIdentity hämtar en agentidentitet från Microsoft Graph. När den används med -AgentIdreturneras en enda agentidentitet. När den används med -AgentIdentityBlueprintIdreturneras alla agentidentiteter som är underordnade till den angivna skissen. Om inget skiss-ID anges använder du det lagrade skiss-ID:t från den aktuella sessionen eller frågar efter ett.

Exempel

Exempel 1: Hämta en agentidentitet efter ID

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

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

Exempel 2: Lista alla agentidentiteter för en skiss

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

Det här exemplet hämtar alla agentidentiteter som är underordnade till den angivna agentidentitetsritningen.

Exempel 3: Lista agentidentiteter för den aktuella sessionsritningen

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

I det här exemplet visas alla agentidentiteter för skissen som skapades i den aktuella sessionen med hjälp av det lagrade skiss-ID:t.

Exempel 4: Hämta en agentidentitet med felhantering

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

Det här exemplet visar hur du hämtar en agentidentitet med felhantering för att fånga upp fall där agenten inte finns.

Parametrar

-AgentId

ID:t för agentidentiteten som ska hämtas. 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:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-AgentIdentityBlueprintId

ID:t för agentidentitetsritningen som ska lista underordnade agentidentiteter för. Om det inte anges använder du det lagrade skiss-ID:t från den aktuella sessionen eller frågar efter ett. Används med parameteruppsättningen GetByBlueprint.

Parameteregenskaper

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

Parameteruppsättningar

GetByBlueprint
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 -AgentIdreturnerar ett enda agentidentitetsobjekt. När du använder -AgentIdentityBlueprintIdreturnerar en matris med agentidentitetsobjekt. Varje objekt innehåller egenskaper som id, displayName, appId och servicePrincipalType.

Kommentarer

Om agentidentiteten eller skissen med det angivna ID:t inte hittas utlöser cmdleten ett fel. När du listar efter skiss 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:

  • Application.Read.All