共用方式為


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>]

Description

更新 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

只有在以互動方式進行驗證時,使用者才能選擇後續命令中使用的訂用帳戶和租使用者。 可能的值廣告 『On』 (預設值) 和 『Off』。 'On' 需要使用者的輸入。 'Off' 會使用 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