Install Microsoft Entra PowerShell

O módulo PowerShell Microsoft Entra permite aos profissionais de TI gerir eficientemente os recursos Microsoft Entra, garantindo integração e funcionalidade fluidas em várias plataformas. Este módulo melhora a sua capacidade de automatizar e simplificar tarefas administrativas.

Neste artigo, aprende como instalar, verificar, atualizar e diagnosticar o módulo PowerShell da Microsoft Entra nos diferentes sistemas operativos.

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

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

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

Instale o módulo PowerShell Microsoft Entra no Windows

O método de instalação recomendado e a versão 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 tem o módulo instalado:

    Get-Module -Name Microsoft.Entra -ListAvailable

  • Definir a política de execução do PowerShell como assinada remotamente 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 obter mais informações sobre políticas de execução, consulte about_Execution_Policies.

Instalação

Ao instalar o módulo, pode escolher instalar o módulo inteiro ou um submódulo específico. Os exemplos seguintes mostram como instalar o módulo completo tanto para v1.0 como para Beta.

Utilize o comando Install-Module para instalar o módulo.

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

Opcionalmente, pode alterar o âmbito da instalação usando o parâmetro Scope . Esta operação requer permissões de administrador.

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

Instale submódulos específicos

Instalar módulos específicos é ideal para cenários de automação, como a utilização do Funções do Azure e do Automatização do Azure.

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

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

Este comando lista todos os módulos PowerShell GA/v1.0 do Microsoft Entra 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 o Microsoft Entra PowerShell no Linux

Pré-requisitos no Linux

Instalação em Linux

Ao instalar o módulo, pode escolher instalar o módulo inteiro ou um submódulo específico. O exemplo seguinte mostra como instalar todo o módulo.

Abra o Terminal ou outro aplicativo host de 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, pode alterar o âmbito da instalação usando o parâmetro Scope . Esta operação requer permissões de administrador.

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

Instale submódulos específicos no Linux

Instalar módulos específicos é ideal para cenários de automação, como a utilização do Funções do Azure e do Automatização do Azure.

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

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

Este comando lista todos os módulos PowerShell GA/v1.0 do Microsoft Entra 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 o Microsoft Entra PowerShell no macOS

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

Pré-requisitos no macOS

Instalação no macOS

Ao instalar o módulo, pode escolher instalar o módulo inteiro ou um submódulo específico. O exemplo seguinte mostra como instalar todo o módulo.

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

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

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

Opcionalmente, pode alterar o âmbito da instalação usando o parâmetro Scope . Esta operação requer permissões de administrador.

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

Instale submódulos específicos no macOS

Instalar módulos específicos é ideal para cenários de automação, como a utilização do Funções do Azure e do Automatização do Azure.

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

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

Este comando lista todos os módulos PowerShell GA/v1.0 do Microsoft Entra 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 localização do módulo instalado

Após a instalação estar concluída, pode verificar os submódulos instalados, a sua versão e localização com o seguinte comando.

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

Este comando mostra o módulo PowerShell Microsoft Entra instalado, a sua versão e o local de instalação. A versão de saída deve corresponder à versão mais recente na Galeria do PowerShell. Agora 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 submódulo 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 na Galeria do PowerShell.

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

Solucionar problemas de instalação

Erro Motivo Solução alternativa
Install-Module: Não é possível encontrar um parâmetro que corresponda ao nome do parâmetro AllowPrerelease. Estás a usar uma versão mais antiga do Install-Module. Para atualizar, siga este guia. O problema aplica-se apenas à plataforma Windows.
O módulo dependente 'module-name' não está instalado neste computador. Para utilizar o módulo atual 'Microsoft.Entra', certifique-se de que o módulo do qual este depende, 'module-name', está instalado. As dependências do Microsoft Entra PowerShell não estão instaladas Para instalar, use este script
Já existem CMDLETS 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 se o Beta ou o v1.0 já estiver instalado Para resolver o problema, desinstale a versão do módulo problemática.

Para soluções para outras instalações comuns e outros problemas gerais, veja Problemas de instalação de módulos.

Entrar

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

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

Use as suas credenciais Microsoft Entra para iniciar sessão na janela de início de sessão que se abre.

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

Para 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 estes passos para o atualizar.

Primeiro, verifique a versão e localização do módulo utilizando as orientações na secção de verificar instalação deste artigo.

Atualizar para a versão mais recente

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

Update-Module -Name Microsoft.Entra -Force

Para atualizar um submódulo específico, como Users, execute:

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

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

Desinstale o módulo

Para remover o módulo, execute o comando:

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

Para desinstalar um submódulo 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
}

Passos seguintes

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