Remove-EntraAgentIdentity

Modul:
Microsoft.Entra.Applications Module v1.3

Löscht eine Agent-Identität anhand ihrer ID oder löscht alle Agentidentitäten (und deren Agentbenutzer), die einem Agent Identity Blueprint zugeordnet sind.

Syntax

ByAgentId (Standard) 

Remove-EntraAgentIdentity

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

ByBlueprintId 

Remove-EntraAgentIdentity

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

Beschreibung

Das Remove-EntraAgentIdentity Cmdlet löscht Agentidentitäten aus Microsoft Entra mithilfe der v1.0-API. Bei Verwendung mit -AgentId, löscht sie eine einzelne Agent-Identität und alle zugehörigen Agent-Benutzer. Bei Verwendung mit -AgentIdentityBlueprintId, sucht es alle Agent-Identitäten für den Blueprint und löscht die einzelnen Identitäten zusammen mit ihren zugeordneten Agent-Benutzern.

Das Cmdlet erfordert eine Bestätigung vor dem Löschen, es sei denn, der -Force Switch wird verwendet. Hier können Sie -WhatIf eine Vorschau anzeigen, welche Ressourcen gelöscht werden, ohne die Löschung tatsächlich auszuführen.

Beispiele

Beispiel 1: Löschen einer Agentidentität nach ID

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

In diesem Beispiel werden die Agent-Identität und alle zugehörigen Agent-Benutzer gelöscht.

Beispiel 2: Löschen aller Agentidentitäten für einen Blueprint

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

In diesem Beispiel werden alle Agentidentitäten nachschlagen, die dem angegebenen Blueprint zugeordnet sind, deren Agentbenutzer gelöscht und dann die Agentidentitäten selbst gelöscht.

Beispiel 3: Vorschaulöschung mit WhatIf

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

In diesem Beispiel wird gezeigt, welche Agentidentitäten und Agentbenutzer gelöscht werden, ohne die Löschung auszuführen.

Beispiel 4: Löschen mit Fehlerbehandlung

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

In diesem Beispiel wird veranschaulicht, wie Sie eine Agent-Identität mit Fehlerbehandlung löschen und die gelöschten Agent-Benutzer überprüfen.

Parameter

-AgentId

Die ID der zu löschenden Agentidentität. Das Cmdlet löscht auch alle Agentbenutzer, die dieser Agent-Identität zugeordnet sind. Wird mit dem ByAgentId-Parametersatz verwendet.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByAgentId
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AgentIdentityBlueprintId

Die ID des Agent Identity Blueprint. Alle agent-Identitäten, die diesem Blueprint zugeordnet sind, werden zusammen mit ihren Agent-Benutzern gelöscht. Wird mit dem Parametersatz ByBlueprintId verwendet.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByBlueprintId
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:True
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Cf

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Force

Unterdrückt die Bestätigungsaufforderung vor dem Löschen.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Ausgaben

System.Collections.Hashtable

Gibt eine Hashtabelle (oder ein Array von Hashtables bei Verwendung -AgentIdentityBlueprintId) mit Eigenschaften zurück: ID, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (Array von gelöschten Benutzerinformationen) und Status.

Hinweise

Für dieses Cmdlet sind die folgenden Microsoft Graph Berechtigungen erforderlich:

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

Für das Cmdlet ist eine aktive Microsoft Entra Verbindung erforderlich. Wird Connect-Entra mit den oben genannten Bereichen verwendet, um zuerst eine Verbindung herzustellen.

Beim Löschen einer Agent-Identität werden alle zugehörigen Agent-Benutzer zuerst gelöscht. Wenn der Löschvorgang des Agent-Benutzers fehlschlägt, wird der Fehler protokolliert, der Löschvorgang der Agentidentität wird jedoch weiterhin fortgesetzt.

Bei Verwendung -AgentIdentityBlueprintIdunterstützt das Cmdlet die Paginierung zur Behandlung von Blueprints mit vielen Agentidentitäten.