Conectar-se ao Microsoft 365 com o Microsoft Graph PowerShell

Esse artigo se aplica ao Microsoft 365 Enterprise e ao Office 365 Enterprise.

O Microsoft Graph PowerShell permite que você gerencie suas configurações do Microsoft 365 da linha de comando. Este artigo mostra como instalar o software necessário e, em seguida, conectar-se à sua organização microsoft 365 usando o SDK do Microsoft Graph PowerShell.

Atualmente, o módulo do PowerShell do Azure Active Directory para Graph não substitui completamente a funcionalidade do módulo Microsoft Azure Active Directory para Windows PowerShell para gerenciamento de proxy de aplicativo, usuário e administração de contato. Em alguns casos, você precisa usar ambas as versões. As duas versões podem ser instaladas com segurança no mesmo computador.

O que você precisa saber antes de começar?

Observação

O módulo do PowerShell do Azure Active Directory (AzureAD) está sendo preterido e substituído pelo SDK do Microsoft Graph PowerShell. Você pode usar o Microsoft Graph SDK do PowerShell para acessar todas as APIs do Microsoft Graph. Para saber mais, confira Introdução ao SDK do PowerShell do Microsoft Graph.

Consulte Também Instalar o SDK do Microsoft Graph PowerShell e Atualizar do Azure AD PowerShell para o Microsoft Graph PowerShell para obter informações sobre como instalar e atualizar para o Microsoft Graph PowerShell, respectivamente.

Pré-requisitos

O PowerShell 7 e posterior é a versão recomendada do PowerShell para uso com o SDK do Microsoft Graph PowerShell em todas as plataformas. Não há outros pré-requisitos para usar o SDK com o PowerShell 7 ou posterior.

Os pré-requisitos a seguir são necessários para usar o SDK do Microsoft Graph PowerShell com Windows PowerShell.

  • Atualizar para o PowerShell 5.1 ou posterior
  • Instalar .NET Framework 4.7.2 ou posterior
  • Atualizar o PowerShellGet para a versão mais recente usando Install-Module PowerShellGet

A política de execução de script do PowerShell deve ser definida como assinada remotamente ou menos restritiva. Use Get-ExecutionPolicy para determinar a política de execução atual. Para mais informações, veja about_Execution_Policies. Para definir a política de execução, execute:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Sistema operacional

Use uma versão de 64 bits do Windows. Você pode usar as seguintes versões do Windows:

  • Windows 11, Windows 10, Windows 8.1, Windows 8 ou Windows 7 Service Pack 1 (SP1)

  • Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, or Windows Server 2008 R2 SP1

Observação

Para Windows 8.1, Windows 8, Windows 7 Service Pack 1 (SP1), Windows Server 2012 R2, Windows Server 2012, e Windows Server 2008 R2 SP1, baixe e instale o Windows Management Framework 5.1.

Para usar o Microsoft Graph PowerShell, você deve usar pelo menos a versão 5.1 do PowerShell.

Observação

Esses procedimentos são destinados aos usuários que são membros de uma função de administrador do Microsoft 365. Para obter mais informações, confira Sobre funções de administrador.

Conectar-se ao Microsoft Graph PowerShell

Nesta seção, você aprenderá a se conectar à sua organização do Microsoft 365 usando o SDK do Microsoft Graph PowerShell. Você pode visitar Instalar o SDK do Microsoft Graph PowerShell para obter mais diretrizes.

Etapa 1: instalar o software necessário

O SDK do Microsoft Graph PowerShell é publicado no Galeria do PowerShell.

Estas etapas são necessárias apenas uma vez em seu computador. No entanto, é provável que você precise atualizar o software periodicamente.

Instalar o SDK e o módulo beta do Microsoft Graph PowerShell

O SDK do Microsoft Graph PowerShell vem em dois módulos, Microsoft.Graph e Microsoft.Graph.Beta, que você instalará separadamente. Esses módulos chamam os pontos de extremidade beta do Microsoft Graph v1.0 e Microsoft Graph, respectivamente. Você pode instalar os dois módulos na mesma versão do PowerShell.

  1. Abra uma janela do Prompt de Comando Windows PowerShell. Dependendo das permissões da sua conta registrada, talvez seja necessário abrir a janela do PowerShell no modo Administrador.

  2. Para instalar o módulo v1 do SDK no PowerShell Core ou Windows PowerShell, execute o seguinte comando:

    Install-Module Microsoft.Graph -Scope CurrentUser
    
  3. Execute este comando para instalar o módulo beta:

    Install-Module Microsoft.Graph.Beta
    

Depois que a instalação for concluída, você poderá verificar a versão instalada com o seguinte comando:

Get-InstalledModule Microsoft.Graph

Etapa 2: conectar-se à sua assinatura do Microsoft 365

O SDK do PowerShell dá suporte a dois tipos de autenticação: acesso delegado e acesso somente aplicativo. Neste guia, você usará o acesso delegado para entrar como usuário, conceder consentimento ao SDK para agir em seu nome e chamar o Microsoft Graph.

Para obter detalhes sobre como usar o acesso somente ao aplicativo para cenários autônomos, confira Usar autenticação somente aplicativo com o SDK do Microsoft Graph PowerShell.

Determinar escopos de permissão necessários

Cada API no Microsoft Graph é protegida por um ou mais escopos de permissão. O logon do usuário deve consentir com um dos escopos necessários para as APIs que você planeja usar. Neste exemplo, usaremos as APIs a seguir.

  • Listar usuários para encontrar a ID do usuário conectado.
  • List joinedTeams para obter o Teams do qual o usuário é membro.
  • Liste canais para obter os canais em uma Equipe.
  • Envie uma mensagem para enviar uma mensagem para um canal da Equipe.

O escopo de permissão User.Read.All habilita as duas primeiras chamadas e o escopo Group.ReadWrite.All habilita o restante. Essas permissões exigem uma conta de administrador.

Para obter mais informações sobre como determinar quais escopos de permissão você precisará, consulte Usando Find-MgGraphCommand.

Para se conectar à organização do Microsoft 365, execute o seguinte comando:

Connect-MgGraph -Scopes "User.Read.All","Group.ReadWrite.All"

O comando solicita que você acesse uma página da Web para entrar com suas credenciais. Depois de fazer isso, o comando indica êxito com uma mensagem Bem-vindo ao Microsoft Graph! Você só precisa entrar uma vez por sessão.

Dica

Você pode adicionar permissões acréscimo repetindo o comando Connect-MgGraph com os novos escopos de permissão.

Confira também