Navegue pelo módulo PowerShell do Microsoft Entra

O Microsoft Entra PowerShell é uma ferramenta poderosa para gerir e administrar recursos da Entra diretamente a partir do PowerShell.

Este artigo ajuda-o a navegar pelo módulo e delineia os seus conceitos centrais.

Pré-requisitos

Entrar

Cada cmdlet no Microsoft Entra PowerShell está protegido por um ou mais escopos de permissões. Para usar o Microsoft Entra PowerShell, os utilizadores que iniciam sessão devem consentir com os escopos de permissão necessários para o cmdlet que planeiam utilizar. Especifique as permissões no Connect-Entra cmdlet. Inicie sessão com uma conta administrativa para o seu inquilino, se solicitado.

Connect-Entra -Scopes 'User.Read.All'

O Microsoft Entra PowerShell suporta dois tipos de autenticação: acesso delegado e acesso apenas por aplicação. Para ver todas as opções possíveis, consulte os cenários de autenticação.

Encontre comandos disponíveis

Os cmdlets do PowerShell do Microsoft Entra seguem uma convenção de nomenclatura padrão do PowerShell, Verb-Noun. O verbo descreve a ação (exemplos incluem New, Get, Set, Remove) e o substantivo descreve o tipo de recurso (exemplos incluem User, Group, ServicePrincipal, Device). Os substantivos no Microsoft Entra PowerShell começam sempre com o prefixo Entra. Para a lista completa de verbos padrão, consulte os verbos aprovados para comandos PowerShell.

Note

Para cmdlets Beta, adicione um prefixo Beta ao nome do recurso. Por exemplo, use Get-EntraBetaUser em vez de Get-EntraUser para a versão Beta.

Pode obter todos os comandos disponíveis no módulo PowerShell Microsoft Entra usando o seguinte comando:

Get-Command -Module Microsoft.Entra*

Para restringir isto, por exemplo, para encontrar comandos relacionados com aplicações, execute o seguinte comando.

Get-Command -Module Microsoft.Entra* -Noun *application*

Este comando mostra todos os cmdlets, funções e aliases incluídos no módulo para o recurso da aplicação.

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Function        Add-EntraApplicationOwner                          1.0.1     Microsoft.Entra
Function        Get-EntraApplication                               1.0.1     Microsoft.Entra
Function        Get-EntraApplicationExtensionProperty              1.0.1     Microsoft.Entra
Function        Get-EntraApplicationKeyCredential                  1.0.1     Microsoft.Entra
Function        Get-EntraApplicationLogo                           1.0.1     Microsoft.Entra
Function        Get-EntraApplicationOwner                          1.0.1     Microsoft.Entra
Function        Get-EntraApplicationPasswordCredential             1.0.1     Microsoft.Entra

Ver propriedades suportadas e métodos para um comando

Para ver mais propriedades para além da saída padrão, execute o seguinte comando para visualizar todas as propriedades suportadas:

Get-EntraUser -UserId 'rsmith@contoso.com' | Get-Member

Este comando mostra todas as propriedades e métodos do utilizador.

accountEnabled                        NoteProperty          bool accountEnabled=True
ageGroup                              NoteProperty          object ageGroup=null
businessPhones                        NoteProperty          Object[]
city                                  NoteProperty          string city=Bellevue
companyName                           NoteProperty          object companyName=null
consentProvidedForMinor               NoteProperty          object
country                               NoteProperty          string
createdDateTime                       NoteProperty          datetime createdDateTime
creationType                          NoteProperty          object creationType=null
deletedDateTime                       NoteProperty          object deletedDateTime=null
DeletionTimestamp                     NoteProperty          object DeletionTimestamp=null
department                            NoteProperty          string department=Retail
DirSyncEnabled                        NoteProperty          object DirSyncEnabled=null
displayName                           NoteProperty          string displayName=Adele Vance
employeeHireDate                      NoteProperty          object employeeHireDate=null
employeeId                            NoteProperty          object employeeId=null
employeeLeaveDateTime                 NoteProperty          object employeeLeaveDateTime=null
employeeOrgData                       NoteProperty          object employeeOrgData=null
employeeType                          NoteProperty          object employeeType=null

Obter ajuda

Para obter ajuda com os cmdlets PowerShell do Microsoft Entra, use o comando Get-Help para obter ajuda detalhada relativa a comandos específicos, incluindo a respetiva sintaxe, parâmetros e exemplos de utilização. Por exemplo, para aprender mais sobre o Get-EntraUser comando, execute o seguinte comando.

Get-Help Get-EntraUser -Detailed

Este comando fornece documentação de ajuda detalhada, incluindo a descrição do cmdlet, parâmetros, exemplos de utilização e comandos relacionados, ajudando-o a perceber como o usar eficazmente em vários cenários.

Aprender as noções básicas

Experimente o Microsoft Entra PowerShell através dos nossos guias detalhados de como fazer:

  • Last updated on