Remove-EntraAgentIdentityBlueprint

刪除代理身份藍圖及其所有相關的代理身份與代理使用者。

語法

Default (預設值)

Remove-EntraAgentIdentityBlueprint

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

Description

該 Remove-EntraAgentIdentityBlueprint cmdlet 會從 Microsoft Entra 執行層疊刪除代理身份藍圖。 這樣做:

  1. 尋找所有與藍圖相關的代理人身份
  2. 對每個代理身份,尋找並刪除所有相關的代理使用者
  3. 刪除每個代理身份
  4. 刪除代理身份藍圖本身

除非使用交換器,否則 cmdlet 需要確認才能刪除 -Force 。 用 -WhatIf 來預覽哪些資源會被刪除,而不必實際執行刪除。

範例

範例 1:刪除藍圖及所有相關資源

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

此範例會刪除藍圖、所有代理身份及所有相關的代理使用者,且未要求確認。

範例 2:使用 WhatIf 進行預覽刪除

Connect-Entra -Scopes 'AgentIdentityBlueprint.ReadWrite.All', 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -WhatIf

此範例顯示哪些資源會在不執行刪除操作的情況下被刪除。

範例三:刪除並確認並檢查結果

Connect-Entra -Scopes 'AgentIdentityBlueprint.ReadWrite.All', 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
$result = Remove-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
Write-Host "Deleted Blueprint: $($result.BlueprintName)"
Write-Host "Deleted $($result.DeletedIdentities.Count) Agent Identity(ies)"
Write-Host "Deleted $($result.DeletedUsers.Count) Agent User(s)"

此範例會以互動式確認刪除藍圖並檢查結果。

參數

-BlueprintId

要刪除的代理身份藍圖的 ID。 指令長會級聯刪除所有與此藍圖相關的代理身份與代理使用者。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
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

回傳一個雜湊表,包含屬性:BlueprintId、BlueprintName、DeletedIdentities(已刪除的代理身份資訊陣列)、DeletedUsers(已刪除的代理使用者資訊陣列)及 Status。

備註

此指令小程式需要以下 Microsoft Graph 權限:

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

該指令小程式需要啟用 Microsoft Entra 連線。 先用 Connect-Entra 上述瞄準鏡連接。

刪除順序:先刪除代理使用者,接著刪除代理身份,最後刪除藍圖本身。 若個別代理使用者或代理身份刪除失敗,會顯示警告,並繼續執行剩餘資源。

當藍圖中有多個代理身份時,指令本支援分頁以確保所有代理身份都能被找到。