Remove-EntraAgentIdentity
Удаляет удостоверение агента по его идентификатору или удаляет все удостоверения агента (и их пользователей агента), связанные с схемой идентификации агента.
Синтаксис
ByAgentId (По умолчанию)
Remove-EntraAgentIdentity
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBlueprintId
Remove-EntraAgentIdentity
-AgentIdentityBlueprintId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Remove-EntraAgentIdentity удаляет удостоверения агента из Microsoft Entra с помощью API версии 1.0. При использовании -AgentIdс ним удаляется один идентификатор агента и все связанные пользователи агента. При использовании -AgentIdentityBlueprintIdон ищет все удостоверения агента для схемы и удаляет каждую из них вместе с соответствующими пользователями агента.
Командлету требуется подтверждение перед удалением -Force , если параметр не используется. Используется -WhatIf для предварительного просмотра, какие ресурсы будут удалены без фактического выполнения удаления.
Примеры
Пример 1. Удаление удостоверения агента по идентификатору
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
Идентификатор удаленного удостоверения агента. Командлет также удаляет всех пользователей агента, связанных с этим удостоверением агента. Используется с набором параметров ByAgentId.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ByAgentId
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AgentIdentityBlueprintId
Идентификатор схемы удостоверения агента. Все удостоверения агента, связанные с этой схемой, будут удалены вместе с пользователями агента. Используется с набором параметров ByBlueprintId.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ByBlueprintId
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | True |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | Cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Подавляет запрос подтверждения перед удалением.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | Wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
None
Выходные данные
System.Collections.Hashtable
Возвращает хэш-таблицу (или массив хэш-таблиц при использовании -AgentIdentityBlueprintId) со свойствами: Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (массив удаленных сведений пользователя) и Состояние.
Примечания
Для этого командлета требуются следующие разрешения Microsoft Graph:
- AgentIdentity.DeleteRestore.All
- AgentIdUser.ReadWrite.All
Для командлета требуется активное Microsoft Entra подключение. Используйте Connect-Entra указанные выше области для первого подключения.
При удалении удостоверения агента сначала удаляются все связанные пользователи агента. Если удаление пользователя агента завершается ошибкой, ошибка регистрируется, но удаление удостоверения агента по-прежнему продолжается.
При использовании -AgentIdentityBlueprintIdкомандлет поддерживает разбиение на страницы для обработки схем с множеством удостоверений агента.