Remove-EntraAgentIdentity

Modul:
Microsoft.Entra.Applications Module v1.3

Odstraní identitu agenta podle jeho ID nebo odstraní všechny identity agenta (a jejich uživatele agenta) přidružené k podrobnému plánu identity agenta.

Syntax

ByAgentId (Výchozí) 

Remove-EntraAgentIdentity

    -AgentId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByBlueprintId 

Remove-EntraAgentIdentity

    -AgentIdentityBlueprintId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Rutina Remove-EntraAgentIdentity odstraní identity agentů z Microsoft Entra pomocí rozhraní API verze 1.0. Při použití -AgentIdse odstraní jedna identita agenta a všechny přidružené uživatele agenta. Při použití -AgentIdentityBlueprintIdvyhledá všechny identity agenta podrobného plánu a odstraní každou z nich spolu s přidruženými uživateli agenta.

Rutina vyžaduje potvrzení před odstraněním -Force , pokud se přepínač nepoužívá. Umožňuje -WhatIf zobrazit náhled prostředků, které by se odstranily bez skutečného provedení odstranění.

Příklady

Příklad 1: Odstranění identity agenta podle ID

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

Tento příklad odstraní identitu agenta a všechny přidružené uživatele agenta.

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

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force

Tento příklad vyhledá všechny identity agentů přidružené k zadanému podrobnému plánu, odstraní jejich uživatele agenta a pak odstraní identity agenta samotné.

Příklad 3: Odstranění náhledu pomocí whatIf

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

Tento příklad ukazuje, které identity agentů a uživatelé agentů by se odstranily bez provedení odstranění.

Příklad 4: Odstranění s využitím zpracování chyb

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
try {
    $result = Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
    Write-Host "Deleted Agent Identity: $($result.DisplayName)"
    Write-Host "Also deleted $($result.DeletedAgentUsers.Count) Agent User(s)"
} catch {
    Write-Host "Failed to delete: $_"
}

Tento příklad ukazuje, jak odstranit identitu agenta se zpracováním chyb a zkontrolovat odstraněné uživatele agenta.

Parametry

-AgentId

ID identity agenta, která se má odstranit. Tato rutina také odstraní všechny uživatele agenta přidruženého k této identitě agenta. Používá se se sadou parametrů ByAgentId.

Vlastnosti parametru

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

Sady parametrů

ByAgentId
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. Všechny identity agentů přidružené k tomuto podrobnému plánu budou odstraněny společně s jejich uživateli agenta. Používá se se sadou parametrů ByBlueprintId.

Vlastnosti parametru

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

Sady parametrů

ByBlueprintId
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

-Confirm

Před spuštěním cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:System.Management.Automation.SwitchParameter
Default value:True
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
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

-Force

Potlačí výzvu k potvrzení před odstraněním.

Vlastnosti parametru

Typ:System.Management.Automation.SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
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

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:System.Management.Automation.SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
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.Collections.Hashtable

Vrátí hashtable (nebo pole hashtables při použití -AgentIdentityBlueprintId) s vlastnostmi: Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (pole odstraněných informací o uživateli) a Status.

Poznámky

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

  • AgentIdentity.DeleteRestore.All
  • AgentIdUser.ReadWrite.All

Rutina vyžaduje aktivní Microsoft Entra připojení. První připojení použijte Connect-Entra s výše uvedenými obory.

Při odstraňování identity agenta se nejprve odstraní všichni přidružení uživatelé agenta. Pokud se odstranění uživatele agenta nezdaří, chyba se zaprotokoluje, ale odstranění identity agenta stále pokračuje.

Při použití -AgentIdentityBlueprintIdrutina podporuje stránkování pro zpracování podrobných plánů s mnoha identitami agenta.