Edit

Share via

Get started with the Microsoft Entra PowerShell module

  • Article

Microsoft Entra PowerShell provides a command-line interface for managing Microsoft Entra resources. Explore more about Entra PowerShell.

This article helps you get started with Microsoft Entra PowerShell and teaches the core concepts behind it.

Prerequisites

Sign in

Microsoft Entra PowerShell supports two types of authentication: delegated access, and app-only access. To use Microsoft Entra PowerShell, you need to authenticate to access Microsoft Entra resources. Sign in with an admin account of your tenant, if prompted.

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

To see all the possible options, refer to the authentication scenarios.

Find all available commands

You can get all available commands in Microsoft Entra PowerShell module by using the following command.

Get-Command -Module Microsoft.Graph.Entra

Get Help

To be effective with the Microsoft Entra PowerShell, you need to use Get-Help command for detailed help about specific commands, including their syntax, parameters, and usage examples.

For example, to learn more about the Get-EntraUser command, run:

Get-Help Get-EntraUser -Detailed

Get user information

To retrieve the list of users in Microsoft Entra ID, run the following command.

Get-EntraUser

This command outputs a list of users in your tenant.

DisplayName           ID                                     Mail                    UserPrincipalName
------------           --                                     ----                    -----------------
Contoso Demo UserOne   aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb   demoone@contoso.com    demoone@contoso.com
Contoso Demo UserTwo   bbbbbbbb-1111-2222-3333-cccccccccccc   demotwo@contoso.com    demotwo@contoso.com
Contoso Demo UserFour  cccccccc-2222-3333-4444-dddddddddddd   demofour@contoso.com   demofour@contoso.com

You can run the following command to get the details of one single user.

Connect-Entra -Scopes 'User.Read.All'
Get-EntraUser -ObjectId 'SawyerM@contoso.com'

Data Collection

Microsoft Entra PowerShell collects telemetry data by default. We collection information about the Microsoft Entra PowerShell version and the cmdlet executed. Microsoft aggregates collected data to identify patterns of usage to identify common issues and to improve the experience of Microsoft Entra PowerShell. Microsoft Entra PowerShell doesn't collect any private or personal data. For example, the usage data helps identify issues such as cmdlets with low success and helps prioritize our work.

Learn Microsoft Entra PowerShell basics with quickstarts and tutorials

To get started with Microsoft Entra PowerShell, check out the detailed how-to guide for:

Related content