Get-EntraAgentIdentity

Modul:
Microsoft.Entra.Applications Module v1.3

Získá identitu agenta podle jeho ID nebo vypíše všechny identity agenta pro podrobný plán identity agenta.

Syntax

GetById (Výchozí) 

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint 

Get-EntraAgentIdentity

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

Description

Rutina Get-EntraAgentIdentity načte identitu agenta z Microsoft Graph. Při použití -AgentIds vrátí jednu identitu agenta. Při použití -AgentIdentityBlueprintIdvrátí všechny identity agenta, které jsou podřízené zadanému podrobnému plánu. Pokud není k dispozici žádné ID podrobného plánu, použije uložené ID podrobného plánu z aktuální relace nebo se zobrazí výzva k zadání.

Příklady

Příklad 1: Získání identity agenta podle ID

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

Tento příklad načte identitu agenta se zadaným ID.

Příklad 2: Výpis všech identit agentů pro podrobný plán

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

Tento příklad načte všechny identity agentů, které jsou podřízené zadanému podrobnému plánu identity agenta.

Příklad 3: Výpis identit agenta pro aktuální podrobný plán relace

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

Tento příklad obsahuje seznam všech identit agentů pro podrobný plán vytvořený v aktuální relaci pomocí uloženého ID podrobného plánu.

Příklad 4: Získání identity agenta s zpracováním chyb

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

Tento příklad ukazuje, jak načíst identitu agenta s zpracováním chyb za účelem zachycení případů, kdy agent neexistuje.

Parametry

-AgentId

ID identity agenta, která se má načíst. Používá se se sadou parametrů GetById.

Vlastnosti parametru

Typ:System.String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

GetById
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-AgentIdentityBlueprintId

ID podrobného plánu identity agenta pro výpis identit podřízených agentů pro. Pokud není zadaný, použije uložené ID podrobného plánu z aktuální relace nebo zobrazí výzvu k zadání. Používá se se sadou parametrů GetByBlueprint.

Vlastnosti parametru

Typ:System.String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

GetByBlueprint
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Výstupy

System.Object

Při použití -AgentIdvrátí jeden objekt identity agenta. Při použití -AgentIdentityBlueprintIdvrátí pole objektů identity agenta. Každý objekt obsahuje vlastnosti, jako je id, displayName, appId a servicePrincipalType.

Poznámky

Pokud se identita agenta nebo podrobný plán se zadaným ID nenajde, rutina vyvolá chybu. Při výpisu podle podrobného plánu podporuje stránkování pro načtení všech výsledků.

Tato rutina vyžaduje následující Microsoft Graph oprávnění:

  • Oprávnění ke čtení všech aplikací