你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Update-AzConfig

更新 Azure PowerShell 的配置。

语法

Update-AzConfig
      [-AppliesTo <String>]
      [-Scope <ConfigScope>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-CheckForUpgrade <Boolean>]
      [-DefaultSubscriptionForLogin <String>]
      [-DisableInstanceDiscovery <Boolean>]
      [-DisplayBreakingChangeWarning <Boolean>]
      [-DisplayRegionIdentified <Boolean>]
      [-DisplaySecretsWarning <Boolean>]
      [-DisplaySurveyMessage <Boolean>]
      [-EnableDataCollection <Boolean>]
      [-EnableErrorRecordsPersistence <Boolean>]
      [-EnableLoginByWam <Boolean>]
      [<CommonParameters>]

说明

更新 Azure PowerShell 的配置。 根据要更新的配置,可以指定要在其中保留配置的范围以及它应用于的模块或 cmdlet 的范围。

注意

不建议在多个 PowerShell 进程中更新配置。 在一个进程中执行此操作,或确保更新位于进程范围(-Scope Process)以避免意外的副作用。

示例

示例 1

Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription"

Key                         Value                Applies To Scope       Help Message
---                         -----                ---------- -----       ------------
DefaultSubscriptionForLogin Name of subscription Az         CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo…

将“DefaultSubscriptionForLogin”配置设置为“订阅名称”。 将指定订阅选为默认订阅时 Connect-AzAccount

示例 2

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault"

Key                          Value Applies To  Scope       Help Message
---                          ----- ----------  -----       ------------
DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,…

将“Az.KeyVault”模块的“DisplayBreakingChangeWarnings”配置设置为“$false”。 这可以防止 Az.KeyVault 模块中即将发生的中断性变更的所有警告消息提示。

示例 3

Update-AzConfig -EnableDataCollection $true

Key                  Value Applies To Scope       Help Message
---                  ----- ---------- -----       ------------
EnableDataCollection True  Az         CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi…

将“EnableDataCollection”配置设置为“$true”。 这样就可以发送遥测数据。 设置此配置等效于 Enable-AzDataCollectionDisable-AzDataCollection

示例 4

Update-AzConfig -DisplaySecretsWarning $true

Key                   Value Applies To Scope       Help Message
---                   ----- ---------- -----       ------------
DisplaySecretsWarning True  Az         CurrentUser When enabled, a warning message for secrets redaction will be displ…

将“DisplaySecretsWarning”配置设置为“$true”。 这将在 cmdlet 执行期间启用机密检测,并在输出中找到任何机密时显示警告消息。

参数

-AppliesTo

指定配置适用的 Azure PowerShell 部分。 可能的值为:

  • “Az”:配置适用于 Azure PowerShell 的所有模块和 cmdlet。
  • 模块名称:配置适用于 Azure PowerShell 的特定模块。 例如,“Az.Storage”。
  • Cmdlet 名称:配置适用于 Azure PowerShell 的特定 cmdlet。 例如,“Get-AzKeyVault”。 如果未指定,在获取或清除配置时,默认为上述所有配置;更新时,默认为“Az”。
类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CheckForUpgrade

启用后,Azure PowerShell 将自动检查更新,并在更新可用时显示提示消息。 默认值为 true。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultSubscriptionForLogin

订阅名称或 GUID。 在未指定订阅的情况下登录时设置 Azure PowerShell 的默认上下文。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-DisableInstanceDiscovery

将其设置为 true 以禁用实例发现和颁发机构验证。 此功能适用于无法访问元数据终结点的情况,例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据来验证颁发机构。 通过将此项设置为 true,将禁用颁发机构的验证。 因此,确保配置的颁发机构主机有效且可信至关重要。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-DisplayBreakingChangeWarning

控制是否显示或禁止显示中断性变更的警告消息。 启用后,在将来的版本中执行具有中断性变更的 cmdlet 时,会显示中断性变更警告。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-DisplayRegionIdentified

启用后,Azure PowerShell 会显示有关可能会降低成本的区域的建议。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-DisplaySecretsWarning

启用后,当 cmdlet 输出包含机密时,将显示警告消息。 有关详细信息,请访问 https://go.microsoft.com/fwlink/?linkid=2258844

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-DisplaySurveyMessage

启用后,系统经常提示你参与 Azure PowerShell 的用户体验调查。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-EnableDataCollection

启用后,Azure PowerShell cmdlet 会将遥测数据发送到Microsoft以提高客户体验。 有关详细信息,请参阅我们的隐私声明: https://aka.ms/privacy

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-EnableErrorRecordsPersistence

启用后,错误记录将写入 ~/。Azure/ErrorRecords。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-EnableLoginByWam

[预览]启用后,Web 帐户管理器(WAM)将是默认的交互式登录体验。 如果平台不支持 WAM,它将回退到使用浏览器。 请注意,此功能处于预览状态。 当前不支持Microsoft帐户(MSA)。 如有任何反馈,请随时联系 Azure PowerShell 团队: https://aka.ms/azpsissue

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-LoginExperienceV2

仅当以交互方式进行身份验证时,用户才能选择后续命令中使用的订阅和租户。 可能的值广告“开”(默认值)和“关”。 “打开”需要用户的输入。 “关闭”将使用 Azure 返回的第一个租户和订阅,可以在不通知的情况下进行更改,并导致在不需要的上下文中执行命令(不建议)。

类型:LoginExperienceConfig
接受的值:On, Off
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Scope

确定配置更改的范围,例如,更改仅适用于当前进程,还是应用于此用户启动的所有会话。 默认情况下,它是 CurrentUser。

类型:ConfigScope
接受的值:CurrentUser, Process, Default, Environment
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

Boolean

String

输出

PSConfig