Skip to content

Commit

Permalink
Update README.md (#359)
Browse files Browse the repository at this point in the history
* Update README.md

Enriching documentation and framing.

* Update GET-STARTED.md

Added a preferred command format to get commands in the module:

`(Get-Module -Name Microsoft.Graph.Entra).ExportedCommands`
  • Loading branch information
SteveMutungi254 authored Jan 30, 2024
1 parent 7423bcd commit fa0377f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 5 additions & 6 deletions GET-STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,20 +79,19 @@ To see all the possible options, refer to [MS Graph SDK authentication](https:
1. Get all available commands in Microsoft Entra PowerShell module

```powershell
(Get-Module -Name Microsoft.Graph.Entra).ExportedCommands
Get-Command -Module Microsoft.Graph.Entra
```

Replace `Microsoft.Graph.Entra` with `Microsoft.Graph.Entra.Beta` if you're using the `Beta` version of the module.

1. Get the Microsoft Entra ID users
2. Get the Microsoft Entra ID users

```powershell
Get-EntraUser
```

This command returns all the users in your Microsoft Entra ID tenant.

1. Getting Help
3. Getting Help

To be effective with the Microsoft Entra PowerShell, you need to use the Help system. `Get-Help` command helps you find commands to perform specific tasks and learn how to use those commands after you find them.

Expand All @@ -108,7 +107,7 @@ To get examples, add the parameter `–Examples`.
Get-Help Get-EntraUser -Examples
```

1. Searching for a user
4. Searching for a user

```powershell
Get-EntraUser -SearchString "Adele"
Expand Down Expand Up @@ -279,4 +278,4 @@ This command removes a user/member with UserId `1aa46598-c6ce-4115-943e-a82c5746
Remove-EntraGroup -ObjectId "c1720fcf-0281-4c74-89c9-2fbc54f9b8f9"
```

This command removes the Microsoft Entra ID group.
This command removes the Microsoft Entra ID group.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ While the Microsoft Entra PowerShell module provides significant compatibility w

<p align="center">
<a href="MOTIVATION.md">Our Motivation</a> |
<a href="GET-STARTED.md">Installation & Usage</a> |
<a href="GET-STARTED.md">Get-Started: Installation & Usage</a> |
<a href="#contributing">Contributing</a> |
<a href="#known-issues">Known Issues</a> |
<a href="#license">License</a>
Expand Down

0 comments on commit fa0377f

Please sign in to comment.