Remove-EntraAgentIdentity
依據 ID 刪除代理身份，或刪除與代理身份藍圖相關的所有代理身份（及其代理使用者）。
語法
ByAgentId (預設值)
Remove-EntraAgentIdentity
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBlueprintId
Remove-EntraAgentIdentity
-AgentIdentityBlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove-EntraAgentIdentity指令長會使用 v1.0 API 從 Microsoft Entra 中刪除代理身份。 當與 一起使用 -AgentId時，它會刪除單一代理身份及任何相關的代理使用者。 使用 -AgentIdentityBlueprintId時，它會查詢藍圖中所有的代理人身份，並刪除每個代理人及其相關的代理人使用者。
除非使用交換器，否則 cmdlet 需要確認才能刪除 -Force 。 用 -WhatIf 來預覽哪些資源會被刪除，而不必實際執行刪除。
範例
範例 1：依 ID 刪除代理身份
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
此範例刪除代理身份及所有相關的代理使用者。
範例 2：刪除藍圖中所有代理身份
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force
此範例會查詢與指定藍圖相關的所有代理身份，刪除其代理使用者，然後刪除代理身份本身。
範例 3：使用 WhatIf 進行預覽刪除
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
此範例顯示哪些代理身份與代理使用者會在未執行刪除的情況下被刪除。
範例 4：使用錯誤處理的刪除
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: $_"
}
此範例示範如何使用錯誤處理刪除代理身份並檢查已刪除的代理使用者。
參數
-AgentId
要刪除的代理身份 ID。 指令長也會刪除與此代理身份關聯的任何代理使用者。 搭配 ByAgentId 參數集合使用。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ByAgentId
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AgentIdentityBlueprintId
特工身份藍圖的ID。 所有與此藍圖相關的特工身份及其特工使用者都會被刪除。 搭配 ByBlueprintId 參數設定使用。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ByBlueprintId
| 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
回傳一個雜湊表（或使用 -AgentIdentityBlueprintId時為雜湊表陣列），屬性為：Id、DisplayName、AgentIdentityBlueprintId、DeletedAgentUsers（已刪除使用者資訊陣列）及 Status。
備註
此指令小程式需要以下 Microsoft Graph 權限：
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
該指令小程式需要啟用 Microsoft Entra 連線。 先用 Connect-Entra 上述瞄準鏡連接。
刪除代理身份時，所有相關的代理使用者都會先被刪除。 若代理使用者刪除失敗，錯誤會被記錄，但代理身份刪除仍會繼續進行。
使用 -AgentIdentityBlueprintId時，該 cmdlet 支援分頁處理具有多個代理身份的藍圖。