az maintenance configuration

Note

此參考是 Azure CLI 維護延伸模組 的一部分（2.67.0 版或更高版本）。 擴充功能會在您第一次執行 az maintenance configuration 命令時自動安裝。 深入了解擴充功能。

使用維護管理維護組態。

命令

名稱	Description	類型	狀態
az maintenance configuration create	建立組態記錄。	Extension	GA
az maintenance configuration delete	刪除設定記錄。	Extension	GA
az maintenance configuration list	列出訂用帳戶和資源群組內的組態記錄。	Extension	GA
az maintenance configuration show	取得組態記錄。	Extension	GA
az maintenance configuration update	更新組態記錄。	Extension	GA

az maintenance configuration create

建立組態記錄。

az maintenance configuration create --name --resource-name
                                    --resource-group
                                    [--duration --maintenance-window-duration]
                                    [--expiration-date-time --maintenance-window-expiration-date-time]
                                    [--extension-properties]
                                    [--install-patches-linux-parameters --linux-parameters]
                                    [--install-patches-windows-parameters --windows-parameters]
                                    [--location]
                                    [--maintenance-scope {Extension, Host, InGuestPatch, OSImage, Resource, SQLDB, SQLManagedInstance}]
                                    [--maintenance-window-recur-every --recur-every]
                                    [--maintenance-window-start-date-time --start-date-time]
                                    [--maintenance-window-time-zone --time-zone]
                                    [--namespace]
                                    [--reboot-setting {Always, IfRequired, Never}]
                                    [--tags]
                                    [--visibility {Custom, Public}]

範例

MaintenanceConfigurations_CreateOrUpdateForResource

az maintenance configuration create --location "westus2" --maintenance-scope "OSImage" --maintenance-window-duration "05:00" --maintenance-window-expiration-date-time "9999-12-31 00:00" --maintenance-window-recur-every "Day" --maintenance-window-start-date-time "2020-04-30 08:00" --maintenance-window-time-zone "Pacific Standard Time" --namespace "Microsoft.Maintenance" --visibility "Custom" --resource-group "examplerg" --resource-name "configuration1"

必要參數

--name --resource-name -n

維護組態名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--duration --maintenance-window-duration

HH：mm 格式的維護期間。 如果未提供，則會根據提供的維護範圍使用預設值。 範例：05：00。

屬性	值
參數群組:	MaintenanceWindow Arguments

--expiration-date-time --maintenance-window-expiration-date-time

YYYY-MM-DD hh：mm 格式之維護時段的有效到期日。 視窗將會在提供的時區中建立，並根據該時區調整為日光節約。 到期日必須設定為未來的日期。 如果未提供，則會將它設定為日期時間上限 9999-12-31 23：59：59。

屬性	值
參數群組:	MaintenanceWindow Arguments

--extension-properties

取得或設定 maintenanceConfiguration 支援速記語法、json-file 和 yaml-file 的 extensionProperties。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--install-patches-linux-parameters --linux-parameters

修補 Linux 計算機特有的輸入參數。 若為 Windows 計算機，請勿傳遞此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	InstallPatches Arguments

--install-patches-windows-parameters --windows-parameters

修補 Windows 電腦的特定輸入參數。 針對Linux機器，請勿傳遞此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	InstallPatches Arguments

--location -l

取得或設定資源的位置。

屬性	值
參數群組:	Configuration Arguments

--maintenance-scope

取得或設定組態的 maintenanceScope。

屬性	值
參數群組:	Properties Arguments
接受的值:	Extension, Host, InGuestPatch, OSImage, Resource, SQLDB, SQLManagedInstance

--maintenance-window-recur-every --recur-every

維護期間預期會遞迴的速率。 速率可以表示為每日、每周或每月排程。 每日排程會格式化為 recurEvery： [Frequency as integer]['Day（s）']。 如果未提供任何頻率，則默認頻率為1。 每日排程範例為 recurEvery：Day、recurEvery：3Days。 每周排程的格式為 recurEvery： [Frequency as integer]['Week（s）'] [週一-星期日的選擇性逗號分隔列表]。 每周排程範例為 recurEvery：3Weeks、recurEvery：Week Saturday、Sunday。 每月排程的格式為 [Frequency as integer]['Month（s）'] [以逗號分隔的月份天數列表] 或 [Frequency as integer]['Month（s）] [Month of Month （First， Second， Third， Fourth， Last）] [Weekday Monday-Sunday] [Optional Offset（No. of days）]。 位移值必須介於 -6 到 6 之間。 每月排程範例為 recurEvery：Month、recurEvery：2Months、recurEvery：Month day23，day24、recurEvery：Month Last Sunday、recurEvery：Month Fourth Monday、recurEvery：Month Last Sunday Offset-3、recurEvery：Month Third Sunday Offset6。

屬性	值
參數群組:	MaintenanceWindow Arguments

--maintenance-window-start-date-time --start-date-time

YYYY-MM-DD hh：mm 格式之維護期間的有效開始日期。 開始日期可以設定為目前的日期或未來的日期。 視窗將會在提供的時區中建立，並根據該時區調整為日光節約。

屬性	值
參數群組:	MaintenanceWindow Arguments

--maintenance-window-time-zone --time-zone

時區的名稱。 您可以在 PowerShell 中執行 [System.TimeZoneInfo]：：GetSystemTimeZones（） 來取得時區清單。 範例：太平洋標準時間、UTC、W. 歐洲標準時間、韓國標準時間、Cen。 澳大利亞標準時間。

屬性	值
參數群組:	MaintenanceWindow Arguments

--namespace

取得或設定資源的命名空間。

屬性	值
參數群組:	Properties Arguments

--reboot-setting

根據使用者所定義的可能重新啟動喜好設定，決定在修補作業完成之後，將機器重新啟動。

屬性	值
參數群組:	InstallPatches Arguments
接受的值:	Always, IfRequired, Never

--tags

取得或設定資源支援速記語法、json-file 和 yaml-file 的標記。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Configuration Arguments

--visibility

取得或設定組態的可見性。 默認值為 『Custom』。

屬性	值
參數群組:	Properties Arguments
接受的值:	Custom, Public

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az maintenance configuration delete

刪除設定記錄。

az maintenance configuration delete [--ids]
                                    [--name --resource-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

範例

MaintenanceConfigurations_DeleteForResource

az maintenance configuration delete --resource-group "examplerg" --resource-name "example1"

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name --resource-name -n

維護組態名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az maintenance configuration list

列出訂用帳戶和資源群組內的組態記錄。

az maintenance configuration list [--resource-group]

範例

MaintenanceConfigurations_List

az maintenance configuration list

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az maintenance configuration show

取得組態記錄。

az maintenance configuration show [--ids]
                                  [--name --resource-name]
                                  [--resource-group]
                                  [--subscription]

範例

MaintenanceConfigurations_GetForResource

az maintenance configuration show --resource-group "examplerg" --resource-name "configuration1"

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name --resource-name -n

維護組態名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az maintenance configuration update

更新組態記錄。

az maintenance configuration update [--duration --maintenance-window-duration]
                                    [--expiration-date-time --maintenance-window-expiration-date-time]
                                    [--extension-properties]
                                    [--ids]
                                    [--install-patches-linux-parameters --linux-parameters]
                                    [--install-patches-windows-parameters --windows-parameters]
                                    [--location]
                                    [--maintenance-scope {Extension, Host, InGuestPatch, OSImage, Resource, SQLDB, SQLManagedInstance}]
                                    [--maintenance-window-recur-every --recur-every]
                                    [--maintenance-window-start-date-time --start-date-time]
                                    [--maintenance-window-time-zone --time-zone]
                                    [--name --resource-name]
                                    [--namespace]
                                    [--reboot-setting {Always, IfRequired, Never}]
                                    [--resource-group]
                                    [--subscription]
                                    [--tags]
                                    [--visibility {Custom, Public}]

範例

MaintenanceConfigurations_UpdateForResource

az maintenance configuration update --location "westus2" --maintenance-scope "OSImage" --maintenance-window-duration "05:00" --maintenance-window-expiration-date-time "9999-12-31 00:00" --maintenance-window-recur-every "Month Third Sunday" --maintenance-window-start-date-time "2020-04-30 08:00" --maintenance-window-time-zone "Pacific Standard Time" --namespace "Microsoft.Maintenance" --visibility "Custom" --resource-group "examplerg" --resource-name "configuration1"

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--duration --maintenance-window-duration

HH：mm 格式的維護期間。 如果未提供，則會根據提供的維護範圍使用預設值。 範例：05：00。

屬性	值
參數群組:	MaintenanceWindow Arguments

--expiration-date-time --maintenance-window-expiration-date-time

YYYY-MM-DD hh：mm 格式之維護時段的有效到期日。 視窗將會在提供的時區中建立，並根據該時區調整為日光節約。 到期日必須設定為未來的日期。 如果未提供，則會將它設定為日期時間上限 9999-12-31 23：59：59。

屬性	值
參數群組:	MaintenanceWindow Arguments

--extension-properties

取得或設定 maintenanceConfiguration 支援速記語法、json-file 和 yaml-file 的 extensionProperties。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--install-patches-linux-parameters --linux-parameters

修補 Linux 計算機特有的輸入參數。 若為 Windows 計算機，請勿傳遞此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	InstallPatches Arguments

--install-patches-windows-parameters --windows-parameters

修補 Windows 電腦的特定輸入參數。 針對Linux機器，請勿傳遞此屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	InstallPatches Arguments

--location -l

取得或設定資源的位置。

屬性	值
參數群組:	Configuration Arguments

--maintenance-scope

取得或設定組態的 maintenanceScope。

屬性	值
參數群組:	Properties Arguments
接受的值:	Extension, Host, InGuestPatch, OSImage, Resource, SQLDB, SQLManagedInstance

--maintenance-window-recur-every --recur-every

維護期間預期會遞迴的速率。 速率可以表示為每日、每周或每月排程。 每日排程會格式化為 recurEvery： [Frequency as integer]['Day（s）']。 如果未提供任何頻率，則默認頻率為1。 每日排程範例為 recurEvery：Day、recurEvery：3Days。 每周排程的格式為 recurEvery： [Frequency as integer]['Week（s）'] [週一-星期日的選擇性逗號分隔列表]。 每周排程範例為 recurEvery：3Weeks、recurEvery：Week Saturday、Sunday。 每月排程的格式為 [Frequency as integer]['Month（s）'] [以逗號分隔的月份天數列表] 或 [Frequency as integer]['Month（s）] [Month of Month （First， Second， Third， Fourth， Last）] [Weekday Monday-Sunday] [Optional Offset（No. of days）]。 位移值必須介於 -6 到 6 之間。 每月排程範例為 recurEvery：Month、recurEvery：2Months、recurEvery：Month day23，day24、recurEvery：Month Last Sunday、recurEvery：Month Fourth Monday、recurEvery：Month Last Sunday Offset-3、recurEvery：Month Third Sunday Offset6。

屬性	值
參數群組:	MaintenanceWindow Arguments

--maintenance-window-start-date-time --start-date-time

YYYY-MM-DD hh：mm 格式之維護期間的有效開始日期。 開始日期可以設定為目前的日期或未來的日期。 視窗將會在提供的時區中建立，並根據該時區調整為日光節約。

屬性	值
參數群組:	MaintenanceWindow Arguments

--maintenance-window-time-zone --time-zone

時區的名稱。 您可以在 PowerShell 中執行 [System.TimeZoneInfo]：：GetSystemTimeZones（） 來取得時區清單。 範例：太平洋標準時間、UTC、W. 歐洲標準時間、韓國標準時間、Cen。 澳大利亞標準時間。

屬性	值
參數群組:	MaintenanceWindow Arguments

--name --resource-name -n

維護組態名稱。

屬性	值
參數群組:	Resource Id Arguments

--namespace

取得或設定資源的命名空間。

屬性	值
參數群組:	Properties Arguments

--reboot-setting

根據使用者所定義的可能重新啟動喜好設定，決定在修補作業完成之後，將機器重新啟動。

屬性	值
參數群組:	InstallPatches Arguments
接受的值:	Always, IfRequired, Never

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--tags

取得或設定資源支援速記語法、json-file 和 yaml-file 的標記。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Configuration Arguments

--visibility

取得或設定組態的可見性。 默認值為 『Custom』。

屬性	值
參數群組:	Properties Arguments
接受的值:	Custom, Public

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False