Remove-EntraAgentUser

モジュール:
Microsoft.Entra.Users Module v1.3

エージェント ユーザーを ID で削除するか、エージェント ID に関連付けられているすべてのエージェント ユーザーを削除します。

構文

ByUserId (既定) 

Remove-EntraAgentUser

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

ByAgentId 

Remove-EntraAgentUser

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

説明

Remove-EntraAgentUser コマンドレットは、エージェント ユーザーをMicrosoft Entraから削除します。 -AgentUserIdと共に使用すると、ID によって単一のエージェント ユーザーが削除されます。 -AgentIdと共に使用すると、指定したエージェント ID に関連付けられているすべてのエージェント ユーザーを検索して削除します。

コマンドレットは、 -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: エージェント ID のすべてのエージェント ユーザーを削除する

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force

次の使用例は、指定したエージェント ID に関連付けられているすべてのエージェント ユーザーを検索して削除します。

例 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 の ID。 このコマンドレットは、このエージェント ID に接続されているすべてのエージェント ユーザーを検索して削除します。 ByAgentId パラメーター セットと共に使用されます。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByAgentId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AgentUserId

削除するエージェント ユーザーの ID。 ByUserId パラメーター セットと共に使用されます。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByUserId
配置: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、AgentId、Status の各プロパティを持つハッシュテーブル (または、 -AgentIdを使用する場合はハッシュテーブルの配列) を返します。

メモ

このコマンドレットには、次のMicrosoft Graphアクセス許可が必要です。

  • AgentIdUser.ReadWrite.All

このコマンドレットには、アクティブなMicrosoft Entra接続が必要です。 最初に接続するには、 Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' を使用します。

-AgentIdを使用する場合、コマンドレットは最初にエージェント ID に関連付けられているすべてのエージェント ユーザーに対してクエリを実行してから、それぞれを削除します。 エージェント ID にエージェント ユーザーが関連付けられていない場合は、警告が表示されます。