Added examples for the cmdlets (#685)

msewaweru · georgend · web-flow · commit ace4cb40df09 · 2021-06-22T16:48:39.000+03:00
* Added examples for the cmdlets

* Added an example the new-mguser cmdlet

* Updated the examples to conform to the AutoREST format

Co-authored-by: George &lt;1641829+georgend@users.noreply.github.com&gt;
diff --git a/src/Applications/Applications/examples/v1.0-beta/Get-MgApplication.md b/src/Applications/Applications/examples/v1.0-beta/Get-MgApplication.md
@@ -1,18 +1,28 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get a list of applications
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgApplication | 
+  Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
 
-{{ Add output here }}
+Id              : 8ea936e0-cb74-46c0-8408-d4614a596267
+DisplayName     : Test App
+AppId           : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
+SignInAudience  : AzureADandPersonalMicrosoftAccount
+PublisherDomain : contoso.com
 ```
 
-{{ Add description here }}
+This examples gets a list of all the applications.
+
+### Example 2: Get an application by Id
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgApplication -Filter "AppId eq '39b09640-ec3e-44c9-b3de-f52db4e1cf66'" | 
+  Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
 
-{{ Add output here }}
+DisplayName     : Test App
+AppId           : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
+SignInAudience  : AzureADandPersonalMicrosoftAccount
+PublisherDomain : contoso.com
 ```
 
-{{ Add description here }}
-
+This examples gets the application by the specified Id.
diff --git a/src/Applications/Applications/examples/v1.0-beta/Get-MgServicePrincipal.md b/src/Applications/Applications/examples/v1.0-beta/Get-MgServicePrincipal.md
@@ -1,18 +1,31 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get all service principals from the directory
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgServicePrincipal
+
+Id             : 304ae362-7953-4d08-8e15-aeece4d01017c
+DisplayName    : IC3 Gateway TestClone
+AppId          : 509ab5b8-1380-4906-9765-76d2ace9335d
+SignInAudience : AzureADMultipleOrgs
 
-{{ Add output here }}
+Id             : 4297089a-3358-4bf5-92b0-a35fbdb2407c
+DisplayName    : Microsoft Forms
+AppId          : 67c93110-694e-4a54-b1af-d6cd2e3b12d7
+SignInAudience : AzureADMultipleOrgs
 ```
 
-{{ Add description here }}
+This example retrieves all service principals from the directory.
+
+### Example 2: Get the service principal by display name
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+ Get-MgServicePrincipal -Filter "DisplayName eq 'Power BI Service'" | 
+  Format-List Id, DisplayName,AppId, SignInAudience
 
-{{ Add output here }}
+Id             : 9518fb8f-8d9e-4aae-be20-d398f9cc59ac
+DisplayName    : Power BI Service
+AppId          : 60dbf324-9702-41cc-a5fa-f8d19804b014
+SignInAudience : AzureADMultipleOrgs
 ```
 
-{{ Add description here }}
-
+This example gets the service principal by display name.
diff --git a/src/Applications/Applications/examples/v1.0/Get-MgApplication.md b/src/Applications/Applications/examples/v1.0/Get-MgApplication.md
@@ -1,18 +1,28 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get a list of applications
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgApplication | 
+  Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
 
-{{ Add output here }}
+Id              : 8ea936e0-cb74-46c0-8408-d4614a596267
+DisplayName     : Test App
+AppId           : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
+SignInAudience  : AzureADandPersonalMicrosoftAccount
+PublisherDomain : contoso.com
 ```
 
-{{ Add description here }}
+This examples gets a list of all the applications.
+
+### Example 2: Get an application by Id
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgApplication -Filter "AppId eq '39b09640-ec3e-44c9-b3de-f52db4e1cf66'" | 
+  Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
 
-{{ Add output here }}
+DisplayName     : Test App
+AppId           : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
+SignInAudience  : AzureADandPersonalMicrosoftAccount
+PublisherDomain : contoso.com
 ```
 
-{{ Add description here }}
-
+This examples gets the application by the specified Id.
diff --git a/src/Applications/Applications/examples/v1.0/Get-MgServicePrincipal.md b/src/Applications/Applications/examples/v1.0/Get-MgServicePrincipal.md
@@ -1,18 +1,31 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get all service principals from the directory
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgServicePrincipal
+
+Id             : 304ae362-7953-4d08-8e15-aeece4d01017c
+DisplayName    : IC3 Gateway TestClone
+AppId          : 509ab5b8-1380-4906-9765-76d2ace9335d
+SignInAudience : AzureADMultipleOrgs
 
-{{ Add output here }}
+Id             : 4297089a-3358-4bf5-92b0-a35fbdb2407c
+DisplayName    : Microsoft Forms
+AppId          : 67c93110-694e-4a54-b1af-d6cd2e3b12d7
+SignInAudience : AzureADMultipleOrgs
 ```
 
-{{ Add description here }}
+This example retrieves all service principals from the directory.
+
+### Example 2: Get the service principal by display name
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+ Get-MgServicePrincipal -Filter "DisplayName eq 'Power BI Service'" | 
+  Format-List Id, DisplayName,AppId, SignInAudience
 
-{{ Add output here }}
+Id             : 9518fb8f-8d9e-4aae-be20-d398f9cc59ac
+DisplayName    : Power BI Service
+AppId          : 60dbf324-9702-41cc-a5fa-f8d19804b014
+SignInAudience : AzureADMultipleOrgs
 ```
 
-{{ Add description here }}
-
+This example gets the service principal by display name.
diff --git a/src/Groups/Groups/examples/v1.0-beta/Get-MgGroup.md b/src/Groups/Groups/examples/v1.0-beta/Get-MgGroup.md
@@ -1,18 +1,32 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get a list of groups
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgGroup | 
+  Format-List Id, DisplayName, Description, GroupTypes
+
+Id          : 0a1c8435-40a3-4a72-8586-e916c12b613a
+DisplayName : Marketing
+Description : A group to synthesize, analyze, and synchronize our marketing efforts.
+GroupTypes  : {Unified}
 
-{{ Add output here }}
+Id          : a8fbb1b5-b994-4835-9183-c7421d149132
+DisplayName : Business Development
+Description : Welcome to the BizDev team.
+GroupTypes  : {Unified}
 ```
 
-{{ Add description here }}
+This examples retrieves a list of groups.
+
+### Example 2: Get a group by the display name
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgGroup -Filter "DisplayName eq 'Business Development'" | 
+  Format-List Id, DisplayName, Description, GroupTypes
 
-{{ Add output here }}
+Id          : a8fbb1b5-b994-4835-9183-c7421d149132
+DisplayName : Business Development
+Description : Welcome to the BizDev team.
+GroupTypes  : {Unified}
 ```
 
-{{ Add description here }}
-
+This example gets a group by the specified display name.
diff --git a/src/Groups/Groups/examples/v1.0-beta/Get-MgGroupMember.md b/src/Groups/Groups/examples/v1.0-beta/Get-MgGroupMember.md
@@ -1,18 +1,14 @@
-### Example 1: {{ Add title here }}
-```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
-```
+### Example 1: Get members of a group
 
-{{ Add description here }}
-
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
+Get-MgGroupMember -GroupId '7b7be3ab-d2b3-441c-8111-2e89b8493fff'
+
+Id                                   DeletedDateTime
+--                                   ---------------
+6733b39d-1b5d-46af-adf3-4589718be012
+0107d1b2-0402-4ef9-a58c-eb0661c5d596
+f9f1bd4f-16ca-4404-925e-5b08b6a3832f
+5441e919-583c-4292-aa3f-98250d8d217b
 ```
 
-{{ Add description here }}
-
+This examples gets the members of the specified group.
diff --git a/src/Groups/Groups/examples/v1.0-beta/New-MgGroup.md b/src/Groups/Groups/examples/v1.0-beta/New-MgGroup.md
@@ -1,18 +1,11 @@
-### Example 1: {{ Add title here }}
-```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
-```
+### Example 1: Create a new group
 
-{{ Add description here }}
-
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+New-MgGroup -DisplayName 'Test Group' -MailEnabled:$False  -MailNickName 'testgroup' -SecurityEnabled
 
-{{ Add output here }}
+Id                                   DisplayName Description GroupTypes
+--                                   ----------- ----------- ----------
+15bb6c2c-ac32-41a1-b9ec-b6300b8b8e52 Test Group              {}
 ```
 
-{{ Add description here }}
-
+This example creates a new group.
diff --git a/src/Groups/Groups/examples/v1.0/Get-MgGroup.md b/src/Groups/Groups/examples/v1.0/Get-MgGroup.md
@@ -1,18 +1,32 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get a list of groups
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgGroup | 
+  Format-List Id, DisplayName, Description, GroupTypes
+
+Id          : 0a1c8435-40a3-4a72-8586-e916c12b613a
+DisplayName : Marketing
+Description : A group to synthesize, analyze, and synchronize our marketing efforts.
+GroupTypes  : {Unified}
 
-{{ Add output here }}
+Id          : a8fbb1b5-b994-4835-9183-c7421d149132
+DisplayName : Business Development
+Description : Welcome to the BizDev team.
+GroupTypes  : {Unified}
 ```
 
-{{ Add description here }}
+This examples retrieves a list of groups.
+
+### Example 2: Get a group by the display name
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgGroup -Filter "DisplayName eq 'Business Development'" | 
+  Format-List Id, DisplayName, Description, GroupTypes
 
-{{ Add output here }}
+Id          : a8fbb1b5-b994-4835-9183-c7421d149132
+DisplayName : Business Development
+Description : Welcome to the BizDev team.
+GroupTypes  : {Unified}
 ```
 
-{{ Add description here }}
-
+This example gets a group by the specified display name.
diff --git a/src/Groups/Groups/examples/v1.0/Get-MgGroupMember.md b/src/Groups/Groups/examples/v1.0/Get-MgGroupMember.md
@@ -1,18 +1,14 @@
-### Example 1: {{ Add title here }}
-```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
-```
+### Example 1: Get members of a group
 
-{{ Add description here }}
-
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
+Get-MgGroupMember -GroupId '7b7be3ab-d2b3-441c-8111-2e89b8493fff'
+
+Id                                   DeletedDateTime
+--                                   ---------------
+6733b39d-1b5d-46af-adf3-4589718be012
+0107d1b2-0402-4ef9-a58c-eb0661c5d596
+f9f1bd4f-16ca-4404-925e-5b08b6a3832f
+5441e919-583c-4292-aa3f-98250d8d217b
 ```
 
-{{ Add description here }}
-
+This examples gets the members of the specified group.
diff --git a/src/Groups/Groups/examples/v1.0/New-MgGroup.md b/src/Groups/Groups/examples/v1.0/New-MgGroup.md
@@ -1,18 +1,11 @@
-### Example 1: {{ Add title here }}
-```powershell
-PS C:\> {{ Add code here }}
-
-{{ Add output here }}
-```
+### Example 1: Create a new group
 
-{{ Add description here }}
-
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+New-MgGroup -DisplayName 'Test Group' -MailEnabled:$False  -MailNickName 'testgroup' -SecurityEnabled
 
-{{ Add output here }}
+Id                                   DisplayName Description GroupTypes
+--                                   ----------- ----------- ----------
+15bb6c2c-ac32-41a1-b9ec-b6300b8b8e52 Test Group              {}
 ```
 
-{{ Add description here }}
-
+This example creates a new group.
diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0-beta/Get-MgDirectoryRole.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0-beta/Get-MgDirectoryRole.md
@@ -1,18 +1,34 @@
-### Example 1: {{ Add title here }}
+### Example 1: Get all directory roles
+
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgDirectoryRole | Format-List
 
-{{ Add output here }}
+DeletedDateTime      :
+Description          : Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.
+DisplayName          : Global Administrator
+Id                   : a2d10e79-df32-47fc-86ef-64d199860810
+Members              :
+RoleTemplateId       : 1f12db9c-dbb3-410d-a893-4c0bc322bf85
+ScopedMembers        :
+AdditionalProperties : {}
 ```
 
-{{ Add description here }}
+This examples gets all the available directory roles.
+
+### Example 2: Get a directory role by Id
 
-### Example 2: {{ Add title here }}
 ```powershell
-PS C:\> {{ Add code here }}
+Get-MgDirectoryRole -DirectoryRoleId 'a2d10e79-df32-47fc-86ef-64d199860810' |
+  Format-List
 
-{{ Add output here }}
+DeletedDateTime      :
+Description          : Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.
+DisplayName          : Global Administrator
+Id                   : a2d10e79-df32-47fc-86ef-64d199860810
+Members              :
+RoleTemplateId       : 1f12db9c-dbb3-410d-a893-4c0bc322bf85
+ScopedMembers        :
+AdditionalProperties : {}
 ```
 
-{{ Add description here }}
-
+This example gets the directory role based on the specified Id.
diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDirectoryRole.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDirectoryRole.md
diff --git a/src/Users/Users/examples/v1.0-beta/New-MgUser.md b/src/Users/Users/examples/v1.0-beta/New-MgUser.md
diff --git a/src/Users/Users/examples/v1.0-beta/Remove-MgUser.md b/src/Users/Users/examples/v1.0-beta/Remove-MgUser.md
diff --git a/src/Users/Users/examples/v1.0/New-MgUser.md b/src/Users/Users/examples/v1.0/New-MgUser.md
diff --git a/src/Users/Users/examples/v1.0/Remove-MgUser.md b/src/Users/Users/examples/v1.0/Remove-MgUser.md
