Remove-EntraAgentUser
Tar bort en agentanvändare med dess ID eller tar bort alla agentanvändare som är associerade med en agentidentitet.
Syntax
ByUserId (Standard)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten Remove-EntraAgentUser tar bort agentanvändare från Microsoft Entra. När den används med -AgentUserIdtas en enskild agentanvändare bort efter ID. När den används med -AgentIdletar den upp och tar bort alla agentanvändare som är associerade med den angivna agentidentiteten.
Cmdleten kräver bekräftelse innan du tar bort om inte växeln -Force används. Använd -WhatIf för att förhandsgranska vilka användare som skulle tas bort utan att faktiskt utföra borttagningen.
Exempel
Exempel 1: Ta bort en agentanvändare efter ID
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
I det här exemplet tas agentanvändaren bort med det angivna ID:t. Du uppmanas att bekräfta.
Exempel 2: Ta bort en agentanvändare efter ID utan bekräftelse
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
Det här exemplet tar bort agentanvändaren utan att fråga efter bekräftelse.
Exempel 3: Ta bort alla agentanvändare för en agentidentitet
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force
Det här exemplet söker upp alla agentanvändare som är associerade med den angivna agentidentiteten och tar bort dem.
Exempel 4: Förhandsgranska borttagning med WhatIf
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
Det här exemplet visar vilka agentanvändare som skulle tas bort utan att faktiskt utföra borttagningen.
Exempel 5: Ta bort med felhantering
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: $_"
}
Det här exemplet visar hur du tar bort en agentanvändare med felhantering.
Parametrar
-AgentId
ID:t för agentidentiteten vars associerade agentanvändare ska tas bort. Cmdleten söker upp alla agentanvändare som är anslutna till den här agentidentiteten och tar bort dem. Används med parameteruppsättningen ByAgentId.
Parameteregenskaper
| Typ: | System.String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ByAgentId
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-AgentUserId
ID:t för agentanvändaren som ska tas bort. Används med parameteruppsättningen ByUserId.
Parameteregenskaper
| Typ: | System.String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ByUserId
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
| Typ: | System.Management.Automation.SwitchParameter |
| Standardvärde: | True |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | jfr |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Force
Undertrycker bekräftelseprompten innan den tas bort.
Parameteregenskaper
| Typ: | System.Management.Automation.SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-WhatIf
Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.
Parameteregenskaper
| Typ: | System.Management.Automation.SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | Wi |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
None
Utdata
System.Collections.Hashtable
Returnerar en hashtable (eller matris med hashtables när du använder -AgentId) med följande egenskaper: ID, DisplayName, AgentId och Status.
Kommentarer
Den här cmdleten kräver följande Microsoft Graph behörigheter:
- AgentIdUser.ReadWrite.All
Cmdleten kräver en aktiv Microsoft Entra anslutning. Använd Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' för att ansluta först.
När du använder -AgentIdtar cmdleten först frågor till alla agentanvändare som är associerade med agentidentiteten och tar sedan bort var och en. Om agentidentiteten inte har några associerade agentanvändare visas en varning.