Instalar Microsoft Entra PowerShell

O módulo Microsoft Entra PowerShell permite que os profissionais de TI gerenciem com eficiência Microsoft Entra recursos, garantindo integração e funcionalidade perfeitas em várias plataformas. Este módulo aprimora sua capacidade de automatizar e simplificar tarefas administrativas.

Neste artigo, você aprenderá a instalar, verificar, atualizar e solucionar problemas do módulo Microsoft Entra PowerShell nos diferentes sistemas operacionais.

O módulo Microsoft Entra PowerShell é dividido em dois módulos, cada um com submódulos que podem ser instalados separadamente. Os dois módulos principais são:

  • Microsoft.Entra - a disponibilidade geral ou v1.0 versão do Microsoft Entra PowerShell. Ele aponta para os recursos do Microsoft Graph v1.0 e do SDK do PowerShell do Microsoft Graph v1.0.
  • Microsoft.Entra.Beta - a Beta versão de visualização do Microsoft Entra PowerShell. Ele aponta para os recursos do Microsoft Graph Beta e do SDK do PowerShell do Microsoft Graph Beta.

O PowerShell versão 7 ou superior é recomendado para uso com o módulo Microsoft Entra PowerShell em todas as plataformas, incluindo Windows, Linux e macOS.

Instalar o módulo Microsoft Entra PowerShell no Windows

O método de instalação recomendado e a versão do PowerShell para o módulo:

Pré-requisitos no Windows

  • Execute o seguinte comando do PowerShell para determinar sua versão do PowerShell:

    $PSVersionTable.PSVersion

  • Determine se você tem o módulo instalado:

    Get-Module -Name Microsoft.Entra -ListAvailable

  • Definir a política de execução do PowerShell como remota assinada ou menos restritiva

    • Verifique a política de execução do PowerShell:

      Get-ExecutionPolicy -List

    • Defina a política de execução do PowerShell como assinada remotamente:

      Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

    Para saber mais sobre as políticas de execução, confira about_Execution_Policies.

Installation

Ao instalar o módulo, você pode optar por instalar o módulo inteiro ou um submódulo específico. Os exemplos a seguir mostram como instalar o módulo inteiro para ambos v1.0 e Beta.

Use o cmdlet Install-Module para instalar o módulo.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

Opcionalmente, você pode alterar o escopo da instalação usando o parâmetro Scope . Essa operação requer permissões de administrador.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Instalar submódulos específicos

A instalação de módulos específicos é ideal para cenários de automação, como o uso de Azure Functions e Automação do Azure.

Execute o seguinte comando para listar todos os Microsoft.Entra módulos GA/v1.0 no Galeria do PowerShell:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Este comando lista todos os módulos do Microsoft Entra PowerShell GA/v1.0 na Galeria do PowerShell.

Por exemplo, para instalar o Users módulo, execute o seguinte comando:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Instalar Microsoft Entra PowerShell no Linux

Pré-requisitos no Linux

Instalação no Linux

Ao instalar o módulo, você pode optar por instalar o módulo inteiro ou um submódulo específico. O exemplo a seguir mostra como instalar todo o módulo.

Abra o Terminal ou outro aplicativo host do shell e execute pwsh para iniciar o PowerShell.

Use o cmdlet Install-Module para instalar o módulo:

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

Opcionalmente, você pode alterar o escopo da instalação usando o parâmetro Scope . Essa operação requer permissões de administrador.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Instalar submódulos específicos no Linux

A instalação de módulos específicos é ideal para cenários de automação, como o uso de Azure Functions e Automação do Azure.

Execute o seguinte comando para listar todos os Microsoft.Entra módulos GA/v1.0 no Galeria do PowerShell:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Este comando lista todos os módulos do Microsoft Entra para PowerShell GA/v1.0 na Galeria do PowerShell.

Por exemplo, para instalar o Users módulo, execute o seguinte comando:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Instalar Microsoft Entra PowerShell no macOS

Este artigo explica como instalar o módulo do Galeria do PowerShell no macOS.

Pré-requisitos no macOS

Instalação no macOS

Ao instalar o módulo, você pode optar por instalar o módulo inteiro ou um submódulo específico. O exemplo a seguir mostra como instalar todo o módulo.

Abra o Terminal ou outro aplicativo host do shell e execute pwsh para iniciar o PowerShell.

Use o cmdlet Install-Module para instalar o módulo Microsoft Entra PowerShell:

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

Opcionalmente, você pode alterar o escopo da instalação usando o parâmetro Scope . Essa operação requer permissões de administrador.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Instalar submódulos específicos no macOS

A instalação de módulos específicos é ideal para cenários de automação, como o uso de Azure Functions e Automação do Azure.

Execute o seguinte comando para listar todos os Microsoft.Entra módulos GA/v1.0 no Galeria do PowerShell:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Este comando lista todos os módulos do Microsoft Entra para PowerShell GA/v1.0 na Galeria do PowerShell.

Por exemplo, para instalar o Users módulo, execute o seguinte comando:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Verificar a versão e o local do módulo instalados

Depois que a instalação for concluída, você poderá verificar os submódulos instalados, a versão e o local com o comando a seguir.

Get-InstalledModule -Name Microsoft.Entra* |
Where-Object { $_.Name -notmatch "Beta" } | Format-Table Name, Version, InstalledLocation -AutoSize

Este comando mostra o módulo instalado Microsoft Entra PowerShell, sua versão e local de instalação. A versão de saída deve corresponder à versão mais recente no Galeria do PowerShell. Agora você está pronto para usar o módulo.

Name                                Version InstalledLocation
----                                ------- -----------------
Microsoft.Entra                     1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra\1.0.1
Microsoft.Entra.Applications        1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Applications\1.0.1
Microsoft.Entra.Authentication      1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Authentication\1.0.1
Microsoft.Entra.DirectoryManagement 1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.DirectoryManagement\1.0.1
Microsoft.Entra.Governance          1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Governance\1.0.1
Microsoft.Entra.Groups              1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Groups\1.0.1
Microsoft.Entra.Reports             1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Reports\1.0.1
Microsoft.Entra.SignIns             1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.SignIns\1.0.1
Microsoft.Entra.Users               1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Users\1.0.1

Para verificar se um submodule específico, por exemplo, Users está instalado, execute:

Get-InstalledModule -Name Microsoft.Entra.Users

A versão de saída deve corresponder à versão mais recente no Galeria do PowerShell.

Version              Name                                Repository           Description
-------              ----                                ----------           -----------
1.0.1                Microsoft.Entra.Users               PSGallery            Microsoft Entra PowerShell

Solucionar problemas de instalação

Erro Cause Workaround
Install-Module: não é possível encontrar um parâmetro que corresponda ao nome do parâmetro AllowPrerelease. Você está usando uma versão mais antiga do Install-Module. Para atualizar, siga este guia. O problema se aplica apenas a Windows plataforma.
O módulo dependente 'module-name' não está instalado neste computador. Para usar o módulo atual 'Microsoft. Entra', verifique se seu módulo dependente 'module-name' está instalado. As dependências do Microsoft Entra PowerShell não estão instaladas Para instalar, use este script
Os cmdlets já existem no sistema Adicionar -AllowClobber parâmetro: Install-Module -Name Microsoft.Entra -Repository PSGallery -Force -AllowClobber
Os seguintes comandos já estão disponíveis neste sistema: 'Enable-EntraAzureADAlias,Get-EntraUnsupportedCommand,Test-EntraScript' Há um conflito quando Beta ou v1.0 já está instalado Para resolver o problema, desinstale a versão do módulo ofensivo.

Para obter soluções para outra instalação comum e outros problemas gerais, consulte Solucionar problemas de instalação do módulo.

Entrar

Para começar a gerenciar seus recursos Microsoft Entra com o módulo Microsoft Entra PowerShell, inicie uma sessão do PowerShell e execute o Connect-Entra para entrar no Microsoft Entra ID:

Connect-Entra -Scopes 'User.Read.All'
Get-EntraUser -Filter "userPrincipalName eq 'SawyerM@contoso.com'"

Use suas credenciais de Microsoft Entra para entrar na janela de entrada que é aberta.

Você precisa repetir esta etapa para cada nova sessão do PowerShell iniciada.

Para obter mais informações sobre outros cenários de autenticação, consulte mais cenários de autenticação.

Atualizar o módulo

Se o módulo estiver instalado, siga estas etapas para atualizá-lo.

Primeiro, verifique a versão e o local do módulo usando as diretrizes na seção verificar a instalação deste artigo.

Atualizar para a versão mais recente

Use Update-Module para atualizar para a versão mais recente do módulo do Microsoft Entra PowerShell.

Update-Module -Name Microsoft.Entra -Force

Para atualizar um submodule específico, como Users, execute:

Update-Module -Name Microsoft.Entra.Users -Force

Atualizar o módulo Microsoft Entra PowerShell usando Update-Module não remove versões antigas do módulo do seu sistema.

Desinstalar o módulo

Para remover o módulo, execute o comando:

Uninstall-Module -Name Microsoft.Entra -AllVersions -Force

Para desinstalar um submodule específico, como Users, execute:

Uninstall-Module -Name Microsoft.Entra.Users -AllVersions -Force

Para desinstalar todos os submódulos, execute:

$InstalledSubModules = Get-InstalledModule -Name Microsoft.Entra.* |
Where-Object { $_.Name -notmatch "Beta" }
foreach ($module in $InstalledSubModules) {
    Write-Host "Checking for submodule: $($module.Name)" -ForegroundColor Yellow -BackgroundColor DarkBlue
    Uninstall-Module -Name $module.Name -Force -ErrorAction Stop
    Write-Host "Successfully uninstalled submodule: $($module.Name)" -ForegroundColor Green
}

Próximas Etapas 

  • Para saber mais sobre como navegar no módulo Microsoft Entra PowerShell, consulte o artigo Navegar no módulo.
  • Last updated on