共用方式為


Update-AzConfig

更新 Azure PowerShell 的設定。

語法

Default (預設值)

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,…

將 “DisplayBreakingChangeWarnings” 設定設定為 “Az.KeyVault” 模組的 “$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
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CheckForUpgrade

啟用時,Azure PowerShell 會自動檢查更新,並在有可用更新時顯示提示訊息。 預設值為 True。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Confirm

在執行 Cmdlet 之前,提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:參見

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

參數屬性

類型:IAzureContextContainer
預設值:None
支援萬用字元:False
不要顯示:False
別名:AzContext, AzureRmContext, AzureCredential

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultSubscriptionForLogin

訂用帳戶名稱或 GUID。 在登入而不指定訂用帳戶時設定 Azure PowerShell 的預設內容。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DisableInstanceDiscovery

將它設為 true ,以停用實例探索及權限驗證。 這項功能適用於無法連線到元數據端點的案例,例如在私人雲端或 Azure Stack 中。 實例探索的程式需要從 https://login.microsoft.com/ 擷取授權單位元數據來驗證授權單位。 透過將此設定為 true,會停用權限的驗證。 因此,確保配置的授權主機有效且值得信賴至關重要。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DisplayBreakingChangeWarning

控制是否顯示或隱藏重大變更的警告訊息。 啟用時,在未來版本中執行具有重大變更的 Cmdlet 時,會顯示重大變更警告。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DisplayRegionIdentified

啟用時,Azure PowerShell 會顯示區域的建議,以降低您的成本。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DisplaySecretsWarning

啟用時,當 cmdlet 輸出包含秘密時,將顯示警告訊息。 瞭解更多https://go.microsoft.com/fwlink/?linkid=2258844

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DisplaySurveyMessage

啟用時,系統會不常提示您參與 Azure PowerShell 的使用者體驗問卷。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnableDataCollection

啟用時,Azure PowerShell Cmdlet 會將遙測資料傳送至 Microsoft,以改善客戶體驗。 如需詳細資訊,請參閱我們的隱私權聲明: https://aka.ms/privacy

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnableErrorRecordsPersistence

啟用後,錯誤記錄將寫入 ~/。Azure/ErrorRecords。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnableLoginByWam

[預覽]啟用後,Web Account Manager (WAM) 將是預設的互動式登入體驗。 如果平台不支援 WAM,它將回退到使用瀏覽器。 請注意,此功能處於預覽狀態。 目前不支援 Microsoft 帳戶 (MSA)。 如果您有任何意見反應,請隨時連絡 Azure PowerShell 小組: https://aka.ms/azpsissue

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-LoginExperienceV2

只有在以互動方式驗證時才會作用中,可讓使用者選擇後續命令中使用的訂用帳戶和租用戶。 廣告的可能值為「開啟」(預設)和「關閉」。 「開啟」需要使用者輸入。 'Off' 會使用 Azure 傳回的第一個租用戶和訂用帳戶,可能會變更,恕不另行通知,並導致在不需要的內容中執行命令 (不建議使用)。

參數屬性

類型:LoginExperienceConfig
預設值:None
接受的值:On, Off
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Scope

決定組態變更的範圍,例如,變更是否僅套用至目前的處理程序,或套用至此使用者啟動的所有工作階段。 預設為 CurrentUser。

參數屬性

類型:ConfigScope
預設值:None
接受的值:CurrentUser, Process, Default, Environment
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:威斯康辛

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

Boolean

String

輸出

PSConfig