Navegación por el módulo Microsoft Entra PowerShell

Microsoft Entra PowerShell es una herramienta potente para administrar y gestionar recursos de Entra directamente desde PowerShell.

Este artículo le ayuda a navegar por el módulo y describe sus conceptos básicos.

Prerrequisitos

Iniciar sesión

Cada cmdlet de Microsoft Entra PowerShell está protegido por uno o varios ámbitos de permisos. Para usar Microsoft Entra PowerShell, los usuarios que inician sesión deben dar su consentimiento a los ámbitos de permisos necesarios para el cmdlet que planea usar. Especifique los permisos en el Connect-Entra cmdlet . Inicie sesión con una cuenta de administrador para el inquilino, si se le solicita.

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

Microsoft Entra PowerShell admite dos tipos de autenticación: acceso delegado y acceso solo de aplicación. Para ver todas las opciones posibles, consulte los escenarios de autenticación.

Búsqueda de comandos disponibles

Los cmdlets de Microsoft Entra PowerShell siguen una convención de nomenclatura estándar de PowerShell, Verb-Noun. El verbo describe la acción (ejemplos incluyen New, Get, Set, Remove) y el nombre describe el tipo de recurso (ejemplos incluyen User, Group, ServicePrincipal, ). Device Los nombres de Microsoft Entra PowerShell siempre comienzan con el prefijo Entra. Para obtener la lista completa de verbos estándar, consulte los verbos aprobados para comandos de PowerShell.

Note

En el caso de los cmdlets Beta, agregue un prefijo Beta al nombre del recurso. Por ejemplo, use Get-EntraBetaUser en lugar de Get-EntraUser para la versión Beta.

Puede obtener todos los comandos disponibles en Microsoft Entra módulo de PowerShell mediante el comando siguiente:

Get-Command -Module Microsoft.Entra*

Para reducir esto, por ejemplo, para buscar comandos relacionados con las aplicaciones, ejecute el siguiente comando.

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

Este comando muestra todos los cmdlets, las funciones y los alias que se incluyen en el módulo para el recurso de aplicación.

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

Visualización de propiedades y métodos admitidos para un comando

Para ver más propiedades más allá de la salida predeterminada, ejecute el siguiente comando para ver todas las propiedades admitidas:

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

Este comando muestra todas las propiedades y métodos de usuario.

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

Obtención de ayuda

Para obtener ayuda con los cmdlets de PowerShell de Microsoft Entra, use Get-Help el comando para obtener ayuda detallada sobre comandos específicos, incluida su sintaxis, parámetros y ejemplos de uso. Por ejemplo, para obtener más información sobre el Get-EntraUser comando, ejecute el siguiente comando.

Get-Help Get-EntraUser -Detailed

Este comando proporciona documentación detallada de ayuda, incluida la descripción, los parámetros, los ejemplos de uso y los comandos relacionados del cmdlet, lo que le ayuda a comprender cómo usarlo de forma eficaz en varios escenarios.

Aprender los conceptos básicos

Obtenga información práctica con Microsoft Entra PowerShell a través de nuestras guías paso a paso detalladas: