From 9d76b5a622812d4f85559f6f9bb3345b27a3b91e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 5 Feb 2026 19:41:11 +0000 Subject: [PATCH 1/4] Initial plan From ee1df4370ff65874ce1da2928f56557d9c463a57 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 5 Feb 2026 19:47:31 +0000 Subject: [PATCH 2/4] Add BleuCloud and DelosCloud environments, remove old Germany cloud Co-authored-by: gavinbarron <7122716+gavinbarron@users.noreply.github.com> --- .../Common/GraphSettingsTests.cs | 8 ++-- .../Handlers/NationalCloudHandlerTests.cs | 8 ++-- .../GraphEnvironmentConstants.cs | 43 +++++++++++++------ 3 files changed, 37 insertions(+), 22 deletions(-) diff --git a/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs b/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs index 31e3c2aad94..314938263d4 100644 --- a/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs +++ b/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs @@ -115,8 +115,8 @@ public void ShouldLoadSettingsFromConfiguredDataStore() // Assert Assert.NotNull(loadedEnvironment); - // 5 built-in + 2 user-defined - Assert.Equal(7, settings.Environments.Count()); + // 6 built-in + 2 user-defined + Assert.Equal(8, settings.Environments.Count()); Assert.Equal("https://login.MyNewCloud.com", loadedEnvironment.AzureADEndpoint); Assert.Equal("https://graph.MyNewCloud.com", loadedEnvironment.GraphEndpoint); Assert.Equal(GraphEnvironmentConstants.EnvironmentType.UserDefined, loadedEnvironment.Type); @@ -155,8 +155,8 @@ public void ShouldRemoveSettingsFromConfiguredDataStore() // Assert Assert.NotEmpty(settingsContent); - // 5 built-in + 1 user-defined - Assert.Equal(6, settings.Environments.Count()); + // 6 built-in + 1 user-defined + Assert.Equal(7, settings.Environments.Count()); GraphSession.Reset(); } diff --git a/src/Authentication/Authentication.Test/Handlers/NationalCloudHandlerTests.cs b/src/Authentication/Authentication.Test/Handlers/NationalCloudHandlerTests.cs index 75eee5dea01..ee0fdee0a69 100644 --- a/src/Authentication/Authentication.Test/Handlers/NationalCloudHandlerTests.cs +++ b/src/Authentication/Authentication.Test/Handlers/NationalCloudHandlerTests.cs @@ -64,13 +64,13 @@ public async Task ShouldUseGlobalCloudWhenEnvironmentIsNotSet() } [Fact] - public async Task ShouldUseGermanyCloudWhenEnvironmentIsSetToGermany() + public async Task ShouldUseDelosCloudWhenEnvironmentIsSetToDelos() { GraphSession.Initialize(() => new GraphSession()); // Arrange - GraphEnvironment germanyEnvironment = GraphEnvironment.BuiltInEnvironments[GraphEnvironmentConstants.EnvironmentName.Germany]; - GraphSession.Instance.Environment = germanyEnvironment; + GraphEnvironment delosEnvironment = GraphEnvironment.BuiltInEnvironments[GraphEnvironmentConstants.EnvironmentName.DelosCloud]; + GraphSession.Instance.Environment = delosEnvironment; Uri requestUrl = new Uri($"https://graph.microsoft.com/beta/users?{topParam}&{selectParam}"); var httpRequestMessage = new HttpRequestMessage(HttpMethod.Get, requestUrl); @@ -80,7 +80,7 @@ public async Task ShouldUseGermanyCloudWhenEnvironmentIsSetToGermany() // Assert Assert.Equal(requestUrl.Scheme, response.RequestMessage.RequestUri.Scheme); - Assert.Equal("graph.microsoft.de", response.RequestMessage.RequestUri.Host); + Assert.Equal("graph.svc.sovcloud.de", response.RequestMessage.RequestUri.Host); Assert.Contains(topParam, sentRequestQuery); Assert.Contains(selectParam, sentRequestQuery); Assert.Equal(2, sentRequestQuery.Split('&').Length); diff --git a/src/Authentication/Authentication/GraphEnvironmentConstants.cs b/src/Authentication/Authentication/GraphEnvironmentConstants.cs index b13710d234f..adeeef76408 100644 --- a/src/Authentication/Authentication/GraphEnvironmentConstants.cs +++ b/src/Authentication/Authentication/GraphEnvironmentConstants.cs @@ -30,14 +30,19 @@ public static class EnvironmentName public const string USGovDoD = "USGovDoD"; /// - /// The graph national cloud for Germany. + /// The graph national cloud for China. /// - public const string Germany = "Germany"; + public const string China = "China"; /// - /// The graph national cloud for China. + /// The French sovereign cloud operated by Bleu. /// - public const string China = "China"; + public const string BleuCloud = "BleuCloud"; + + /// + /// The German sovereign cloud operated by Delos. + /// + public const string DelosCloud = "DelosCloud"; } /// @@ -84,16 +89,6 @@ public static class EnvironmentType GraphEndpoint = "https://dod-graph.microsoft.us" } }, - // Germany national cloud endpoints. - { - EnvironmentName.Germany, new GraphEnvironment - { - Name = EnvironmentName.Germany, - Type = EnvironmentType.BuiltIn, - AzureADEndpoint = "https://login.microsoftonline.de", - GraphEndpoint = "https://graph.microsoft.de" - } - }, // China national cloud endpoints. { EnvironmentName.China, new GraphEnvironment @@ -103,6 +98,26 @@ public static class EnvironmentType AzureADEndpoint = "https://login.chinacloudapi.cn", GraphEndpoint = "https://microsoftgraph.chinacloudapi.cn" } + }, + // French sovereign cloud endpoints. + { + EnvironmentName.BleuCloud, new GraphEnvironment + { + Name = EnvironmentName.BleuCloud, + Type = EnvironmentType.BuiltIn, + AzureADEndpoint = "https://login.sovcloud-identity.fr", + GraphEndpoint = "https://graph.svc.sovcloud.fr" + } + }, + // German sovereign cloud endpoints. + { + EnvironmentName.DelosCloud, new GraphEnvironment + { + Name = EnvironmentName.DelosCloud, + Type = EnvironmentType.BuiltIn, + AzureADEndpoint = "https://login.sovcloud-identity.de", + GraphEndpoint = "https://graph.svc.sovcloud.de" + } } }; } From 4e5b70dacdfd4de4c4e236bdf063e05fd1ee9d9e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Feb 2026 22:54:55 +0000 Subject: [PATCH 3/4] Add GovSGCloud sovereign cloud environment Co-authored-by: gavinbarron <7122716+gavinbarron@users.noreply.github.com> --- .../Common/GraphSettingsTests.cs | 8 ++++---- .../Authentication/GraphEnvironmentConstants.cs | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs b/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs index 314938263d4..78346244a13 100644 --- a/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs +++ b/src/Authentication/Authentication.Test/Common/GraphSettingsTests.cs @@ -115,8 +115,8 @@ public void ShouldLoadSettingsFromConfiguredDataStore() // Assert Assert.NotNull(loadedEnvironment); - // 6 built-in + 2 user-defined - Assert.Equal(8, settings.Environments.Count()); + // 7 built-in + 2 user-defined + Assert.Equal(9, settings.Environments.Count()); Assert.Equal("https://login.MyNewCloud.com", loadedEnvironment.AzureADEndpoint); Assert.Equal("https://graph.MyNewCloud.com", loadedEnvironment.GraphEndpoint); Assert.Equal(GraphEnvironmentConstants.EnvironmentType.UserDefined, loadedEnvironment.Type); @@ -155,8 +155,8 @@ public void ShouldRemoveSettingsFromConfiguredDataStore() // Assert Assert.NotEmpty(settingsContent); - // 6 built-in + 1 user-defined - Assert.Equal(7, settings.Environments.Count()); + // 7 built-in + 1 user-defined + Assert.Equal(8, settings.Environments.Count()); GraphSession.Reset(); } diff --git a/src/Authentication/Authentication/GraphEnvironmentConstants.cs b/src/Authentication/Authentication/GraphEnvironmentConstants.cs index adeeef76408..6ec3fc79f43 100644 --- a/src/Authentication/Authentication/GraphEnvironmentConstants.cs +++ b/src/Authentication/Authentication/GraphEnvironmentConstants.cs @@ -43,6 +43,11 @@ public static class EnvironmentName /// The German sovereign cloud operated by Delos. /// public const string DelosCloud = "DelosCloud"; + + /// + /// The Singapore government sovereign cloud. + /// + public const string GovSGCloud = "GovSGCloud"; } /// @@ -118,6 +123,16 @@ public static class EnvironmentType AzureADEndpoint = "https://login.sovcloud-identity.de", GraphEndpoint = "https://graph.svc.sovcloud.de" } + }, + // Singapore government sovereign cloud endpoints. + { + EnvironmentName.GovSGCloud, new GraphEnvironment + { + Name = EnvironmentName.GovSGCloud, + Type = EnvironmentType.BuiltIn, + AzureADEndpoint = "https://login.sovcloud-identity.sg", + GraphEndpoint = "https://graph.svc.sovcloud.sg" + } } }; } From 41589586dbd3d3ead81e11262e2abc7e7bd52b13 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 12 Feb 2026 00:07:19 +0000 Subject: [PATCH 4/4] Fix PowerShell test to use DelosCloud instead of removed Germany environment Co-authored-by: gavinbarron <7122716+gavinbarron@users.noreply.github.com> --- ...Microsoft.Graph.Authentication.Core.csproj | 2 +- ...Microsoft.Graph.Authentication.Test.csproj | 2 +- .../Microsoft.Graph.Authentication.csproj | 2 +- .../Microsoft.Graph.Authentication.nuspec | 2 +- .../Microsoft.Graph.Authentication.psd1 | 6 ++-- .../test/Get-MgContext.Tests.ps1 | 4 +-- src/Authentication/docs/Add-MgEnvironment.md | 21 +++++------- src/Authentication/docs/Connect-MgGraph.md | 33 +++++-------------- src/Authentication/docs/Disconnect-MgGraph.md | 20 +++++------ .../docs/Find-MgGraphCommand.md | 24 +++++--------- .../docs/Find-MgGraphPermission.md | 22 +++++-------- src/Authentication/docs/Get-MgContext.md | 22 +++++-------- src/Authentication/docs/Get-MgEnvironment.md | 21 +++++------- src/Authentication/docs/Get-MgGraphOption.md | 22 +++++-------- .../docs/Get-MgRequestContext.md | 20 +++++------ .../docs/Invoke-MgGraphRequest.md | 21 +++++------- .../docs/Microsoft.Graph.Authentication.md | 8 +++-- .../docs/Remove-MgEnvironment.md | 21 +++++------- src/Authentication/docs/Set-MgEnvironment.md | 21 +++++------- src/Authentication/docs/Set-MgGraphOption.md | 21 +++++------- .../docs/Set-MgRequestContext.md | 23 +++++-------- 21 files changed, 130 insertions(+), 208 deletions(-) diff --git a/src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj b/src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj index e3564a114b8..99ad7a4a7bf 100644 --- a/src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj +++ b/src/Authentication/Authentication.Core/Microsoft.Graph.Authentication.Core.csproj @@ -4,7 +4,7 @@ 9.0 netstandard2.0;net6.0;net472 Microsoft.Graph.PowerShell.Authentication.Core - 2.32.0 + 2.35.1 true diff --git a/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj b/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj index b9919c188d6..0c824a9a3dc 100644 --- a/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj +++ b/src/Authentication/Authentication.Test/Microsoft.Graph.Authentication.Test.csproj @@ -2,7 +2,7 @@ net8.0;net472 false - 2.32.0 + 2.35.1 diff --git a/src/Authentication/Authentication/Microsoft.Graph.Authentication.csproj b/src/Authentication/Authentication/Microsoft.Graph.Authentication.csproj index 886acf3770a..46c784f4a07 100644 --- a/src/Authentication/Authentication/Microsoft.Graph.Authentication.csproj +++ b/src/Authentication/Authentication/Microsoft.Graph.Authentication.csproj @@ -10,7 +10,7 @@ Microsoft.Graph.Authentication.nuspec © Microsoft Corporation. All rights reserved. - 2.32.0 + 2.35.1 true diff --git a/src/Authentication/Authentication/Microsoft.Graph.Authentication.nuspec b/src/Authentication/Authentication/Microsoft.Graph.Authentication.nuspec index 9ec5bcf4737..3442acad784 100644 --- a/src/Authentication/Authentication/Microsoft.Graph.Authentication.nuspec +++ b/src/Authentication/Authentication/Microsoft.Graph.Authentication.nuspec @@ -1,7 +1,7 @@ - 2.32.0 + 2.35.1 Microsoft.Graph.Authentication Microsoft Graph PowerShell authentication module Microsoft diff --git a/src/Authentication/Authentication/Microsoft.Graph.Authentication.psd1 b/src/Authentication/Authentication/Microsoft.Graph.Authentication.psd1 index 322b679fc0a..0d6b73d7114 100644 --- a/src/Authentication/Authentication/Microsoft.Graph.Authentication.psd1 +++ b/src/Authentication/Authentication/Microsoft.Graph.Authentication.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft # -# Generated on: 21/09/2023 +# Generated on: 02/12/2026 # @{ @@ -12,13 +12,13 @@ RootModule = './Microsoft.Graph.Authentication.psm1' # Version number of this module. -ModuleVersion = '2.6.1' +ModuleVersion = '2.35.1' # Supported PSEditions CompatiblePSEditions = 'Core', 'Desktop' # ID used to uniquely identify this module -GUID = '883916f2-9184-46ee-b1f8-b6a2fb784cee' +GUID = '44776453-fc06-4f89-94c9-f0bd6578afa1' # Author of this module Author = 'Microsoft' diff --git a/src/Authentication/Authentication/test/Get-MgContext.Tests.ps1 b/src/Authentication/Authentication/test/Get-MgContext.Tests.ps1 index 3fcedc75409..5232d4244a3 100644 --- a/src/Authentication/Authentication/test/Get-MgContext.Tests.ps1 +++ b/src/Authentication/Authentication/test/Get-MgContext.Tests.ps1 @@ -27,10 +27,10 @@ Describe 'Get-MgContext' { It 'Should return the correct environment when specified via Connect-MgGraph -Environment' { - Connect-MgGraph -AccessToken (ConvertTo-SecureString -AsPlainText -String $DummyToken) -Environment Germany + Connect-MgGraph -AccessToken (ConvertTo-SecureString -AsPlainText -String $DummyToken) -Environment DelosCloud $Context = Get-MgContext $Context | Should -Not -Be $null - $Context.Environment | Should -Be "Germany" + $Context.Environment | Should -Be "DelosCloud" $Context.AuthType | Should -Be "UserProvidedAccessToken" } } diff --git a/src/Authentication/docs/Add-MgEnvironment.md b/src/Authentication/docs/Add-MgEnvironment.md index b2cec826955..26535f318ce 100644 --- a/src/Authentication/docs/Add-MgEnvironment.md +++ b/src/Authentication/docs/Add-MgEnvironment.md @@ -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 @@ -7,9 +7,8 @@ schema: 2.0.0 # Add-MgEnvironment -## SYNOPSIS - Adds Microsoft Graph environment to the settings file. - +## SYNOPSIS + Adds Microsoft Graph environment to the settings file. ## SYNTAX ``` @@ -17,11 +16,9 @@ Add-MgEnvironment [-Name] [-AzureADEndpoint] [-GraphEndpoint] [] ``` -## DESCRIPTION - Adds Microsoft Graph environment to the settings file. - -## EXAMPLES - +## DESCRIPTION + Adds Microsoft Graph environment to the settings file. +## EXAMPLES ### Example 1: Add user defined environment ```powershell PS C:\> Add-MgEnvironment -Name "Canary" -GraphEndpoint "https://canary.graph.microsoft.com" -AzureADEndpoint "https://login.microsoftonline.com" @@ -29,9 +26,8 @@ Name AzureADEndpoint GraphEndpoint Type ---- --------------- ------------- ---- Canary https://login.microsoftonline.com https://microsoftgraph.com User-defined ``` - Adds user defined environment. - + ## PARAMETERS ### -AzureADEndpoint @@ -125,5 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/add-mgenvironment \ No newline at end of file diff --git a/src/Authentication/docs/Connect-MgGraph.md b/src/Authentication/docs/Connect-MgGraph.md index 9ef5d0af7ce..3db301ef328 100644 --- a/src/Authentication/docs/Connect-MgGraph.md +++ b/src/Authentication/docs/Connect-MgGraph.md @@ -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 @@ -7,9 +7,8 @@ schema: 2.0.0 # Connect-MgGraph -## 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. - +## 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) @@ -50,51 +49,43 @@ Connect-MgGraph [-ContextScope ] [-Environment ] [-ClientT [-EnvironmentVariable] [-NoWelcome] [] ``` -## 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 - +## 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: 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 -TenantId ``` - 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 @@ -102,30 +93,27 @@ Follow this [link](https://learn.microsoft.com/en-us/powershell/microsoftgraph/a 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:\> $ClientSecretCredential = Get-Credential -Credential "Client_Id" # Enter client_secret in the password prompt. PS C:\> Connect-MgGraph -TenantId "Tenant_Id" -ClientSecretCredential $ClientSecretCredential ``` - 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 @@ -139,16 +127,14 @@ USGov https://login.microsoftonline.us https://graph.microsoft.us 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 ### -AccessToken @@ -412,5 +398,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/connect-mggraph \ No newline at end of file diff --git a/src/Authentication/docs/Disconnect-MgGraph.md b/src/Authentication/docs/Disconnect-MgGraph.md index 0414a17ed25..695a525e76e 100644 --- a/src/Authentication/docs/Disconnect-MgGraph.md +++ b/src/Authentication/docs/Disconnect-MgGraph.md @@ -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/disconnect-graph @@ -7,27 +7,24 @@ schema: 2.0.0 # Disconnect-MgGraph -## SYNOPSIS -Once you're signed in, you'll remain signed in until you invoke Disconnect-MgGraph. Microsoft Graph PowerShell automatically refreshes the access token for you and sign-in persists across PowerShell sessions because Microsoft Graph PowerShell securely caches the token. - +## SYNOPSIS +Once you're signed in, you'll remain signed in until you invoke Disconnect-MgGraph. Microsoft Graph PowerShell automatically refreshes the access token for you and sign-in persists across PowerShell sessions because Microsoft Graph PowerShell securely caches the token. ## SYNTAX ``` Disconnect-MgGraph [] ``` -## DESCRIPTION -Use Disconnect-MgGraph to sign out. - -## EXAMPLES +## DESCRIPTION +Use Disconnect-MgGraph to sign out. +## EXAMPLES ### Example 1: Using Disconnect-MgGraph ```powershell PS C:\> Disconnect-MgGraph ``` - Use Disconnect-MgGraph to sign out. - + ## PARAMETERS ### CommonParameters @@ -43,5 +40,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/disconnect-graph](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/disconnect-graph) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/disconnect-graph](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/disconnect-graph \ No newline at end of file diff --git a/src/Authentication/docs/Find-MgGraphCommand.md b/src/Authentication/docs/Find-MgGraphCommand.md index f905c6ce7ab..511ff5a5fcd 100644 --- a/src/Authentication/docs/Find-MgGraphCommand.md +++ b/src/Authentication/docs/Find-MgGraphCommand.md @@ -7,9 +7,8 @@ schema: 2.0.0 # Find-MgGraphCommand -## SYNOPSIS -Find-MgGraphCommand aims to make it easier for you to discover which API path a command calls, by providing a URI or a command name. The Find-MgGraphCommand allows to: - Pass a Microsoft Graph URL (relative and absolute) and get an equivalent Microsoft Graph PowerShell command. - Pass a command and get the URL it calls. - Pass a command or URI wildcard (.*) to find all commands that match it. - +## SYNOPSIS +Find-MgGraphCommand aims to make it easier for you to discover which API path a command calls, by providing a URI or a command name. The Find-MgGraphCommand allows to: - Pass a Microsoft Graph URL (relative and absolute) and get an equivalent Microsoft Graph PowerShell command. - Pass a command and get the URL it calls. - Pass a command or URI wildcard (.*) to find all commands that match it. ## SYNTAX ### FindByCommandOrUri (Default) @@ -30,11 +29,9 @@ Find-MgGraphCommand [-ApiVersion ] -Command [-ProgressAction [] ``` -## DESCRIPTION -Find-MgGraphCommand aims to make it easier for you to discover which API path a command calls, by providing a URI or a command name. - -## EXAMPLES - +## DESCRIPTION +Find-MgGraphCommand aims to make it easier for you to discover which API path a command calls, by providing a URI or a command name. +## EXAMPLES ### Example 1: Use a URI to get all related cmdlets ```powershell PS C:\> Find-MgGraphCommand -Uri "/users/{id}" @@ -55,8 +52,8 @@ Command Module Method URI OutputType Permissions Get-MgUser Users GET /users/{user-id} IMicrosoftGraphUser {DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All...} {Get, GetViaIdentity} Remove-MgUser Users DELETE /users/{user-id} {DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementServiceConfig.ReadWrite.All, Directory.AccessAsUser.All} {Delete1, DeleteViaIdentity1} Update-MgUser Users PATCH /users/{user-id} {DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementServiceConfig.ReadWrite.All, Directory.AccessAsUser.All...} {Update1, UpdateExpanded1, UpdateViaIdentity1, UpdateViaIdentityExpanded1} -``` +``` This example finds all commands that call the provided Microsoft Graph URI. ### Example 2: Pass a command and get the URI it calls @@ -78,7 +75,6 @@ Command Module Method URI OutputType Permissions Get-MgUser Users GET /users/{user-id} IMicrosoftGraphUser {DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All...} {Get, GetViaIdentity} Get-MgUser Users GET /users IMicrosoftGraphUser {DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All...} {List} ``` - This example looks up a command with the provided command name that calls both beta and v1.0 version of the API. ### Example 3: Pass a command and get the permissions required @@ -94,7 +90,6 @@ User.Read.All True Read all users' full profil User.ReadBasic.All False Read all users' basic profiles Allows the app to read a basic set of profile properties of other users in your organization on your behalf. Includes display name, first and last name, email address a... User.ReadWrite.All True Read and write all users' full profiles Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on your behalf. ``` - This example retrieves the scopes required for a particular command. ### Example 4: Find Microsoft Graph PowerShell commands using a command wildcard @@ -112,7 +107,6 @@ Get-MgUserTodoListExtension Users GET /users/{us Get-MgUserTodoListTask Users GET /users/{user-id}/todo/lists/{todoTaskList-id}/tasks Get-MgUserTodoListTask Users GET /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id} ``` - Uses a wildcard syntax to search for commands. ### Example 5: Find Microsoft Graph PowerShell commands using a URI wildcard @@ -126,9 +120,8 @@ Get-MgUserActivity CrossDeviceExperiences GET /users Get-MgUserActivity CrossDeviceExperiences GET /users/{user-id}/activities Get-MgUserActivityHistoryItem CrossDeviceExperiences GET /users/{user-id}/activities/{userActivity-id}/historyItems/{activityHistoryItem-id} ``` - Searches for commands using URI wildcard. - + ## PARAMETERS ### -ApiVersion @@ -241,5 +234,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphcommand](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphcommand) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphcommand](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphcommand \ No newline at end of file diff --git a/src/Authentication/docs/Find-MgGraphPermission.md b/src/Authentication/docs/Find-MgGraphPermission.md index 8e33e492d81..4b42458fe3c 100644 --- a/src/Authentication/docs/Find-MgGraphPermission.md +++ b/src/Authentication/docs/Find-MgGraphPermission.md @@ -7,9 +7,8 @@ schema: 2.0.0 # Find-MgGraphPermission -## SYNOPSIS -The Microsoft Graph PowerShell SDK application requires users to have domain knowledge of both the semantics and syntax of Microsoft Graph API permissions used to authorize access to the API. This cmdlet helps to answer the following questions: - How do I find the values to supply to the permission-related parameters of commands like New-MgApplication and other application and consent related commands? - What permissions are applicable to a certain domain, for example, application, directory? To use Microsoft Graph PowerShell SDK to access Microsoft Graph, users must sign in to an Azure AD application using the Connect-MgGraph command. Use the Find-MgGraphCommand to find which permissions to use for a specific cmdlet or API.- Currently PowerShell commands and scripts, including those implemented with Microsoft Graph PowerShell SDK itself, have no way of validating user input that refers to permissions or providing "auto-complete" user experiences to help users accurately supply input to commands - +## SYNOPSIS +The Microsoft Graph PowerShell SDK application requires users to have domain knowledge of both the semantics and syntax of Microsoft Graph API permissions used to authorize access to the API. This cmdlet helps to answer the following questions: - How do I find the values to supply to the permission-related parameters of commands like New-MgApplication and other application and consent related commands? - What permissions are applicable to a certain domain, for example, application, directory? To use Microsoft Graph PowerShell SDK to access Microsoft Graph, users must sign in to an Azure AD application using the Connect-MgGraph command. Use the Find-MgGraphCommand to find which permissions to use for a specific cmdlet or API.- Currently PowerShell commands and scripts, including those implemented with Microsoft Graph PowerShell SDK itself, have no way of validating user input that refers to permissions or providing "auto-complete" user experiences to help users accurately supply input to commands ## SYNTAX ### Search @@ -24,11 +23,9 @@ Find-MgGraphPermission [-PermissionType ] [-Online] [-All] [-ProgressAct [] ``` -## DESCRIPTION -Retrieves permissions that are applicable to a certain domain. For example application, directory. - -## EXAMPLES - +## DESCRIPTION +Retrieves permissions that are applicable to a certain domain. For example application, directory. +## EXAMPLES ### Example 1: Find permissions related to a given domain ```powershell PS C:\> Find-MgGraphPermission application @@ -47,10 +44,9 @@ Id Consent Name -- ------- ---- ----------- 9a5d68dd-52b0-4cc2-bd40-abcf44ac3a30 Admin Application.Read.All Allows the app to read all applications and service principals without a signed-in user. 1bfefb4e-e0b5-418b-a88f-73c46d2cc8e9 Admin Application.ReadWrite.All Allows the app to create, read, update and delete applications and service principals without a signed-in user. Does not allow management of consent grants. -18a4783c-866b-4cc7-a460-3d5e5662c884 Admin Application.ReadWrite.OwnedBy Allows the app to create other applications, and fully manage those applications (read, update, update application secrets and delete), without a signed-in user. It cannot update any apps that it is not an owner of. +18a4783c-866b-4cc7-a460-3d5e5662c884 Admin Application.ReadWrite.OwnedBy Allows the app to create other applications, and fully manage those applications (read, update, update application secrets and delete), without a signed-in user. Â It cannot update any apps that it is not an owner of. be74164b-cff1-491c-8741-e671cb536e13 Admin Policy.ReadWrite.ApplicationConfiguration Allows the app to read and write your organization's application configuration policies, without a signed-in user. This includes policies such as activityBasedTimeoutPolicy, claimsMappingPolicy, homeRealmDiscoveryPolicy, tokenIssuancePolicy and tokenLifetimePolicy. ``` - Retrieves permissions related to a given domain. ### Example 2: Find the identifier for a specific permission @@ -74,9 +70,8 @@ Consent : Admin Name : Application.Read.All Description : Allows the app to read all applications and service principals without a signed-in user. ``` - Retrieves identifier for a specific permission. - + ## PARAMETERS ### -All @@ -203,5 +198,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphpermission](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphpermission) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphpermission](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/find-mggraphpermission \ No newline at end of file diff --git a/src/Authentication/docs/Get-MgContext.md b/src/Authentication/docs/Get-MgContext.md index 73205cb2963..2086f0fe6dc 100644 --- a/src/Authentication/docs/Get-MgContext.md +++ b/src/Authentication/docs/Get-MgContext.md @@ -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/get-mgcontext @@ -7,20 +7,17 @@ schema: 2.0.0 # Get-MgContext -## SYNOPSIS -Get-MgContext is used to retrieve the details about your current session, which include: - ClientID - TenantID - Certificate Thumbprint - Scopes consented to - AuthType: Delegated or app-only - AuthProviderType - CertificateName - Account - AppName - ContextScope - Certificate - PSHostVersion - ClientTimeOut. - +## SYNOPSIS +Get-MgContext is used to retrieve the details about your current session, which include: - ClientID - TenantID - Certificate Thumbprint - Scopes consented to - AuthType: Delegated or app-only - AuthProviderType - CertificateName - Account - AppName - ContextScope - Certificate - PSHostVersion - ClientTimeOut. ## SYNTAX ``` Get-MgContext [] ``` -## DESCRIPTION -Retrieves session details. - -## EXAMPLES - +## DESCRIPTION +Retrieves session details. +## EXAMPLES ### Example 1: Using Get-MgContext ```powershell PS C:\> Get-MgContext @@ -38,7 +35,6 @@ Certificate : PSHostVersion : 5.1.17763.1 ClientTimeout : 00:05:00 ``` - Retrieves session details. ### Example 2: Using Get-MgContext: Retrieve all scopes you've consented to @@ -56,9 +52,8 @@ RoleManagement.ReadWrite.Directory User.Read User.ReadWrite.All ``` - Retrieves all scopes. - + ## PARAMETERS ### CommonParameters @@ -74,5 +69,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgcontext](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgcontext) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgcontext](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgcontext \ No newline at end of file diff --git a/src/Authentication/docs/Get-MgEnvironment.md b/src/Authentication/docs/Get-MgEnvironment.md index bfbeeb85d49..03d504116ec 100644 --- a/src/Authentication/docs/Get-MgEnvironment.md +++ b/src/Authentication/docs/Get-MgEnvironment.md @@ -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/get-mgenvironment @@ -7,20 +7,17 @@ schema: 2.0.0 # Get-MgEnvironment -## SYNOPSIS -When you use Connect-MgGraph, you can choose to target other environments. By default, Connect-MgGraph targets the global public cloud. - +## SYNOPSIS +When you use Connect-MgGraph, you can choose to target other environments. By default, Connect-MgGraph targets the global public cloud. ## SYNTAX ``` Get-MgEnvironment [[-Name] ] [] ``` -## DESCRIPTION -When you use Connect-MgGraph, you can choose to target other environments. By default, Connect-MgGraph targets the global public cloud. - -## EXAMPLES - +## DESCRIPTION +When you use Connect-MgGraph, you can choose to target other environments. By default, Connect-MgGraph targets the global public cloud. +## EXAMPLES ### Example 1: Get-MgEnvironment ```powershell PS C:\> Get-MgEnvironment @@ -31,9 +28,8 @@ Global https://login.microsoftonline.com https://graph.microsoft.com USGov https://login.microsoftonline.us https://graph.microsoft.us Built-in USGovDoD https://login.microsoftonline.us https://dod-graph.microsoft.us Built-in ``` - This command gets list of all environments. - + ## PARAMETERS ### -Name @@ -64,5 +60,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment \ No newline at end of file diff --git a/src/Authentication/docs/Get-MgGraphOption.md b/src/Authentication/docs/Get-MgGraphOption.md index 3f5c023fb4c..5f660198573 100644 --- a/src/Authentication/docs/Get-MgGraphOption.md +++ b/src/Authentication/docs/Get-MgGraphOption.md @@ -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/get-mgenvironment @@ -7,20 +7,17 @@ schema: 2.0.0 # Get-MgGraphOption -## SYNOPSIS -Gets global configurations that apply to the SDK. For example, check if Web Account Manager (WAM) support has been enabled. - +## SYNOPSIS +Gets global configurations that apply to the SDK. For example, check if Web Account Manager (WAM) support has been enabled. ## SYNTAX ``` Get-MgGraphOption [] ``` -## DESCRIPTION -Gets global configurations that apply to the SDK. For example, check if Web Account Manager (WAM) support has been enabled. - -## EXAMPLES - +## DESCRIPTION +Gets global configurations that apply to the SDK. For example, check if Web Account Manager (WAM) support has been enabled. +## EXAMPLES ### Example 1: Check if WAM support has been enabled ```powershell PS C:\> Get-MgGraphOption @@ -28,9 +25,8 @@ EnableWAMForMSGraph -------------------- True ``` - -Confirms if WAM support has been enabled. - +Confirms if WAM support has been enabled. Web Account Manager is enabled by default on Windows systems and cannot be disabled. + ## PARAMETERS ### CommonParameters @@ -47,4 +43,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES Web Account Manager is enabled by default on Windows systems and cannot be disabled. Setting the `EnableWAMForMSGraph` option no longer has any effect. -## RELATED LINKS +## RELATED LIN \ No newline at end of file diff --git a/src/Authentication/docs/Get-MgRequestContext.md b/src/Authentication/docs/Get-MgRequestContext.md index 57dc6171167..a97e870479c 100644 --- a/src/Authentication/docs/Get-MgRequestContext.md +++ b/src/Authentication/docs/Get-MgRequestContext.md @@ -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/get-mgenvironment @@ -7,20 +7,17 @@ schema: 2.0.0 # Get-MgRequestContext -## SYNOPSIS -Gets graph request context details - +## SYNOPSIS +Gets graph request context details ## SYNTAX ``` Get-MgRequestContext [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION -Gets graph request context details - -## EXAMPLES - +## DESCRIPTION +Gets graph request context details +## EXAMPLES ### Example 1: Get request context ```powershell PS C:\> Get-MgRequestContext @@ -28,9 +25,8 @@ ClientTimeout RetryDelay MaxRetry Retri ------------- ---------- -------- ---------------- 00:00:05 3 2 00:00:02 ``` - Gets graph request context details - + ## PARAMETERS ### -Confirm @@ -77,4 +73,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -## RELATED LINKS +## RELATED LIN \ No newline at end of file diff --git a/src/Authentication/docs/Invoke-MgGraphRequest.md b/src/Authentication/docs/Invoke-MgGraphRequest.md index 5db5c8f361a..7b281ef79a8 100644 --- a/src/Authentication/docs/Invoke-MgGraphRequest.md +++ b/src/Authentication/docs/Invoke-MgGraphRequest.md @@ -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/invoke-mggraphrequest @@ -7,9 +7,8 @@ schema: 2.0.0 # Invoke-MgGraphRequest -## SYNOPSIS -Invoke-MgGraphRequest issues REST API requests to the Graph API. It works for any Graph API if you know the REST URI, method, and optional body parameter. This command is especially useful for accessing APIs for which there isn't an equivalent cmdlet yet. - +## SYNOPSIS +Invoke-MgGraphRequest issues REST API requests to the Graph API. It works for any Graph API if you know the REST URI, method, and optional body parameter. This command is especially useful for accessing APIs for which there isn't an equivalent cmdlet yet. ## SYNTAX ``` @@ -21,11 +20,9 @@ Invoke-MgGraphRequest [[-Method] ] [-Uri] [[-Body] ] ``` -## DESCRIPTION -This command issues REST API requests. - -## EXAMPLES - +## DESCRIPTION +This command issues REST API requests. +## EXAMPLES ### Example 1: Using Invoke-MgGraphRequest ```powershell PS C:\> Invoke-MgGraphRequest -Method GET https://graph.microsoft.com/v1.0/me @@ -44,9 +41,8 @@ officeLocation businessPhones {425-555-0100} surname Administrator ``` - Issues REST API requests. - + ## PARAMETERS ### -Body @@ -322,5 +318,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/invoke-mggraphrequest \ No newline at end of file diff --git a/src/Authentication/docs/Microsoft.Graph.Authentication.md b/src/Authentication/docs/Microsoft.Graph.Authentication.md index c09769b3ccc..d976255704a 100644 --- a/src/Authentication/docs/Microsoft.Graph.Authentication.md +++ b/src/Authentication/docs/Microsoft.Graph.Authentication.md @@ -1,6 +1,6 @@ ---- +--- Module Name: Microsoft.Graph.Authentication -Module Guid: 0fecf360-9875-4e02-998c-b6d7b6653b6b +Module Guid: 49546c54-147a-482e-9a9e-78b954f26400 Download Help Link: https://learn.microsoft.com/powershell/module/Microsoft.Graph.Authentication Help Version: 1.0.0.0 Locale: en-US @@ -53,3 +53,7 @@ Sets global configurations that apply to the SDK. For example, toggle Web Accoun ### [Set-MgRequestContext](Set-MgRequestContext.md) Sets request context for Microsoft Graph invocations + + + + diff --git a/src/Authentication/docs/Remove-MgEnvironment.md b/src/Authentication/docs/Remove-MgEnvironment.md index 4fd5c7a0446..d1dfabdf2fd 100644 --- a/src/Authentication/docs/Remove-MgEnvironment.md +++ b/src/Authentication/docs/Remove-MgEnvironment.md @@ -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/remove-mgenvironment @@ -7,20 +7,17 @@ schema: 2.0.0 # Remove-MgEnvironment -## SYNOPSIS -Removes Microsoft Graph environment to the settings file - +## SYNOPSIS +Removes Microsoft Graph environment to the settings file ## SYNTAX ``` Remove-MgEnvironment [-Name] [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION -Removes Microsoft Graph environment to the settings file - -## EXAMPLES - +## DESCRIPTION +Removes Microsoft Graph environment to the settings file +## EXAMPLES ### Example 1: Remove user-defined environment ```powershell PS C:\> Remove-MgEnvironment Canary @@ -28,9 +25,8 @@ Name AzureADEndpoint GraphEndpoint Type ---- --------------- ------------- ---- Canary https://login.microsoftonline.com https://microsoftgraph.com User-defined ``` - Removes user-defined environment. - + ## PARAMETERS ### -Name @@ -94,5 +90,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/remove-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/remove-mgenvironment) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/remove-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/remove-mgenvironment \ No newline at end of file diff --git a/src/Authentication/docs/Set-MgEnvironment.md b/src/Authentication/docs/Set-MgEnvironment.md index 12e2632fce2..cf29b96b411 100644 --- a/src/Authentication/docs/Set-MgEnvironment.md +++ b/src/Authentication/docs/Set-MgEnvironment.md @@ -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/set-mgenvironment @@ -7,9 +7,8 @@ schema: 2.0.0 # Set-MgEnvironment -## SYNOPSIS -Sets a Microsoft Graph environment to the settings file. - +## SYNOPSIS +Sets a Microsoft Graph environment to the settings file. ## SYNTAX ``` @@ -17,18 +16,15 @@ Set-MgEnvironment [-Name] [[-AzureADEndpoint] ] [[-GraphEndpoin [-Confirm] [] ``` -## DESCRIPTION -Sets a Microsoft Graph environment to the settings file. - -## EXAMPLES - +## DESCRIPTION +Sets a Microsoft Graph environment to the settings file. +## EXAMPLES ### Example 1: Set environment for the current session ```powershell PS C:\> Set-MgEnvironment -GraphEndpoint "https://canary.graph.microsoft.com" -AzureADEndpoint "https://login.microsoftonline.com" ``` - Sets the environment for the current session. - + ## PARAMETERS ### -AzureADEndpoint @@ -122,5 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment) - +[https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment \ No newline at end of file diff --git a/src/Authentication/docs/Set-MgGraphOption.md b/src/Authentication/docs/Set-MgGraphOption.md index bdcc5acf082..a4acf3a5f8c 100644 --- a/src/Authentication/docs/Set-MgGraphOption.md +++ b/src/Authentication/docs/Set-MgGraphOption.md @@ -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/set-mgenvironment @@ -7,27 +7,24 @@ schema: 2.0.0 # Set-MgGraphOption -## SYNOPSIS -Sets global configurations that apply to the SDK. For example, toggle Web Account Manager (WAM) support. Web Account Manager is enabled by default on Windows systems and cannot be disabled. - +## SYNOPSIS +Sets global configurations that apply to the SDK. For example, toggle Web Account Manager (WAM) support. ## SYNTAX ``` Set-MgGraphOption [-EnableLoginByWAM ] [] ``` -## DESCRIPTION -Sets global configurations that apply to the SDK. For example, toggle Web Account Manager (WAM) support. - -## EXAMPLES - +## DESCRIPTION +Sets global configurations that apply to the SDK. For example, toggle Web Account Manager (WAM) support. +## EXAMPLES ### Example 1: Set web account manager support ```powershell PS C:\> Set-MgGraphOption -EnableLoginByWAM $True ``` - Sets web account manager support - + Note: Signin by Web Account Manager (WAM) is enabled by default on Windows and cannot be disabled. Setting this option will no longer have any effect. + ## PARAMETERS ### -EnableLoginByWAM @@ -57,4 +54,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES -## RELATED LINKS +## RELATED LIN \ No newline at end of file diff --git a/src/Authentication/docs/Set-MgRequestContext.md b/src/Authentication/docs/Set-MgRequestContext.md index afd36ba276b..b9fff1d6cc2 100644 --- a/src/Authentication/docs/Set-MgRequestContext.md +++ b/src/Authentication/docs/Set-MgRequestContext.md @@ -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/set-mgenvironment @@ -7,9 +7,8 @@ schema: 2.0.0 # Set-MgRequestContext -## SYNOPSIS -Sets request context for Microsoft Graph invocations - +## SYNOPSIS +Sets request context for Microsoft Graph invocations ## SYNTAX ``` @@ -17,11 +16,9 @@ Set-MgRequestContext [-RetryDelay ] [-MaxRetry ] [-RetriesTimeLimi [-ClientTimeout ] [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION -Sets request context for Microsoft Graph invocations - -## EXAMPLES - +## DESCRIPTION +Sets request context for Microsoft Graph invocations +## EXAMPLES ### Example 1: Set Http client timeout in seconds ```powershell PS C:\> Set-MgRequestContext -ClientTimeout 5 @@ -29,7 +26,6 @@ ClientTimeout RetryDelay MaxRetry Retri ------------- ---------- -------- ---------------- 00:00:05 3 2 00:00:00 ``` - Sets Http client timeout in seconds. ### Example 2: Set the maximum time in seconds allowed for request retries @@ -39,7 +35,6 @@ ClientTimeout RetryDelay MaxRetry Retri ------------- ---------- -------- ---------------- 00:00:05 3 2 00:00:02 ``` - Sets the maximum time in seconds allowed for request retries. ### Example 3: Set the maximum number of retries for a request @@ -49,7 +44,6 @@ ClientTimeout RetryDelay MaxRetry Retri ------------- ---------- -------- ---------------- 00:00:05 3 2 00:00:02 ``` - Sets the maximum number of retries for a request. ### Example 4: Set the waiting time in seconds before retrying a request @@ -59,9 +53,8 @@ ClientTimeout RetryDelay MaxRetry Retri ------------- ---------- -------- ---------------- 00:00:05 3 2 00:00:02 ``` - Sets the waiting time in seconds before retrying a request. - + ## PARAMETERS ### -ClientTimeout @@ -170,4 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -## RELATED LINKS +## RELATED LIN \ No newline at end of file