Remove-EntraAgentIdentity
Tar bort en agentidentitet med sitt ID eller tar bort alla agentidentiteter (och deras agentanvändare) som är associerade med en agentidentitetsritning.
Syntax
ByAgentId (Standard)
Remove-EntraAgentIdentity
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBlueprintId
Remove-EntraAgentIdentity
-AgentIdentityBlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten Remove-EntraAgentIdentity tar bort agentidentiteter från Microsoft Entra med hjälp av v1.0-API:et. När den används med -AgentIdtas en enda agentidentitet och eventuella associerade agentanvändare bort. När den används med -AgentIdentityBlueprintIdletar den upp alla agentidentiteter för skissen och tar bort var och en tillsammans med deras associerade agentanvändare.
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 resurser som skulle tas bort utan att faktiskt utföra borttagningen.
Exempel
Exempel 1: Ta bort en agentidentitet efter ID
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
I det här exemplet tas agentidentiteten och eventuella associerade agentanvändare bort.
Exempel 2: Ta bort alla agentidentiteter för en skiss
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force
Det här exemplet letar upp alla agentidentiteter som är associerade med den angivna skissen, tar bort deras agentanvändare och tar sedan bort själva agentidentiteterna.
Exempel 3: Förhandsgranska borttagning med WhatIf
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
Det här exemplet visar vilka agentidentiteter och agentanvändare som skulle tas bort utan att borttagningen utförs.
Exempel 4: Ta bort med felhantering
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: $_"
}
Det här exemplet visar hur du tar bort en agentidentitet med felhantering och inspekterar de borttagna agentanvändarna.
Parametrar
-AgentId
ID:t för agentidentiteten som ska tas bort. Cmdleten tar också bort alla agentanvändare som är associerade med den här agentidentiteten. 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 |
-AgentIdentityBlueprintId
ID:t för agentidentitetsritningen. Alla agentidentiteter som är associerade med den här skissen tas bort tillsammans med deras agentanvändare. Används med parameteruppsättningen ByBlueprintId.
Parameteregenskaper
| Typ: | System.String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ByBlueprintId
| 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 -AgentIdentityBlueprintId) med egenskaper: ID, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (matris med borttagen användarinformation) och Status.
Kommentarer
Den här cmdleten kräver följande Microsoft Graph behörigheter:
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
Cmdleten kräver en aktiv Microsoft Entra anslutning. Använd Connect-Entra med ovanstående omfång för att ansluta först.
När du tar bort en agentidentitet tas alla associerade agentanvändare bort först. Om borttagningen av agentanvändare misslyckas loggas felet, men borttagningen av agentidentiteten fortsätter.
När du använder -AgentIdentityBlueprintIdhar cmdleten stöd för sidnumrering för att hantera skisser med många agentidentiteter.