Remove-EntraAgentUser
依據 ID 刪除代理使用者，或刪除所有與代理身份相關的代理使用者。
語法
ByUserId (預設值)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
該Remove-EntraAgentUser指令長會從 Microsoft Entra 中刪除代理使用者。 當與 一起使用 -AgentUserId時，它會依 ID 刪除單一代理使用者。 當與 一起使用 -AgentId時，它會查找並刪除所有與指定代理身份相關的代理使用者。
除非使用交換器，否則 cmdlet 需要確認才能刪除 -Force 。 用 -WhatIf 來預覽哪些使用者會被刪除，而不必實際執行刪除。
範例
範例 1：依 ID 刪除代理使用者
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
此範例刪除了指定 ID 的代理使用者。 您將被提示確認。
範例 2：未經確認就依 ID 刪除代理使用者
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
此範例刪除代理使用者時未要求確認。
範例 3：刪除所有代理使用者以取得代理身份
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force
此範例會查詢所有與指定代理身份相關的代理使用者並刪除它們。
範例 4：使用 WhatIf 進行預覽刪除
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
此範例顯示哪些代理使用者會在未實際刪除的情況下被刪除。
範例 5：帶有錯誤處理的刪除
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: $_"
}
此範例示範如何透過錯誤處理刪除代理使用者。
參數
-AgentId
應刪除與代理使用者相關的代理身份的 ID。 指令檔會查詢所有與該代理身份相關的代理使用者並刪除。 搭配 ByAgentId 參數集合使用。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ByAgentId
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AgentUserId
要刪除的代理使用者的 ID。 搭配 ByUserID 參數設定使用。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ByUserId
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
參數屬性
| 類型: | System.Management.Automation.SwitchParameter |
| 預設值: | True |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 參見 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
刪除前會抑制確認提示。
參數屬性
| 類型: | System.Management.Automation.SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 指令未執行。
參數屬性
| 類型: | System.Management.Automation.SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 威斯康辛 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
輸入
None
輸出
System.Collections.Hashtable
回傳一個雜湊表（或使用 -AgentId時為雜湊表陣列），具有以下屬性：Id、DisplayName、AgentID 和 Status。
備註
此指令小程式需要以下 Microsoft Graph 權限：
- AgentIdUser.ReadWrite.All
該指令小程式需要啟用 Microsoft Entra 連線。 先用 Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' 來連結。
使用 -AgentId時，指令長會先查詢所有與代理身份相關的代理使用者，然後刪除每一個。 若代理身份沒有相關的代理使用者，則會顯示警告。