Navegar pelo módulo Microsoft Entra PowerShell

Microsoft Entra PowerShell é uma ferramenta poderosa para gerenciar e administrar recursos do Entra diretamente do PowerShell.

Este artigo ajuda você a navegar pelo módulo e descreve seus principais conceitos.

Prerequisites

Entrar

Cada cmdlet no Microsoft Entra PowerShell é protegido por um ou mais escopos de permissão. Para usar Microsoft Entra PowerShell, os usuários que entrarem devem consentir com os escopos de permissão necessários para o cmdlet que planejam usar. Especifique as permissões no cmdlet Connect-Entra. Entre com uma conta de administrador do seu locatário, se for solicitado.

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

Microsoft Entra PowerShell dá suporte a dois tipos de autenticação: acesso delegado e acesso somente ao aplicativo. Para ver todas as opções possíveis, consulte os cenários de autenticação.

Localizar comandos disponíveis

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

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

Get-Command -Module Microsoft.Entra*

Para restringir isso, por exemplo, para localizar comandos relacionados a aplicativos, execute o comando a seguir.

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 de aplicativo.

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

Exibir propriedades e métodos com suporte para um comando

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

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

Esse comando exibe todas as propriedades e métodos do usuário.

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 encontrar ajuda com os cmdlets do Microsoft Entra PowerShell, use o comando Get-Help para obter ajuda detalhada sobre comandos específicos, incluindo sua sintaxe, parâmetros e exemplos de uso. Por exemplo, para saber mais sobre o Get-EntraUser comando, execute o comando a seguir.

Get-Help Get-EntraUser -Detailed

Este comando fornece documentação detalhada de ajuda, incluindo a descrição do cmdlet, parâmetros, exemplos de uso e comandos relacionados, ajudando você a entender como usá-lo efetivamente em vários cenários.

Conhecer os princípios básicos

Aprenda na prática a usar o Microsoft Entra PowerShell com nossos guias detalhados de instruções:

  • Last updated on