Merge pull request #2307 from microsoftgraph/auth-documentation

Documentation for Authentication cmdlets
microsoftgraph · Sep 22, 2023 · 1b88464 · 1b88464
2 parents 6836d78 + 69f727b
commit 1b88464
Show file tree

Hide file tree

Showing 82 changed files with 5,897 additions and 245 deletions.
diff --git a/src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj b/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.1.0</Version>
+    <Version>2.6.1</Version>
   </PropertyGroup>
   <PropertyGroup>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>

diff --git a/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj b/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj
@@ -1,10 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net6.0;net472</TargetFrameworks>
     <IsPackable>false</IsPackable>
+    <Version>2.6.1</Version>
   </PropertyGroup>
-
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.2" />
     <!-- As described in this post https://devblogs.microsoft.com/powershell/depending-on-the-right-powershell-nuget-package-in-your-net-project, reference the SDK for dotnetcore-->
@@ -19,8 +18,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\Authentication\Microsoft.Graph.Authentication.csproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/Authentication/Authentication/Cmdlets/ConnectMgGraph.cs b/src/Authentication/Authentication/Cmdlets/ConnectMgGraph.cs
@@ -26,7 +26,7 @@
 
 namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
 {
-    [Cmdlet(VerbsCommunications.Connect, "MgGraph", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-connect-mggraph")]
+    [Cmdlet(VerbsCommunications.Connect, "MgGraph", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph")]
     [Alias("Connect-Graph")]
     public class ConnectMgGraph : PSCmdlet, IModuleAssemblyInitializer, IModuleAssemblyCleanup
     {

diff --git a/src/Authentication/Authentication/Cmdlets/DisconnectMgGraph.cs b/src/Authentication/Authentication/Cmdlets/DisconnectMgGraph.cs
@@ -10,7 +10,7 @@
 
 namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
 {
-    [Cmdlet(VerbsCommunications.Disconnect, "MgGraph", HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-disconnect-mggraph")]
+    [Cmdlet(VerbsCommunications.Disconnect, "MgGraph", HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/disconnect-graph")]
     [Alias("Disconnect-Graph")]
     [OutputType(typeof(IAuthContext))]
     public class DisconnectMgGraph : PSCmdlet

diff --git a/src/Authentication/Authentication/Cmdlets/Environment/AddMgEnvironment.cs b/src/Authentication/Authentication/Cmdlets/Environment/AddMgEnvironment.cs
@@ -16,7 +16,7 @@ namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
     /// <summary>
     /// Adds Microsoft Graph environment to the settings file.
     /// </summary>
-    [Cmdlet(VerbsCommon.Add, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-get-mgenvironment")]
+    [Cmdlet(VerbsCommon.Add, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment")]
     [OutputType(typeof(GraphEnvironment))]
     public class AddMgEnvironment : PSCmdlet
     {

diff --git a/src/Authentication/Authentication/Cmdlets/Environment/GetMgEnvironment.cs b/src/Authentication/Authentication/Cmdlets/Environment/GetMgEnvironment.cs
@@ -11,7 +11,7 @@ namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
     /// <summary>
     /// Gets or lists available Microsoft Graph environments to the settings file..
     /// </summary>
-    [Cmdlet(VerbsCommon.Get, "MgEnvironment", HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-get-mgenvironment")]
+    [Cmdlet(VerbsCommon.Get, "MgEnvironment", HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment")]
     [OutputType(typeof(GraphEnvironment))]
     public class GetMgEnvironment : PSCmdlet
     {

diff --git a/src/Authentication/Authentication/Cmdlets/Environment/RemoveMgEnvironment.cs b/src/Authentication/Authentication/Cmdlets/Environment/RemoveMgEnvironment.cs
@@ -14,7 +14,7 @@ namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
     /// <summary>
     /// Removes Microsoft Graph environment to the settings file..
     /// </summary>
-    [Cmdlet(VerbsCommon.Remove, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-get-mgenvironment")]
+    [Cmdlet(VerbsCommon.Remove, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/remove-mgenvironment")]
     [OutputType(typeof(GraphEnvironment))]
     public class RemoveMgEnvironment : PSCmdlet
     {

diff --git a/src/Authentication/Authentication/Cmdlets/Environment/SetMgEnvironment.cs b/src/Authentication/Authentication/Cmdlets/Environment/SetMgEnvironment.cs
@@ -16,7 +16,7 @@ namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
     /// <summary>
     /// Sets a Microsoft Graph environment to the settings file..
     /// </summary>
-    [Cmdlet(VerbsCommon.Set, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-get-mgenvironment")]
+    [Cmdlet(VerbsCommon.Set, "MgEnvironment", SupportsShouldProcess = true, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment")]
     [OutputType(typeof(GraphEnvironment))]
     public class SetMgEnvironment : PSCmdlet
     {

diff --git a/src/Authentication/Authentication/Cmdlets/GetMGContext.cs b/src/Authentication/Authentication/Cmdlets/GetMGContext.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
 {
-    [Cmdlet(VerbsCommon.Get, "MgContext", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-get-mgcontext")]
+    [Cmdlet(VerbsCommon.Get, "MgContext", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgcontext")]
     [OutputType(typeof(IAuthContext))]
     public class GetMgContext : PSCmdlet
     {

diff --git a/src/Authentication/Authentication/Cmdlets/InvokeMgGraphRequest.cs b/src/Authentication/Authentication/Cmdlets/InvokeMgGraphRequest.cs
@@ -25,7 +25,7 @@
 
 namespace Microsoft.Graph.PowerShell.Authentication.Cmdlets
 {
-    [Cmdlet(VerbsLifecycle.Invoke, "MgGraphRequest", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/powershell/microsoftgraph/authentication-commands#using-invoke-mggraphrequest")]
+    [Cmdlet(VerbsLifecycle.Invoke, "MgGraphRequest", DefaultParameterSetName = Constants.UserParameterSet, HelpUri = "https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest")]
     [Alias("Invoke-GraphRequest", "Invoke-MgRestMethod")]
     public class InvokeMgGraphRequest : PSCmdlet
     {