Compartilhar via

Módulo AADCloudSyncTools do PowerShell para Sincronização do Microsoft Entra

  • Artigo

O módulo AADCloudSyncTools fornece um conjunto de ferramentas úteis que podem ajudar você a gerenciar suas implantações de Sincronização na nuvem do Microsoft Entra.

Pré-requisitos

Você pode instalar automaticamente todos os pré-requisitos para o módulo AADCloudSyncTools usando Install-AADCloudSyncToolsPrerequisites. Você fará isso na próxima seção deste artigo.

Aqui estão alguns detalhes sobre o que você precisa:

  • O módulo AADCloudSyncTools usa a autenticação da MSAL (Biblioteca de Autenticação da Microsoft), portanto requer a instalação do módulo MSAL.PS. Para verificar a instalação, em uma janela do PowerShell, execute Get-module MSAL.PS -ListAvailable. Se o módulo for instalado corretamente, você receberá uma resposta. Se necessário, use Install-AADCloudSyncToolsPrerequisites para instalar a versão mais recente de MSAL.PS.

  • Embora o módulo Microsoft Graph PowerShell não seja necessário para nenhuma funcionalidade do módulo AADCloudSyncTools, ele é útil. Sendo assim, ele é instalado automaticamente quando você usa Install-AADCloudSyncToolsPrerequisites.

  • A instalação de módulos da Galeria do PowerShell requer a imposição de TLS (Transport Layer Security) 1.2. O cmdlet Install-AADCloudSyncToolsPrerequisites define a imposição do TLS 1.2 antes de instalar todos os pré-requisitos. Para garantir que você possa instalar os módulos manualmente, defina o seguinte na sessão do PowerShell antes de usar o cmdlet:

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

  • O módulo AADCloudSyncTools poderá não funcionar corretamente se o agente de provisionamento de nuvem Microsoft Entra Connect não estiver em execução ou se o assistente de configuração não tiver sido concluído com êxito.

Instalar o módulo PowerShell AADCloudSyncTools

  1. Abra o Windows PowerShell com privilégios administrativos.

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

  3. Para verificar se o módulo foi importado, execute Get-module AADCloudSyncTools.

    Agora, você deve ver informações sobre o módulo.

  4. Para instalar os pré-requisitos do módulo AADCloudSyncTools, execute Install-AADCloudSyncToolsPrerequisites.

  5. Na primeira execução, o módulo PoweShellGet será instalado se não estiver presente. Para carregar o novo módulo PowerShellGet, feche a janela do PowerShell e abra uma nova sessão do PowerShell com privilégios administrativos.

  6. Importe o módulo novamente executando Import-module -Name "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools".

  7. Execute Install-AADCloudSyncToolsPrerequisites novamente para instalar os módulos da MSAL e do Microsoft Graph PowerShell.

    Todos os pré-requisitos devem estar instalados.

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

  8. Sempre que quiser usar o módulo AADCloudSyncTools em uma nova sessão do PowerShell, execute o seguinte comando:

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

Cmdlets AADCloudSyncTools

Observação

Antes de usar o módulo AADCloudSyncTools, certifique-se de que o agente de provisionamento de nuvem Microsoft Entra Connect esteja em execução e que o assistente de configuração tenha sido concluído com êxito. Para solucionar problemas do assistente, você pode encontrar logs de rastreamento na pasta C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace; confira Solucionar problemas de sincronização de nuvem para obter mais informações.

Connect-AADCloudSyncTools

Esse cmdlet usa o módulo MSAL.PS para solicitar um token para que o administrador do Microsoft Entra acesse o Microsoft Graph.

Export-AADCloudSyncToolsLogs

Este cmdlet exporta e empacota todos os dados de solução de problemas em um arquivo compactado, da seguinte maneira:

  1. Define o rastreamento detalhado e inicia a coleta de dados do agente de provisionamento (o mesmo que Start-AADCloudSyncToolsVerboseLogs).
  2. Interrompe a coleta de dados após três minutos e desabilita o rastreamento detalhado (o mesmo que Stop-AADCloudSyncToolsVerboseLogs).
  3. Coleta logs do Visualizador de Eventos para as últimas 24 horas.
  4. Compacta todos os logs de agente, logs detalhados e logs do Visualizador de Eventos em um arquivo .zip na pasta Documentos do usuário.

Você pode usar as seguintes opções para ajustar a coleta de dados:

  • SkipVerboseTrace para exportar somente os logs atuais sem capturar logs detalhados (padrão = falso).
  • TracingDurationMins para especificar uma duração de captura diferente (padrão = 3 minutos).
  • OutputPath para especificar um caminho de saída diferente (padrão = pasta Documentos do usuário).

Get-AADCloudSyncToolsInfo

Esse cmdlet mostra os detalhes do locatário do Microsoft Entra e o estado das variáveis internas.

Get-AADCloudSyncToolsInfo

Esse cmdlet usa o Microsoft Graph para obter entidades de serviço do Microsoft Entra e retorna as informações do trabalho de sincronização. Você também pode chamá-lo usando a ID de trabalho de sincronização específica como um parâmetro.

Get-AADCloudSyncToolsJobSchedule

Esse cmdlet usa o Microsoft Graph para obter entidades de serviço do Microsoft Entra e retorna o agendamento do trabalho de sincronização. Você também pode chamá-lo usando a ID de trabalho de sincronização específica como um parâmetro.

Get-AADCloudSyncToolsJobSchedule

Esse cmdlet usa o Microsoft Graph para obter entidades de serviço do Microsoft Entra e retorna o esquema do trabalho de sincronização.

Get-AADCloudSyncToolsJobScope

Este cmdlet usa o Microsoft Graph para obter o esquema do trabalho de sincronização para a ID do trabalho de sincronização fornecido e gera de todos os escopos do grupo de filtros.

Get-AADCloudSyncToolsJobSettings

Esse cmdlet usa o Microsoft Graph para obter entidades de serviço do Microsoft Entra e retorna as configurações do trabalho de sincronização. Você também pode chamá-lo usando a ID de trabalho de sincronização específica como um parâmetro.

Get-AADCloudSyncToolsJobStatus

Esse cmdlet usa o Microsoft Graph para obter entidades de serviço do Microsoft Entra e retorna o status do trabalho de sincronização. Você também pode chamá-lo usando a ID de trabalho de sincronização específica como um parâmetro.

Get-AADCloudSyncToolsServicePrincipal

Esse cmdlet usa o Microsoft Graph para obter as entidades de serviço do Microsoft Entra e/ou do Azure Service Fabric. Sem parâmetros, ele retornará apenas as entidades de serviço do Microsoft Entra.

Install-AADCloudSyncToolsPrerequisites

Este cmdlet verifica a presença do PowerShellGet v2.2.4.1 ou posterior, do módulo do Microsoft Graph PowerShell e do módulo MSAL.PS. Ele instala esses itens se estiverem ausentes.

Invoke-AADCloudSyncToolsGraphQuery

Este cmdlet invoca uma solicitação da Web para o URI, o método e o corpo especificados como parâmetros.

Repair-AADCloudSyncToolsAccount

Este cmdlet usa o Microsoft Graph PowerShell para excluir a conta atual (se presente). Em seguida, ele redefine a autenticação da conta de sincronização com uma nova conta de sincronização no Microsoft Entra ID.

Restart-AADCloudSyncToolsJob

Este cmdlet reinicia uma sincronização completa.

Resume-AADCloudSyncToolsJob

Este cmdlet continua a sincronização desde a marca d' água anterior.

Start-AADCloudSyncToolsVerboseLogs

Este cmdlet modifica AADConnectProvisioningAgent.exe.config para habilitar o rastreamento detalhado e reinicia o serviço AADConnectProvisioningAgent. Você pode usar -SkipServiceRestart para impedir a reinicialização do serviço, mas eventuais alterações de configuração não terão efeito. Encontre esses logs de rastreamento na pasta C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace.

Stop-AADCloudSyncToolsVerboseLogs

Este cmdlet modifica AADConnectProvisioningAgent.exe.config para desabilitar o rastreamento detalhado e reinicia o serviço AADConnectProvisioningAgent. Você pode usar -SkipServiceRestart para impedir a reinicialização do serviço, mas eventuais alterações de configuração não terão efeito.

Suspend-AADCloudSyncToolsJob

Este cmdlet pausa a sincronização.

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention

Desabilita o recurso de locatário accidentalDeletionPrevention

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId <TenantId>

Esse cmdlet requer TenantId do locatário do Microsoft Entra. Isso verificará se o recurso Prevenção de Exclusão Acidental, definido no locatário com o Microsoft Entra Connect (ADSync, não sincronização de nuvem), está habilitado, e o desabilitará.

Exemplo:

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

Próximas etapas