Remove-EntraAgentUser
按其 ID 删除代理用户，或删除与代理标识关联的所有代理用户。
语法
ByUserId (默认值)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
该 Remove-EntraAgentUser cmdlet 从Microsoft Entra中删除代理用户。 使用 -AgentUserId时，它会按 ID 删除单个代理用户。 使用 -AgentId时，它会查找并删除与指定代理标识关联的所有代理用户。
除非使用开关，否则 -Force cmdlet 在删除之前需要确认。 用于 -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：删除代理标识的所有代理用户
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force
此示例查找与指定代理标识关联的所有代理用户并删除它们。
示例 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。 该 cmdlet 查找连接到此代理标识的所有代理用户，并将其删除。 与 ByAgentId 参数集一起使用。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByAgentId
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-AgentUserId
要删除的代理用户的 ID。 与 ByUserId 参数集一起使用。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByUserId
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前，提示你进行确认。
参数属性
| 类型: | System.Management.Automation.SwitchParameter |
| 默认值: | True |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | Cf |
参数集
(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
使用以下属性返回哈希表（或哈希表 -AgentId数组）：ID、DisplayName、AgentId 和 Status。
备注
此 cmdlet 需要以下Microsoft Graph权限：
- AgentIdUser.ReadWrite.All
该 cmdlet 需要有效的Microsoft Entra连接。 用于 Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' 先连接。
使用 -AgentId时，该 cmdlet 首先查询与代理标识关联的所有代理用户，然后删除每个代理用户。 如果代理标识没有关联的代理用户，则会显示警告。