Naviguer dans le module PowerShell Microsoft Entra

Microsoft Entra PowerShell est un outil puissant permettant de gérer et d’administrer les ressources Entra directement à partir de PowerShell.

Cet article vous aide à naviguer dans le module et décrit ses concepts fondamentaux.

Prerequisites

Connectez-vous

Chaque applet de commande dans Microsoft Entra PowerShell est protégée par une ou plusieurs étendues d’autorisation. Pour utiliser Microsoft Entra PowerShell, les utilisateurs qui se connectent doivent donner leur consentement aux étendues d’autorisation requises pour l’applet de commande qu’ils prévoient d’utiliser. Spécifiez les autorisations dans l’applet de commande Connect-Entra. Connectez-vous avec un compte d’administrateur pour votre locataire, si vous y êtes invité.

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

Microsoft Entra PowerShell prend en charge deux types d’authentification : l’accès délégué et l’accès à l’application uniquement. Pour afficher toutes les options possibles, reportez-vous aux scénarios d’authentification.

Rechercher les commandes disponibles

Les applets de commande PowerShell de Microsoft Entra suivent une convention de dénomination standard pour PowerShell, Verb-Noun. Le verbe décrit l’action (exemples includeNew, , GetSet, Remove, ) et le nom décrit le type de ressource (exemples include User, Group, ServicePrincipal, Device). Les noms dans Microsoft Entra PowerShell commencent toujours par le préfixe Entra. Pour obtenir la liste complète des verbes standard, consultez les verbes approuvés pour les commandes PowerShell.

Note

Pour les applets de commande bêta, ajoutez un préfixe bêta au nom de la ressource. Par exemple, utilisez Get-EntraBetaUser plutôt que Get-EntraUser pour la version bêta.

Vous pouvez obtenir toutes les commandes disponibles dans Microsoft Entra module PowerShell à l’aide de la commande suivante :

Get-Command -Module Microsoft.Entra*

Pour affiner ce problème, par exemple, pour rechercher des commandes liées aux applications, exécutez la commande suivante.

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

Cette commande affiche toutes les applets de commande, fonctions et alias inclus dans le module pour la ressource d’application.

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

Afficher les propriétés et méthodes prises en charge pour une commande

Pour afficher d’autres propriétés au-delà de la sortie par défaut, exécutez la commande suivante pour afficher toutes les propriétés prises en charge :

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

Cette commande affiche toutes les propriétés et méthodes utilisateur.

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

Obtenir de l’aide

Pour obtenir de l’aide sur les applets de commande PowerShell Microsoft Entra, utilisez Get-Help la commande pour obtenir une aide détaillée sur des commandes spécifiques, notamment leur syntaxe, leurs paramètres et leurs exemples d’utilisation. Par exemple, pour en savoir plus sur la Get-EntraUser commande, exécutez la commande suivante.

Get-Help Get-EntraUser -Detailed

Cette commande fournit une documentation d’aide détaillée, notamment la description de l’applet de commande, les paramètres, les exemples d’utilisation et les commandes associées, ce qui vous aide à comprendre comment l’utiliser efficacement dans différents scénarios.

Découvrir les notions de base

Familiarisez-vous avec Microsoft Entra PowerShell par le biais de nos guides pratiques détaillés :

  • Last updated on