Remove-EntraAgentIdentity

Module:
Microsoft.Entra.Applications Module v1.3

Hiermee verwijdert u een agent-id op basis van de id of verwijdert u alle agentidentiteiten (en de bijbehorende agentgebruikers) die zijn gekoppeld aan een agentidentiteitsblauwdruk.

Syntax

ByAgentId (Standaard) 

Remove-EntraAgentIdentity

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

ByBlueprintId 

Remove-EntraAgentIdentity

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

Description

De Remove-EntraAgentIdentity cmdlet verwijdert agentidentiteiten uit Microsoft Entra met behulp van de v1.0-API. Wanneer deze wordt gebruikt -AgentId, worden één agentidentiteit en eventuele bijbehorende agentgebruikers verwijderd. Wanneer deze wordt gebruikt -AgentIdentityBlueprintId, worden alle agentidentiteiten voor de blauwdruk opgezoekd en worden ze samen met de bijbehorende agentgebruikers verwijderd.

De cmdlet vereist bevestiging voordat u deze verwijdert, tenzij de -Force switch wordt gebruikt. Gebruik -WhatIf dit om een voorbeeld te bekijken van welke resources worden verwijderd zonder de verwijdering daadwerkelijk uit te voeren.

Voorbeelden

Voorbeeld 1: Een agent-id op id verwijderen

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

In dit voorbeeld worden de agentidentiteit en eventuele bijbehorende agentgebruikers verwijderd.

Voorbeeld 2: alle agentidentiteiten voor een blauwdruk verwijderen

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

In dit voorbeeld worden alle agentidentiteiten opgezoekd die zijn gekoppeld aan de opgegeven blauwdruk, worden hun agentgebruikers verwijderd en worden vervolgens de agentidentiteiten zelf verwijderd.

Voorbeeld 3: Preview-verwijdering met WhatIf

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

In dit voorbeeld ziet u welke agentidentiteiten en agentgebruikers worden verwijderd zonder de verwijdering uit te voeren.

Voorbeeld 4: Verwijderen met foutafhandeling

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 dit voorbeeld ziet u hoe u een agentidentiteit verwijdert met foutafhandeling en de verwijderde agentgebruikers inspecteert.

Parameters

-AgentId

De id van de agent-id die moet worden verwijderd. Met de cmdlet worden ook alle agentgebruikers verwijderd die zijn gekoppeld aan deze agentidentiteit. Wordt gebruikt met de parameterset ByAgentId.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByAgentId
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-AgentIdentityBlueprintId

De id van de agentidentiteitsblauwdruk. Alle agentidentiteiten die aan deze blauwdruk zijn gekoppeld, worden samen met hun agentgebruikers verwijderd. Wordt gebruikt met de parameterset ByBlueprintId.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByBlueprintId
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:System.Management.Automation.SwitchParameter
Default value:True
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Onderdrukt de bevestigingsprompt voordat u deze verwijdert.

Parametereigenschappen

Type:System.Management.Automation.SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:System.Management.Automation.SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

Uitvoerwaarden

System.Collections.Hashtable

Retourneert een hashtabel (of matrix met hashtabellen bij gebruik -AgentIdentityBlueprintId) met eigenschappen: Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (matrix met verwijderde gebruikersgegevens) en Status.

Notities

Voor deze cmdlet zijn de volgende Microsoft Graph machtigingen vereist:

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

Voor de cmdlet is een actieve Microsoft Entra-verbinding vereist. Gebruik Connect-Entra deze met de bovenstaande bereiken om eerst verbinding te maken.

Wanneer u een agent-id verwijdert, worden alle gekoppelde agentgebruikers eerst verwijderd. Als het verwijderen van de agentgebruiker mislukt, wordt de fout geregistreerd, maar wordt de agentidentiteit verwijderd.

Wanneer u -AgentIdentityBlueprintIddeze gebruikt, ondersteunt de cmdlet paginering om blauwdrukken met veel agentidentiteiten af te handelen.