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

Get-AzConfig

获取 Azure PowerShell 的配置。

语法

Get-AzConfig
   [-AppliesTo <String>]
   [-Scope <ConfigScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-CheckForUpgrade]
   [-DefaultSubscriptionForLogin]
   [-DisableErrorRecordsPersistence]
   [-DisableInstanceDiscovery]
   [-DisplayBreakingChangeWarning]
   [-DisplayRegionIdentified]
   [-DisplaySurveyMessage]
   [-EnableDataCollection]
   [-EnableLoginByWam]
   [<CommonParameters>]

说明

获取 Azure PowerShell 的配置。 默认情况下,它会列出所有配置。 可以使用各种参数筛选结果。

注意

配置具有优先级。 一般来说,进程范围优先级高于 CurrentUser 范围;适用于特定 cmdlet 的配置优先级高于模块的优先级,同样高于 Az。 为了减少混淆,结果 Get-AzConfig 显示这些配置正在生效。 它是所有配置的组合,但并不是所有配置。 但是,可以通过应用不同的筛选器参数(例如 -Scope)来查看它们。

示例

示例 1

Get-AzConfig

Key                           Value Applies To Scope       Help Message
---                           ----- ---------- -----       ------------
EnableDataCollection          False Az         CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom…
DefaultSubscriptionForLogin         Az         Default     Subscription name or GUID. Sets the default context for Azure PowerShell when logging in with…
DisplayBreakingChangeWarning  True  Az         Default     Controls if warning messages for breaking changes are displayed or suppressed. When enabled, …

获取所有配置。

示例 2

Get-AzConfig -EnableDataCollection

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

获取“EnableDataCollection”配置。

参数

-AppliesTo

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

  • “Az”:配置适用于 Azure PowerShell 的所有模块和 cmdlet。
  • 模块名称:配置适用于 Azure PowerShell 的特定模块。 例如,“Az.存储”。
  • Cmdlet 名称:配置适用于 Azure PowerShell 的特定 cmdlet。 例如,“Get-AzKeyVault”。 如果未指定,在获取或清除配置时,默认为上述所有配置;更新时,默认为“Az”。
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckForUpgrade

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultSubscriptionForLogin

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableErrorRecordsPersistence

禁用时,错误记录不会写入 ~/。Azure/ErrorRecords。 此配置将替换为“EnableErrorRecordsPersistence”,作为在 2023 年 11 月左右 Az 的下一个主要版本中选择加入。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableInstanceDiscovery

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayBreakingChangeWarning

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayRegionIdentified

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplaySecretsWarning

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplaySurveyMessage

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableDataCollection

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableLoginByWam

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

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

Type:ConfigScope
Accepted values:CurrentUser, Process, Default, Environment
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

None

输出

PSConfig