Remove-EntraAgentIdentity
按 ID 删除代理标识，或删除与代理标识蓝图关联的所有代理标识（及其代理用户）。
语法
ByAgentId (默认值)
Remove-EntraAgentIdentity
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBlueprintId
Remove-EntraAgentIdentity
-AgentIdentityBlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
该 Remove-EntraAgentIdentity cmdlet 使用 v1.0 API 从 Microsoft Entra中删除代理标识。 使用 -AgentId时，它会删除单个代理标识和任何关联的代理用户。 使用 -AgentIdentityBlueprintId时，它会查找蓝图的所有代理标识，并删除每个代理标识及其关联的代理用户。
除非使用开关，否则 -Force cmdlet 在删除之前需要确认。 用于 -WhatIf 预览将在不实际执行删除的情况下删除哪些资源。
示例
示例 1：按 ID 删除代理标识
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
此示例删除代理标识和任何关联的代理用户。
示例 2：删除蓝图的所有代理标识
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force
此示例查找与指定蓝图关联的所有代理标识，删除其代理用户，然后删除代理标识本身。
示例 3：使用 WhatIf 预览删除
Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf
此示例显示哪些代理标识和代理用户将在不执行删除的情况下删除。
示例 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: $_"
}
此示例演示如何删除代理标识并检查已删除的代理用户错误处理。
参数
-AgentId
要删除的代理标识的 ID。 该 cmdlet 还将删除与此代理标识关联的任何代理用户。 与 ByAgentId 参数集一起使用。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByAgentId
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-AgentIdentityBlueprintId
代理标识蓝图的 ID。 将删除与此蓝图关联的所有代理标识及其代理用户。 与 ByBlueprintId 参数集一起使用。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByBlueprintId
| 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
返回包含属性的哈希表（或哈希表 -AgentIdentityBlueprintId数组）：Id、DisplayName、AgentIdentityBlueprintId、DeletedAgentUsers（已删除的用户信息数组）和状态。
备注
此 cmdlet 需要以下Microsoft Graph权限：
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
该 cmdlet 需要有效的Microsoft Entra连接。 与 Connect-Entra 上述范围一起使用，首先进行连接。
删除代理标识时，首先删除任何关联的代理用户。 如果代理用户删除失败，则会记录错误，但代理标识删除仍在继续。
使用 -AgentIdentityBlueprintId时，cmdlet 支持分页来处理具有多个代理标识的蓝图。