Модуль AADCloudSyncTools PowerShell для Microsoft Entra Cloud Sync

  • Статья

Модуль AADCloudSyncTools предоставляет набор полезных средств, которые помогут вам управлять развертываниями Microsoft Entra Cloud Sync.

Необходимые компоненты

Вы можете автоматически установить необходимые компоненты для модуля AADCloudSyncTools с помощью Install-AADCloudSyncToolsPrerequisites. Как сделать это, описывается в следующем разделе этой статьи.

Ниже приведены некоторые сведения о том, что вам нужно:

  • Модуль AADCloudSyncTools использует аутентификацию на основе MSAL, поэтому вам нужно установить модуль MSAL.PS. Чтобы проверить установку, в окне PowerShell выполните командлет Get-module MSAL.PS -ListAvailable. Если модуль установлен правильно, вы получите ответ. При необходимости для установки последней версии MSAL.PS можно использовать Install-AADCloudSyncToolsPrerequisites.

  • Хотя модуль Microsoft Graph PowerShell не требуется для каких-либо функций модуля AADCloudSyncTools, это полезно. Поэтому он устанавливается автоматически при использовании Install-AADCloudSyncToolsPrerequisites.

  • Для установки модулей из коллекции PowerShell необходимо принудительно использовать TLS 1.2. Командлет Install-AADCloudSyncToolsPrerequisites задает принудительное применение TLS 1.2 перед установкой всех необходимых компонентов. Чтобы обеспечить возможность установки модулей вручную, задайте следующие значения в сеансе PowerShell перед использованием командлета:

    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

  • Модуль AADCloudSyncTools может работать неправильно, если агент подготовки облака Microsoft Entra Подключение не запущен или мастер настройки не завершил работу.

Установка модуля AADCloudSyncTools PowerShell

  1. Откройте Windows PowerShell с правами администратора.

  2. Запустите Import-module -Name "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools".

  3. Чтобы убедиться, что модуль был импортирован, выполните командлет Get-module AADCloudSyncTools.

    Вы должны увидеть сведения о модуле.

  4. Чтобы установить необходимые для модуля AADCloudSyncTools компоненты, выполните командлет Install-AADCloudSyncToolsPrerequisites.

  5. При первом запуске будет установлен модуль PoweShellGet, если он отсутствует. Чтобы загрузить новый модуль PowershellGet, закройте окно PowerShell и откройте новый сеанс PowerShell с правами администратора.

  6. Снова импортируйте модуль, выполнив командлет Import-module -Name "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools".

  7. Запустите Install-AADCloudSyncToolsPrerequisites еще раз, чтобы установить модули MSAL и Microsoft Graph PowerShell.

    Теперь должны быть установлены все необходимые компоненты.

    Screenshot of the notification in the PowerShell window that says the prerequisites were installed successfully.

  8. Каждый раз, когда вы хотите использовать модуль AADCloudSyncTools в новом сеансе PowerShell, выполните следующую команду:

    Import-module "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools"

Командлеты AADCloudSyncTools

Примечание.

Прежде чем использовать модуль AADCloudSyncTools, убедитесь, что агент подготовки облака Microsoft Entra Подключение запущен и мастер настройки успешно завершен. Чтобы устранить неполадки мастера, обратитесь к дополнительным сведениям в журналах трассировки в папке C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace и к разделу Устранение неполадок с синхронизацией облака.

Connect-AADCloudSyncTools

Этот командлет использует модуль MSAL.PS для запроса маркера администратора Microsoft Entra для доступа к Microsoft Graph.

Export-AADCloudSyncToolsLogs

Этот командлет экспортирует и упаковывает все данные для устранения неполадок в сжатый файл следующим образом:

  1. Настраивает подробную трассировку и запускает сбор данных из агента подготовки (так же, как и Start-AADCloudSyncToolsVerboseLogs).
  2. Останавливает сбор данных через 3 минуты и отключает подробную трассировку (так же, как и Stop-AADCloudSyncToolsVerboseLogs).
  3. Собирает журналы Просмотра событий за последние 24 часа.
  4. Сжимает все журналы агентов, подробные журналы и журналы Просмотра событий в ZIP-файл в папке документов пользователя.

Для точной настройки сбора данных можно использовать следующие переключатели:

  • SkipVerboseTrace для экспорта только текущих журналов без записи подробных журналов (по умолчанию = false).
  • TracingDurationMins, чтобы указать другую длительность записи (по умолчанию — 3 мин);
  • OutputPath, чтобы указать другой путь для выходных данных (по умолчанию — папка Documents пользователя).

Get-AADCloudSyncToolsInfo

Этот командлет отображает сведения о клиенте Microsoft Entra и состоянии внутренних переменных.

Get-AADCloudSyncToolsJob

Этот командлет использует Microsoft Graph для получения субъектов-служб Microsoft Entra и возврата сведений о задании синхронизации. Его также можно вызвать, указав в качестве параметра определенный идентификатор задания синхронизации.

Get-AADCloudSyncToolsJobSchedule

Этот командлет использует Microsoft Graph для получения субъектов-служб Microsoft Entra и возврата расписания задания синхронизации. Его также можно вызвать, указав в качестве параметра определенный идентификатор задания синхронизации.

Get-AADCloudSyncToolsJobSchema

Этот командлет использует Microsoft Graph для получения субъектов-служб Microsoft Entra и возвращает схему задания синхронизации.

Get-AADCloudSyncToolsJobScope

Этот командлет использует Microsoft Graph для получения схемы задания синхронизации по указанному идентификатору задания и выводит все области группы фильтров.

Get-AADCloudSyncToolsJobSettings

Этот командлет использует Microsoft Graph для получения субъектов-служб Microsoft Entra и возврата параметров задания синхронизации. Его также можно вызвать, указав в качестве параметра определенный идентификатор задания синхронизации.

Get-AADCloudSyncToolsJobStatus

Этот командлет использует Microsoft Graph для получения субъектов-служб Microsoft Entra и возвращает состояние задания синхронизации. Его также можно вызвать, указав в качестве параметра определенный идентификатор задания синхронизации.

Get-AADCloudSyncToolsServicePrincipal

Этот командлет использует Microsoft Graph для получения субъектов-служб для идентификатора Microsoft Entra и (или) Azure Service Fabric. Без параметров он вернет только субъекты-службы Microsoft Entra.

Install-AADCloudSyncToolsPrerequisites

Этот командлет проверка для присутствия PowerShellGet версии 2.2.4.1 или более поздней версии, модуля Microsoft Graph PowerShell и модуля MSAL.PS. Если они отсутствуют, он устанавливает эти компоненты.

Invoke-AADCloudSyncToolsGraphQuery

Этот командлет вызывает веб-запрос для URI, метода и текста, указанных в качестве параметров.

Repair-AADCloudSyncToolsAccount

Этот командлет использует Microsoft Graph PowerShell для удаления текущей учетной записи (при наличии). Затем он сбрасывает проверку подлинности учетной записи синхронизации с новой учетной записью синхронизации в идентификаторе Microsoft Entra.

Restart-AADCloudSyncToolsJob

Этот командлет перезапускает полную синхронизацию.

Resume-AADCloudSyncToolsJob

Этот командлет продолжает синхронизацию начиная с предыдущего предела.

Start-AADCloudSyncToolsVerboseLogs

Этот командлет включает подробную трассировку в файле AADConnectProvisioningAgent.exe.config и перезапускает службу AADConnectProvisioningAgent. Вы можете использовать -SkipServiceRestart, чтобы заблокировать перезапуск службы, но все изменения конфигурации не будут применены. Эти журналы трассировки находятся в папке C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace.

Stop-AADCloudSyncToolsVerboseLogs

Этот командлет отключает подробную трассировку в файле AADConnectProvisioningAgent.exe.config и перезапускает службу AADConnectProvisioningAgent. Вы можете использовать -SkipServiceRestart, чтобы заблокировать перезапуск службы, но все изменения конфигурации не будут применены.

Suspend-AADCloudSyncToolsJob

Этот командлет приостанавливает синхронизацию.

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention

Отключает функцию клиента случайногоDeletionPrevention

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId <TenantId>

Для этого командлета требуется TenantId клиент Microsoft Entra. Он проверяет, включена ли функция предотвращения случайного удаления, установленная в клиенте с помощью Microsoft Entra Подключение (ADSync, а не облачная синхронизация), и отключает ее.

Пример:

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId "aaaabbbb-0000-cccc-1111-dddd2222eeee"

Следующие шаги