Remove-EntraAgentUser

Module:
Microsoft.Entra.Users Module v1.3

Hiermee verwijdert u een agentgebruiker op basis van de id of verwijdert u alle agentgebruikers die zijn gekoppeld aan een agent-id.

Syntax

ByUserId (Standaard) 

Remove-EntraAgentUser

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

ByAgentId 

Remove-EntraAgentUser

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

Description

De Remove-EntraAgentUser cmdlet verwijdert agentgebruikers uit Microsoft Entra. Wanneer deze wordt gebruikt -AgentUserId, wordt één agentgebruiker per id verwijderd. Wanneer deze wordt gebruikt -AgentId, worden alle agentgebruikers opgezoekt en verwijderd die zijn gekoppeld aan de opgegeven agentidentiteit.

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

Voorbeelden

Voorbeeld 1: Een agentgebruiker verwijderen op id

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

In dit voorbeeld wordt de agentgebruiker met de opgegeven id verwijderd. U wordt om bevestiging gevraagd.

Voorbeeld 2: een agentgebruiker verwijderen op id zonder bevestiging

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

In dit voorbeeld wordt de agentgebruiker verwijderd zonder te vragen om bevestiging.

Voorbeeld 3: alle agentgebruikers verwijderen voor een agent-id

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force

In dit voorbeeld worden alle agentgebruikers opgezoekd die zijn gekoppeld aan de opgegeven agentidentiteit en worden ze verwijderd.

Voorbeeld 4: Preview-verwijdering met WhatIf

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

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

Voorbeeld 5: Verwijderen met foutafhandeling

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 dit voorbeeld ziet u hoe u een agentgebruiker verwijdert met foutafhandeling.

Parameters

-AgentId

De id van de agent-id waarvan de bijbehorende agentgebruikers moeten worden verwijderd. Met de cmdlet worden alle agentgebruikers opgezoekd die zijn verbonden met deze agentidentiteit en worden ze verwijderd. 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

-AgentUserId

De id van de agentgebruiker die moet worden verwijderd. Wordt gebruikt met de parameterset ByUserId.

Parametereigenschappen

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

Parametersets

ByUserId
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 -AgentId) met de volgende eigenschappen: Id, DisplayName, AgentId en Status.

Notities

Voor deze cmdlet zijn de volgende Microsoft Graph machtigingen vereist:

  • AgentIdUser.ReadWrite.All

Voor de cmdlet is een actieve Microsoft Entra-verbinding vereist. Gebruik Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' dit om eerst verbinding te maken.

Wanneer u de cmdlet gebruikt -AgentId, worden de eerste query's uitgevoerd voor alle agentgebruikers die zijn gekoppeld aan de agentidentiteit en worden vervolgens elke query verwijderd. Als de agentidentiteit geen gekoppelde agentgebruikers heeft, wordt er een waarschuwing weergegeven.