The Microsoft Identity Tools PowerShell module provides various tools for performing enhanced Identity administration activities. It is intended to address more complex business scenarios that can't be met solely with the use of MS Graph PowerShell SDK module.
A cmdlet is suitable for MSIdentityTools if it meets the following criteria:
- it uses the MS Graph Powershell SDK to make complex API calls, typically to more than one API
- it returns crafted, custom objects to meet a specific business requirement
A qualifying cmdlet has to work on PowerShell Core.
When creating a cmdlet for inclusion please follow these guidelines.
Create your cmdlet as an advanced function.
See Get-Help about_Functions_Advanced
Please ensure that you are using an approved verb as per the guidelines in Approved Verbs for PowerShell Commands
Please use this prefix for your cmdlet: MsId
For example, Get-MsIdUserDetails
Please provide detailed comment based help, including varied examples, and good parameter descriptions to help the end-user.
See Get-Help about_Comment_Based_Help
Use advanced function parameters with validation (where feasible):
See Get-Help about_Functions_Advanced_Parameters
Return objects. Use the comment based help examples to show how to export the objects into non-host, end-user friendly output, e.g. CSV files, Out-Gridview.
Utilize Write-Verbose statements for providing optional feedback on the processing of the cmdlet during execution, for example:
Write-Verbose -Message "$(Get-Date -f T) - <your_message>"
If you've created your cmdlet as an advanced function it will already include a [CmdletBinding()] statement which enables -Verbose.
See Get-Help about_Functions_CmdletBindingAttribute and Get-Help about_Functions_Advanced_Methods
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.