Remove-EntraAgentIdentity
エージェント ID を ID で削除するか、エージェント ID ブループリントに関連付けられているすべてのエージェント ID (およびそのエージェント ユーザー) を削除します。
構文
ByAgentId (既定)
Remove-EntraAgentIdentity
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBlueprintId
Remove-EntraAgentIdentity
-AgentIdentityBlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-EntraAgentIdentity コマンドレットは、v1.0 API を使用してMicrosoft Entraからエージェント ID を削除します。
-AgentIdと共に使用すると、1 つのエージェント ID と関連付けられているエージェント ユーザーが削除されます。
-AgentIdentityBlueprintIdと共に使用すると、ブループリントのすべてのエージェント ID が検索され、関連付けられているエージェント ユーザーと共に各エージェント ID が削除されます。
コマンドレットは、 -Force スイッチを使用しない限り、削除する前に確認が必要です。
-WhatIfを使用して、実際に削除を実行せずに削除されるリソースをプレビューします。
例
例 1: ID によるエージェント ID の削除
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
次の使用例は、エージェント ID と関連するエージェント ユーザーを削除します。
例 2: ブループリントのすべてのエージェント ID を削除する
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force
この例では、指定したブループリントに関連付けられているすべてのエージェント ID を検索し、そのエージェント ユーザーを削除してから、エージェント ID 自体を削除します。
例 3: WhatIf を使用して削除をプレビューする
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
この例では、削除を実行せずに削除されるエージェント ID とエージェント ユーザーを示します。
例 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: $_"
}
この例では、エラー処理を使用してエージェント ID を削除し、削除されたエージェント ユーザーを検査する方法を示します。
パラメーター
-AgentId
削除するエージェント ID の ID。 このコマンドレットは、このエージェント ID に関連付けられているエージェント ユーザーも削除します。 ByAgentId パラメーター セットと共に使用されます。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByAgentId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AgentIdentityBlueprintId
エージェント ID ブループリントの ID。 このブループリントに関連付けられているすべてのエージェント ID は、エージェント ユーザーと共に削除されます。 ByBlueprintId パラメーター セットと共に使用されます。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByBlueprintId
| 配置: | 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
Id、DisplayName、AgentIdentityBlueprintId、DeletedAgentUsers (削除されたユーザー情報の配列)、Status のプロパティを持つハッシュテーブル (または -AgentIdentityBlueprintIdを使用する場合はハッシュテーブルの配列) を返します。
メモ
このコマンドレットには、次のMicrosoft Graphアクセス許可が必要です。
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
このコマンドレットには、アクティブなMicrosoft Entra接続が必要です。 最初に接続するには、上記のスコープで Connect-Entra を使用します。
エージェント ID を削除すると、関連付けられているすべてのエージェント ユーザーが最初に削除されます。 エージェント ユーザーの削除が失敗した場合、エラーはログに記録されますが、エージェント ID の削除は続行されます。
-AgentIdentityBlueprintIdを使用する場合、コマンドレットは、多数のエージェント ID を持つブループリントを処理するための改ページ処理をサポートします。