Remove-EntraAgentUser
Löscht einen Agent-Benutzer anhand seiner ID oder löscht alle Agentbenutzer, die einer Agent-Identität zugeordnet sind.
Syntax
ByUserId (Standard)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das Remove-EntraAgentUser Cmdlet löscht Agentbenutzer aus Microsoft Entra. Bei Verwendung mit -AgentUserId, löscht es einen einzelnen Agent-Benutzer nach ID. Bei Verwendung mit -AgentId, sucht und löscht er alle Agentbenutzer, die der angegebenen Agent-Identität zugeordnet sind.
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, die Benutzer löschen würden, ohne die Löschung tatsächlich auszuführen.
Beispiele
Beispiel 1: Löschen eines Agent-Benutzers nach ID
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
In diesem Beispiel wird der Agent-Benutzer mit der angegebenen ID gelöscht. Sie werden zur Bestätigung aufgefordert.
Beispiel 2: Löschen eines Agent-Benutzers nach ID ohne Bestätigung
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
In diesem Beispiel wird der Agent-Benutzer gelöscht, ohne zur Bestätigung aufzufordern.
Beispiel 3: Löschen aller Agentbenutzer für eine Agent-Identität
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force
In diesem Beispiel werden alle Agentbenutzer, die der angegebenen Agent-Identität zugeordnet sind, nachschlagen und gelöscht.
Beispiel 4: Vorschaulöschung mit WhatIf
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
In diesem Beispiel wird gezeigt, welche Agent-Benutzer gelöscht werden würden, ohne die Löschung tatsächlich auszuführen.
Beispiel 5: Löschen mit Fehlerbehandlung
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
try {
$result = Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
Write-Host "Deleted: $($result.DisplayName)"
} catch {
Write-Host "Failed to delete: $_"
}
In diesem Beispiel wird veranschaulicht, wie ein Agent-Benutzer mit Fehlerbehandlung gelöscht wird.
Parameter
-AgentId
Die ID der Agent-Identität, deren zugeordnete Agentbenutzer gelöscht werden sollen. Das Cmdlet sucht alle Agentbenutzer, die mit dieser Agent-Identität verbunden sind, und löscht sie. 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 |
-AgentUserId
Die ID des zu löschenden Agent-Benutzers. Wird mit dem Parametersatz ByUserId verwendet.
Parametereigenschaften
| Typ: | System.String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
ByUserId
| 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 -AgentId) mit den folgenden Eigenschaften zurück: ID, DisplayName, AgentId und Status.
Hinweise
Für dieses Cmdlet sind die folgenden Microsoft Graph Berechtigungen erforderlich:
- AgentIdUser.ReadWrite.All
Für das Cmdlet ist eine aktive Microsoft Entra Verbindung erforderlich. Wird Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' verwendet, um zuerst eine Verbindung herzustellen.
Bei Verwendung -AgentIdfragt das Cmdlet zuerst alle Agentbenutzer ab, die der Agent-Identität zugeordnet sind, und löscht dann jede. Wenn die Agent-Identität keine Agentbenutzer zugeordnet hat, wird eine Warnung angezeigt.