Upgrade from Azure AD PowerShell to Microsoft Graph PowerShell
Azure AD, Azure AD Preview and MSOnline PowerShell modules are planned for deprecation. Microsoft Graph PowerShell is the PowerShell module to use for interacting with Microsoft Entra ID and other Microsoft services.
Use the information in this article to plan the migration of your applications to Microsoft Graph PowerShell.
Why upgrade to Microsoft Graph PowerShell?
The following list summarizes the key advantages of using the Microsoft Graph PowerShell SDK.
- Access to all Microsoft Graph APIs: Microsoft Graph PowerShell is based on Microsoft Graph API. The Microsoft Graph API includes, in addition to Microsoft Entra ID, APIs from other Microsoft services like SharePoint, Exchange, and Outlook, all accessed through a single endpoint with a single access token.
- Supports PowerShell 7: Microsoft Graph PowerShell module works with PowerShell 7 and later. It's also compatible with Windows PowerShell 5.1.
- Cross-platform support: Microsoft Graph PowerShell module works on all platforms including Windows, macOS, and Linux.
- Supports modern authentication: Microsoft Graph PowerShell supports the Microsoft Authentication Library (MSAL) which offers more security. For example, you can use Passwordless sign-in experiences.
- Supports external identities: Users from other Microsoft Entra tenants can authenticate to services in your tenant with Microsoft Graph PowerShell.
- Uses least privilege: Microsoft Graph PowerShell permissions are NOT pre-authorized and users must perform one-time request for app permissions depending on their needs.
- Advanced queries: Microsoft Graph PowerShell supports rich, advanced queries via eventual consistency. For example, you can get a near-instant count of all users using advanced queries.
- Open source: Feature teams and the community can create great PowerShell experiences and share them with everyone.
- Receives regular updates: Microsoft Graph PowerShell commands are updated regularly to support the latest Graph API updates.
Upgrading to Microsoft Graph PowerShell
Scripts written in Azure AD PowerShell won't automatically work with Microsoft Graph PowerShell. The new cmdlet names have been designed to be easy to learn. Instead of using
AzureADMS in cmdlet names, use
Mg. For example, the cmdlet
Get-AzureADUser is equivalent to
Get-MgUser. However, migration is more than just becoming familiar with the new cmdlet names. There are renamed modules, parameters, and other important changes.
We've outlined the following sample process for upgrading your existing scripts. This sample process has two steps: documenting your scripts based on a defined criteria and upgrading them.
Step 1: Document current scripts
Follow this example criteria to document a script:
- Purpose: What is the main function of the script?
- Location: How are you storing and securing the script? Where is it executed from?
- Frequency of execution: How frequently is the script run and from what platform?
- Importance: What's the business criticality of the script?
- Length: How long is the script?
- Cmdlets used and number of calls: A list of all cmdlets used and the frequency of your calls to them.
- Still required: Can you use existing or new product functionality to do what the script does to achieve the same results?
- Improvement points: Can you improve the script? For example, filter to the left of the pipeline, use modern authentication, or use the PSScriptAnalyzer module.
Overall score: Optionally, apply a scoring mechanism to each criteria to help you prioritize the upgrade order. This process involves giving each script an overall score based on the sum of each criteria score. For example, importance could be categorized as Critical, High, Medium and Low, and the criteria score would be selected from one of the following: Critical - 4, High - 3, Medium - 2, Low -1.
Step 2: Update current scripts
After documenting your scripts using the example criteria, follow these steps to upgrade them.
- Start simple / low score : If you're using a scoring mechanism, test the upgrade with the least complex, less business-critical scripts.
- Map cmdlets: Using the Cmdlet map, get the Microsoft Graph PowerShell equivalents for your cmdlets.
- Map parameters / switches: Using the Microsoft Graph PowerShell syntax, map your parameters and switches.
- Map filters: Using the Microsoft Graph PowerShell syntax, map your filters.
- Check cmdlet documentation: Human authored updates are frequently occurring to add samples on using the new cmdlets.
- Use dedicated apps and adhere to least privilege: Because Microsoft Graph PowerShell permissions are NOT pre-authorized, perform one-time request for permissions depending on your needs.
- Understand required permissions: Use Find-MgGraphCommand and Find-MgGraphPermission to understand permissions required for the cmdlets.
- Understand output objects: Understand the change in output objects in Microsoft Graph PowerShell. The Get-Member cmdlet will help you understand the objects.
- Optionally, understand the underlying API
The equivalent of the
Get-AzureADUser cmdlet is Get-MgUser. This cmdlet has additional parameters that let you do more with its output. For example, the -ConsistencyLevel parameter that allows you to do
Connect-MgGraph -Scopes 'User.Read.All' Get-MgUser -ConsistencyLevel eventual -Count userCount -Filter "startsWith(DisplayName, 'a')" -Top 1
There are limitations that currently exist in Microsoft Graph PowerShell, either by design or due to some functionality that is yet to be built in.
- For the equivalent of -SearchString, use -Search and -ConsistencyLevel eventual in all cases. Note that the query may still work without eventual .You can also use -Filter instead. For example,
Get-MgUser -Filter "DisplayName eq 'Lee Gu'"returns the user whose display name is equal to the specified string.
- You need to use hash tables to pass nested parameters. See a sample of Nested parameters.
- Pro-tip: Use the Microsoft Graph PowerShell -ConsistencyLevel parameter. It lets you do $count! To learn more about the -ConsistencyLevel parameter, see Advanced query parameters.