diff --git a/src/Accounts/Accounts/help/Clear-AzConfig.md b/src/Accounts/Accounts/help/Clear-AzConfig.md index 9c3fa08e2a05..a1ac3ce5f453 100644 --- a/src/Accounts/Accounts/help/Clear-AzConfig.md +++ b/src/Accounts/Accounts/help/Clear-AzConfig.md @@ -21,10 +21,10 @@ Clear-AzConfig [-Force] [-PassThru] [-AppliesTo ] [-Scope ] ### ClearByKey ``` Clear-AzConfig [-PassThru] [-AppliesTo ] [-Scope ] - [-DefaultProfile ] [-WhatIf] [-Confirm] - [-CheckForUpgrade] [-DefaultSubscriptionForLogin] [-DisableErrorRecordsPersistence] - [-DisplayBreakingChangeWarning] [-DisplayRegionIdentified] [-DisplaySecretsWarning] - [-DisplaySurveyMessage] [-EnableDataCollection] [-EnableLoginByWam] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-CheckForUpgrade] + [-DefaultSubscriptionForLogin] [-DisableErrorRecordsPersistence] [-DisableInstanceDiscovery] + [-DisplayBreakingChangeWarning] [-DisplayRegionIdentified] [-DisplaySurveyMessage] [-EnableDataCollection] + [-EnableLoginByWam] [] ``` ## DESCRIPTION @@ -131,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DisableInstanceDiscovery +Set it to true to disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to true, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayBreakingChangeWarning Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. diff --git a/src/Accounts/Accounts/help/Get-AzConfig.md b/src/Accounts/Accounts/help/Get-AzConfig.md index 2656131d9f21..6f0908865079 100644 --- a/src/Accounts/Accounts/help/Get-AzConfig.md +++ b/src/Accounts/Accounts/help/Get-AzConfig.md @@ -15,8 +15,8 @@ Gets the configs of Azure PowerShell. ``` Get-AzConfig [-AppliesTo ] [-Scope ] [-DefaultProfile ] [-CheckForUpgrade] [-DefaultSubscriptionForLogin] [-DisableErrorRecordsPersistence] - [-DisplayBreakingChangeWarning] [-DisplayRegionIdentified] [-DisplaySecretsWarning] - [-DisplaySurveyMessage] [-EnableDataCollection] [-EnableLoginByWam] [] + [-DisableInstanceDiscovery] [-DisplayBreakingChangeWarning] [-DisplayRegionIdentified] [-DisplaySurveyMessage] + [-EnableDataCollection] [-EnableLoginByWam] [] ``` ## DESCRIPTION @@ -142,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DisableInstanceDiscovery +Set it to true to disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to true, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayBreakingChangeWarning Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. diff --git a/src/Accounts/Accounts/help/Update-AzConfig.md b/src/Accounts/Accounts/help/Update-AzConfig.md index 44bf1caef1e9..d1e7e40a2af7 100644 --- a/src/Accounts/Accounts/help/Update-AzConfig.md +++ b/src/Accounts/Accounts/help/Update-AzConfig.md @@ -15,10 +15,10 @@ Updates the configs of Azure PowerShell. ``` Update-AzConfig [-AppliesTo ] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] [-CheckForUpgrade ] [-DefaultSubscriptionForLogin ] - [-DisableErrorRecordsPersistence ] [-DisplayBreakingChangeWarning ] - [-DisplayRegionIdentified ] [-DisplaySecretsWarning ] - [-DisplaySurveyMessage ] [-EnableDataCollection ] - [-EnableLoginByWam ] [] + [-DisableErrorRecordsPersistence ] [-DisableInstanceDiscovery ] + [-DisplayBreakingChangeWarning ] [-DisplayRegionIdentified ] + [-DisplaySurveyMessage ] [-EnableDataCollection ] [-EnableLoginByWam ] + [] ``` ## DESCRIPTION @@ -168,6 +168,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DisableInstanceDiscovery +Set it to true to disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to true, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -DisplayBreakingChangeWarning Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. diff --git a/src/Accounts/Authentication/Config/Definitions/DisableInstanceDiscoveryConfig.cs b/src/Accounts/Authentication/Config/Definitions/DisableInstanceDiscoveryConfig.cs index 56f533597a18..ee55d9c7df2a 100644 --- a/src/Accounts/Authentication/Config/Definitions/DisableInstanceDiscoveryConfig.cs +++ b/src/Accounts/Authentication/Config/Definitions/DisableInstanceDiscoveryConfig.cs @@ -23,11 +23,11 @@ namespace Microsoft.Azure.Commands.Common.Authentication.Config.Definitions { /// - /// Definition of the config to control whether login by WAM (web account manager) or not. + /// Definition of the config to control whether to disable both instance discovery and authority validation. /// internal class DisableInstanceDiscoveryConfig : TypedConfig { - public override object DefaultValue => false; // Opt-in. Will change to opt-out. + public override object DefaultValue => false; public override string Key => ConfigKeys.DisableInstanceDiscovery;