/entra-powershell

Microsoft Entra PowerShell

Primary LanguagePowerShellMIT LicenseMIT

title description ms.service ms.topic ms.date ms.author ms.reviewer manager author
About Microsoft Entra PowerShell.
About Microsoft Entra PowerShell.
active-directory
reference
06/26/2024
eunicewaweru
stevemutungi
CelesteDG
msewaweru

Microsoft Entra PowerShell (preview)

Microsoft Entra PowerShell (preview), is a command-line tool that allows administrators to manage and automate Microsoft Entra product family resources programmatically. This module is developed based on customer feedback to meet usability needs. Microsoft Entra PowerShell is meticulously designed to deliver a delightful, usable, and high-quality collection of PowerShell cmdlets for Entra administrators.

The module offers human-readable parameters, deliberate parameter set specification, inline documentation, and core PowerShell fundamentals like pipelining. The module builds upon and is part of the Microsoft Graph PowerShell SDK. It’s fully interoperable with all cmdlets in the Microsoft Graph PowerShell SDK.

The module also offers significant (over 98%) compatibility with the deprecated AzureAD module to accelerate migration.

Microsoft Entra PowerShell supports PowerShell version 5.1 and version 7+. We recommend using PowerShell version 7 or higher with the Microsoft Entra PowerShell module on all platforms, including Windows, Linux, and macOS.

Modules

The following table contains a list of the Microsoft Entra PowerShell modules.

Description Module Name PowerShell Gallery Link
v1.0 Module Microsoft.Graph.Entra Gallery
Beta Module Microsoft.Graph.Entra.Beta Gallery

Learn more

Our Motivation | Get-Started: Installation & Usage | Contributing | Known Issues | License

This module is under development (in public preview). It's NOT READY for Production environments.

Note

We are continually improving Microsoft Entra PowerShell throughout the public preview phase and beyond. Keep your module current by applying updates as soon as we notify you of a new version. Module updates will be done on regular cadence.

Contribute

To contribute, see contribution guide.

Known Issues

  • Some properties names change between the Azure AD PowerShell module and Microsoft Graph endpoints:
    • Parameter -Filter might not work correctly
    • Parameter -SearchString don't currently work
    • Output objects might be different
  • "Assembly with same name is already loaded" - when there are multiple versions of Microsoft.Graph.Authentication modules installed.

Product feedback and issues

If you find any bugs when using the Microsoft Entra PowerShell module, file an issue on our GitHub issues page.

This project adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com for questions or comments.

License

Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT license.