Injected examples , synopsis and descriptions

Author: timayabi2020

src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj

@@ -4,7 +4,7 @@
     <LangVersion>9.0</LangVersion>
     <TargetFrameworks>netstandard2.0;net6.0;net472</TargetFrameworks>
     <RootNamespace>Microsoft.Graph.PowerShell.Authentication.Core</RootNamespace>
-    <Version>2.6.0</Version>
+    <Version>2.6.1</Version>
   </PropertyGroup>
   <PropertyGroup>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>

src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>net6.0;net472</TargetFrameworks>
     <IsPackable>false</IsPackable>
-    <Version>2.6.0</Version>
+    <Version>2.6.1</Version>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.2" />

src/Authentication/Authentication/Microsoft.Graph.Authentication-help.xml

@@ -10,7 +10,7 @@
     <WarningsAsErrors />
     <NuspecFile>Microsoft.Graph.Authentication.nuspec</NuspecFile>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
-    <Version>2.6.0</Version>
+    <Version>2.6.1</Version>
   </PropertyGroup>
   <PropertyGroup>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>

src/Authentication/Authentication/Microsoft.Graph.Authentication.csproj

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <package>
   <metadata>
-    <version>2.6.0</version>
+    <version>2.6.1</version>
     <id>Microsoft.Graph.Authentication</id>
     <description>Microsoft Graph PowerShell authentication module</description>
     <authors>Microsoft</authors>

src/Authentication/Authentication/Microsoft.Graph.Authentication.dll-Help.xml

@@ -3,7 +3,7 @@
 #
 # Generated by: Microsoft
 #
-# Generated on: 19/09/2023
+# Generated on: 21/09/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = './Microsoft.Graph.Authentication.psm1'
 
 # Version number of this module.
-ModuleVersion = '2.6.0'
+ModuleVersion = '2.6.1'
 
 # Supported PSEditions
 CompatiblePSEditions = 'Core', 'Desktop'

src/Authentication/Authentication/Microsoft.Graph.Authentication.nuspec

@@ -1,4 +1,4 @@
----
+---
 external help file: Microsoft.Graph.Authentication.dll-Help.xml
 Module Name: Microsoft.Graph.Authentication
 online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment
@@ -46,21 +46,6 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Confirm
-Prompts you for confirmation before running the cmdlet.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases: cf
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -GraphEndpoint
 The service root endpoint for Microsoft Graph.
 
@@ -91,6 +76,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -WhatIf
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.

src/Authentication/Authentication/Microsoft.Graph.Authentication.psd1

@@ -1,4 +1,4 @@
----
+---
 external help file: Microsoft.Graph.Authentication.dll-Help.xml
 Module Name: Microsoft.Graph.Authentication
 online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph
@@ -8,59 +8,146 @@ schema: 2.0.0
 # Connect-MgGraph
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Microsoft Graph PowerShell supports two types of authentication: delegated and app-only access. There are a number of cmdlets that can be used to manage the different parameters required during authentication, for example, environment, application ID, and certificate.
 
 ## SYNTAX
 
 ### UserParameterSet (Default)
 ```
 Connect-MgGraph [[-Scopes] <String[]>] [[-ClientId] <String>] [-TenantId <String>]
- [-ContextScope <ContextScope>] [-Environment <String>] [-UseDeviceCode] [-ClientTimeout <Double>] [-NoWelcome]
- [-Break] [<CommonParameters>]
+ [-ContextScope <ContextScope>] [-Environment <String>] [-UseDeviceCode] [-ClientTimeout <Double>]
+ [<CommonParameters>]
 ```
 
 ### AppCertificateParameterSet
 ```
 Connect-MgGraph [-ClientId] <String> [[-CertificateSubjectName] <String>] [[-CertificateThumbprint] <String>]
  [-Certificate <X509Certificate2>] [-TenantId <String>] [-ContextScope <ContextScope>] [-Environment <String>]
- [-ClientTimeout <Double>] [-NoWelcome] [-Break] [<CommonParameters>]
+ [-ClientTimeout <Double>] [<CommonParameters>]
 ```
 
 ### IdentityParameterSet
 ```
 Connect-MgGraph [[-ClientId] <String>] [-ContextScope <ContextScope>] [-Environment <String>]
- [-ClientTimeout <Double>] [-Identity] [-NoWelcome] [-Break] [<CommonParameters>]
+ [-ClientTimeout <Double>] [-Identity] [<CommonParameters>]
 ```
 
 ### AppSecretCredentialParameterSet
 ```
 Connect-MgGraph [-ClientSecretCredential <PSCredential>] [-TenantId <String>] [-ContextScope <ContextScope>]
- [-Environment <String>] [-ClientTimeout <Double>] [-NoWelcome] [-Break] [<CommonParameters>]
+ [-Environment <String>] [-ClientTimeout <Double>] [<CommonParameters>]
 ```
 
 ### AccessTokenParameterSet
 ```
-Connect-MgGraph [-AccessToken] <SecureString> [-Environment <String>] [-ClientTimeout <Double>] [-NoWelcome]
- [-Break] [<CommonParameters>]
+Connect-MgGraph [-AccessToken] <SecureString> [-Environment <String>] [-ClientTimeout <Double>]
+ [<CommonParameters>]
 ```
 
 ### EnvironmentVariableParameterSet
 ```
 Connect-MgGraph [-ContextScope <ContextScope>] [-Environment <String>] [-ClientTimeout <Double>]
- [-EnvironmentVariable] [-NoWelcome] [-Break] [<CommonParameters>]
+ [-EnvironmentVariable] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+You must invoke Connect-MgGraph before any commands that access Microsoft Graph. This cmdlet gets the access token using the Microsoft Authentication Library
 
 ## EXAMPLES
 
-### Example 1
+### Example 1: Delegated access: Using interactive authentication, where you provide the scopes that you require during your session
+```powershell
+PS C:\> Connect-MgGraph -Scopes "User.Read.All", "Group.ReadWrite.All"
+```
+
+This example shows how to authenticate to graph with scopes.
+
+### Example 2: Delegated access: Using device code flow
+```powershell
+PS C:\> Connect-MgGraph -Scopes "User.Read.All", "Group.ReadWrite.All" -UseDeviceAuthentication
+```
+
+This example shows how to authenticate to graph with scopes and device.
+
+### Example 3: Delegated access: Using your own access token
+```powershell
+PS C:\> Connect-MgGraph -AccessToken $AccessToken
+```
+
+This example shows how to authenticate to graph using an access token.
+
+### Example 4: Delegated access: custom application for Microsoft Graph PowerShell
+```powershell
+PS C:\> Connect-MgGraph -ClientId <YOUR_NEW_APP_ID> -TenantId <YOUR_TENANT_ID>
+```
+
+Follow this [link](https://learn.microsoft.com/en-us/powershell/microsoftgraph/authentication-commands?view=graph-powershell-1.0#using-connect-mggraph) for more information on the steps for creating custom applications.
+
+### Example 5: App-only access: Using client credential with a certificate - Certificate Thumbprint
+```powershell
+PS C:\> Connect-MgGraph -ClientId "YOUR_APP_ID" -TenantId "YOUR_TENANT_ID" -CertificateThumbprint "YOUR_CERT_THUMBPRINT"
+```
+
+Follow this [link](https://learn.microsoft.com/en-us/powershell/microsoftgraph/authentication-commands?view=graph-powershell-1.0#using-connect-mggraph) for more information on how to load the certificate.
+
+### Example 6: App-only access: Using client credential with a certificate - Certificate name
+```powershell
+PS C:\> Connect-MgGraph -ClientId "YOUR_APP_ID" -TenantId "YOUR_TENANT_ID" -CertificateName "YOUR_CERT_SUBJECT"
+```
+
+Follow this [link](https://learn.microsoft.com/en-us/powershell/microsoftgraph/authentication-commands?view=graph-powershell-1.0#using-connect-mggraph) for more information on how to load the certificate.
+
+### Example 7: App-only access: Using client credential with a certificate - Certificate
+```powershell
+PS C:\> $Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
+PS C:\> Connect-MgGraph -ClientId "YOUR_APP_ID" -TenantId "YOUR_TENANT_ID" -Certificate $Cert
+```
+
+Follow this [link](https://learn.microsoft.com/en-us/powershell/microsoftgraph/authentication-commands?view=graph-powershell-1.0#using-connect-mggraph) for more information on how to load the certificate.
+
+### Example 8: Using client secret credentials
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> $ClientSecretCredential = Get-Credential -Credential "Client_Id"
+# Enter client_secret in the password prompt.
+PS C:\> Connect-MgGraph -TenantId "Tenant_Id" -ClientSecretCredential $ClientSecretCredential
 ```
 
-{{ Add example description here }}
+This authentication method is ideal for background interactions. It does not require a user to physically sign in.
+
+### Example 9: Using managed identity: System-assigned managed identity
+```powershell
+PS C:\> Connect-MgGraph -Identity
+```
+
+Uses an automatically managed identity on a service instance. The identity is tied to the lifecycle of a service instance.
+
+### Example 10: Using managed identity: User-assigned managed identity
+```powershell
+PS C:\> Connect-MgGraph -Identity -ClientId "User_Assigned_Managed_identity_Client_Id"
+```
+
+Uses a user created managed identity as a standalone Azure resource.
+
+### Example 11: Connecting to an environment or cloud
+```powershell
+PS C:\> Get-MgEnvironment
+Name     AzureADEndpoint                   GraphEndpoint                           Type
+----     ---------------                   -------------                           ----
+China    https://login.chinacloudapi.cn    https://microsoftgraph.chinacloudapi.cn Built-in
+Global   https://login.microsoftonline.com https://graph.microsoft.com             Built-in
+USGov    https://login.microsoftonline.us  https://graph.microsoft.us              Built-in
+USGovDoD https://login.microsoftonline.us  https://dod-graph.microsoft.us          Built-in
+PS C:\> Connect-MgGraph -Environment USGov
+```
+
+When you use Connect-MgGraph, you can choose to target other environments. By default, Connect-MgGraph targets the global public cloud.
+
+### Example 12: Connecting to an environment as a different identity
+```powershell
+PS C:\> Connect-MgGraph -ContextScope Process
+```
+
+To connect as a different identity other than CurrentUser, specify the -ContextScope parameter with the value Process.
 
 ## PARAMETERS
 
@@ -80,21 +167,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Break
-Wait for .NET debugger to attach
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Certificate
 An X.509 certificate supplied during invocation.
 
@@ -264,21 +336,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -NoWelcome
-Hides the welcome message.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Scopes
 An array of delegated permissions to consent to.