Remove-EntraAgentIdentity

Modul:
Microsoft.Entra.Applications Module v1.3

Törli az ügynökidentitást az azonosítója alapján, vagy törli az ügynökidentitás-tervhez társított összes ügynökidentitást (és azok ügynökfelhasználóit).

Syntax

ByAgentId (Alapértelmezett) 

Remove-EntraAgentIdentity

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

ByBlueprintId 

Remove-EntraAgentIdentity

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

Description

A Remove-EntraAgentIdentity parancsmag törli az ügynökidentitásokat a Microsoft Entra az 1.0-s verziós API használatával. A használat során -AgentIdegyetlen ügynökidentitást és minden társított ügynökfelhasználót töröl. A használat során -AgentIdentityBlueprintIdmegkeresi a terv összes ügynökidentitását, és törli őket a társított ügynökfelhasználókkal együtt.

A parancsmag a törlés előtt megerősítést igényel, kivéve, ha a -Force kapcsolót használja. Itt -WhatIf tekintheti meg, hogy mely erőforrásokat törölné a rendszer anélkül, hogy ténylegesen végrehajtaná a törlést.

Példák

1. példa: Ügynökidentitás törlése azonosító alapján

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

Ez a példa törli az ügynökidentitást és a társított ügynökfelhasználókat.

2. példa: Terv összes ügynökidentitásának törlése

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

Ez a példa megkeresi a megadott tervhez társított összes ügynökidentitást, törli az ügynökfelhasználókat, majd maga törli az ügynökidentitásokat.

3. példa: Törlés előnézete a WhatIf használatával

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

Ez a példa azt mutatja be, hogy mely ügynökidentitásokat és ügynökfelhasználókat törölné a rendszer a törlés végrehajtása nélkül.

4. példa: Törlés hibakezeléssel

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

Ez a példa bemutatja, hogyan törölhet egy ügynökidentitást hibakezeléssel, és hogyan vizsgálhatja meg a törölt ügynökfelhasználókat.

Paraméterek

-AgentId

A törölni kívánt ügynökidentitás azonosítója. A parancsmag az ügynökidentitáshoz társított ügynökfelhasználók adatait is törli. A ByAgentId paraméterkészlettel használható.

Paramétertulajdonságok

Típus:System.String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

ByAgentId
Position:Named
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-AgentIdentityBlueprintId

Az ügynökidentitás-terv azonosítója. A tervhez társított ügynökidentitások az ügynökfelhasználókkal együtt törlődnek. A ByBlueprintId paraméterkészlettel használható.

Paramétertulajdonságok

Típus:System.String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

ByBlueprintId
Position:Named
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Confirm

Megerősítést kér a parancsmag futtatása előtt.

Paramétertulajdonságok

Típus:System.Management.Automation.SwitchParameter
Alapértelmezett érték:True
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Cf

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Force

Törlés előtt letiltja a megerősítési kérést.

Paramétertulajdonságok

Típus:System.Management.Automation.SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-WhatIf

Megjeleníti, mi történne, ha a parancsmag futna. A parancsmag nem fut.

Paramétertulajdonságok

Típus:System.Management.Automation.SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Wi

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Kimenetek

System.Collections.Hashtable

A következő tulajdonságokkal rendelkező kivonatolót (vagy ha használja -AgentIdentityBlueprintIda kivonattáblákat) ad vissza: Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (törölt felhasználói adatok tömbje) és Állapot.

Jegyzetek

Ehhez a parancsmaghoz a következő Microsoft Graph engedélyek szükségesek:

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

A parancsmag aktív Microsoft Entra kapcsolatot igényel. Először Connect-Entra a fenti hatókörökkel csatlakozhat.

Ügynökidentitás törlésekor a rendszer először törli a társított ügynökfelhasználókat. Ha az ügynökfelhasználó törlése sikertelen, a rendszer naplózza a hibát, de az ügynökidentitás törlése továbbra is folytatódik.

Ha ezt használja -AgentIdentityBlueprintId, a parancsmag támogatja a lapozást a sok ügynökidentitású terv kezeléséhez.