Remove-EntraAgentIdentityBlueprint
エージェント ID ブループリントとそれに関連付けられているすべてのエージェント ID とエージェント ユーザーを削除します。
構文
Default (既定)
Remove-EntraAgentIdentityBlueprint
-BlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-EntraAgentIdentityBlueprint コマンドレットは、Microsoft Entraからエージェント ID ブループリントの連鎖削除を実行します。 それ:
- ブループリントに関連付けられているすべてのエージェント ID を検索します
- エージェント ID ごとに、関連付けられているすべてのエージェント ユーザーを検索して削除します
- 各エージェント ID を削除します
- エージェント ID ブループリント自体を削除します
コマンドレットは、 -Force スイッチを使用しない限り、削除する前に確認が必要です。
-WhatIfを使用して、実際に削除を実行せずに削除されるリソースをプレビューします。
例
例 1: ブループリントとすべての関連リソースを削除する
Connect-Entra -Scopes 'AgentIdentityBlueprint.ReadWrite.All', 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
この例では、確認を求めずに、ブループリント、そのすべてのエージェント ID、および関連するすべてのエージェント ユーザーを削除します。
例 2: WhatIf を使用して削除をプレビューする
Connect-Entra -Scopes 'AgentIdentityBlueprint.ReadWrite.All', 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -WhatIf
この例では、削除を実行せずに削除するリソースを示します。
例 3: 確認を含む削除と結果の検査
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 ブループリントの ID。 このコマンドレットは、このブループリントに関連付けられているすべてのエージェント ID とエージェント ユーザーを連鎖削除します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | True |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
削除する前に確認プロンプトを表示しないようにします。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
None
出力
System.Collections.Hashtable
BlueprintId、BlueprintName、DeletedIdentities (削除されたエージェント ID 情報の配列)、DeletedUsers (削除されたエージェント ユーザー情報の配列)、および Status のプロパティを持つハッシュテーブルを返します。
メモ
このコマンドレットには、次のMicrosoft Graphアクセス許可が必要です。
- AgentIdentityBlueprint.ReadWrite.All
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
このコマンドレットには、アクティブなMicrosoft Entra接続が必要です。 最初に接続するには、上記のスコープで Connect-Entra を使用します。
削除順序: エージェント ユーザーは最初に削除され、次にエージェント ID、最後にブループリント自体が削除されます。 個々のエージェント ユーザーまたはエージェント ID の削除が失敗した場合は、警告が表示され、コマンドレットは残りのリソースを続行します。
ブループリントに多数のエージェント ID がある場合、コマンドレットは改ページ位置をサポートし、すべてが確実に検出されるようにします。