Remove-EntraAgentUser
Odstraní uživatele agenta podle jeho ID nebo odstraní všechny uživatele agenta přidruženého k identitě agenta.
Syntax
ByUserId (Výchozí)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Remove-EntraAgentUser odstraní uživatele agenta z Microsoft Entra. Při použití s -AgentUserIdnástrojem odstraní jednoho uživatele agenta podle ID. Při použití -AgentIdse vyhledá a odstraní všechny uživatele agenta přidruženého k zadané identitě agenta.
Rutina vyžaduje potvrzení před odstraněním -Force , pokud se přepínač nepoužívá. Umožňuje -WhatIf zobrazit náhled uživatelů, kteří by se odstranili, aniž by skutečně provedli odstranění.
Příklady
Příklad 1: Odstranění uživatele agenta podle ID
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
Tento příklad odstraní uživatele agenta se zadaným ID. Zobrazí se výzva k potvrzení.
Příklad 2: Odstranění uživatele agenta podle ID bez potvrzení
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
Tento příklad odstraní uživatele agenta bez výzvy k potvrzení.
Příklad 3: Odstranění všech uživatelů agenta pro identitu agenta
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force
Tento příklad vyhledá všechny uživatele agenta přidruženého k zadané identitě agenta a odstraní je.
Příklad 4: Odstranění náhledu pomocí whatIf
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
Tento příklad ukazuje, kteří uživatelé agenta by se odstranili bez skutečného provedení odstranění.
Příklad 5: Odstranění s využitím zpracování chyb
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: $_"
}
Tento příklad ukazuje, jak odstranit uživatele agenta s zpracováním chyb.
Parametry
-AgentId
ID identity agenta, jejíž přidružení uživatelé agenta by měli být odstraněni. Rutina vyhledá všechny uživatele agenta připojeného k této identitě agenta a odstraní je. Používá se se sadou parametrů ByAgentId.
Vlastnosti parametru
| Typ: | System.String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
ByAgentId
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-AgentUserId
ID uživatele agenta, který chcete odstranit. Používá se se sadou parametrů ByUserId.
Vlastnosti parametru
| Typ: | System.String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
ByUserId
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | System.Management.Automation.SwitchParameter |
| Default value: | True |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Potlačí výzvu k potvrzení před odstraněním.
Vlastnosti parametru
| Typ: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.
Vlastnosti parametru
| Typ: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
None
Výstupy
System.Collections.Hashtable
Vrátí hashtable (nebo pole hashtables při použití -AgentId) s následujícími vlastnostmi: ID, DisplayName, AgentId a Status.
Poznámky
Tato rutina vyžaduje následující Microsoft Graph oprávnění:
- AgentIdUser.ReadWrite.All
Rutina vyžaduje aktivní Microsoft Entra připojení. Slouží Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' k prvnímu připojení.
Při použití -AgentIdse rutina nejprve dotazuje na všechny uživatele agenta přidruženého k identitě agenta a každou z nich odstraní. Pokud identita agenta nemá přidruženého uživatele agenta, zobrazí se upozornění.