Remove-EntraAgentUser
Удаляет пользователя агента по идентификатору или удаляет всех пользователей агента, связанных с удостоверением агента.
Синтаксис
ByUserId (По умолчанию)
Remove-EntraAgentUser
-AgentUserId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByAgentId
Remove-EntraAgentUser
-AgentId <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Remove-EntraAgentUser удаляет пользователей агента из Microsoft Entra. При использовании -AgentUserIdс ним удаляется один пользователь агента по идентификатору. При использовании с ним выполняется -AgentIdпоиск и удаление всех пользователей агента, связанных с указанным удостоверением агента.
Командлету требуется подтверждение перед удалением -Force , если параметр не используется. Используется -WhatIf для предварительного просмотра, какие пользователи будут удалены без фактического выполнения удаления.
Примеры
Пример 1. Удаление пользователя агента по идентификатору
Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
В этом примере удаляется пользователь агента с указанным идентификатором. Вам будет предложено подтвердить.
Пример 2. Удаление пользователя агента по идентификатору без подтверждения
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
Идентификатор удостоверения агента, связанный с ним пользователей агента, который должен быть удален. Командлет ищет всех пользователей агента, подключенных к этому удостоверению агента, и удаляет их. Используется с набором параметров ByAgentId.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ByAgentId
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AgentUserId
Идентификатор удаляемого пользователя агента. Используется с набором параметров ByUserId.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ByUserId
| 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
Возвращает хэш-таблицу (или массив хэш-таблиц при использовании -AgentId) со следующими свойствами: Id, DisplayName, AgentId и Status.
Примечания
Для этого командлета требуются следующие разрешения Microsoft Graph:
- AgentIdUser.ReadWrite.All
Для командлета требуется активное Microsoft Entra подключение. Сначала используйте Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' для подключения.
При использовании -AgentIdкомандлет сначала запрашивает всех пользователей агента, связанных с удостоверением агента, а затем удаляет каждый из них. Если удостоверение агента не имеет связанных пользователей агента, отобразится предупреждение.