az standby-vm-pool

Note

此參考是Azure CLIstandbypool擴充套件（版本2.75.0或更高版本）的一部分。 擴充功能會在您第一次執行 az standby-vm-pool 命令時自動安裝。 深入了解擴充功能。

管理待命虛擬機集區。

命令

名稱	Description	類型	狀態
az standby-vm-pool create	建立 StandbyVirtualMachinePoolResource。	Extension	GA
az standby-vm-pool delete	刪除 StandbyVirtualMachinePoolResource。	Extension	GA
az standby-vm-pool list	依訂閱 ID 列出 StandbyVirtualMachinePoolResource 資源。	Extension	GA
az standby-vm-pool show	取得 StandbyVirtualMachinePoolResource。	Extension	GA
az standby-vm-pool status	取得 StandbyVirtualMachinePoolRuntimeViewResource。	Extension	GA
az standby-vm-pool update	更新 StandbyVirtualMachinePoolResource。	Extension	GA
az standby-vm-pool wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az standby-vm-pool create

建立 StandbyVirtualMachinePoolResource。

az standby-vm-pool create --name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--dynamic-sizing-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--max-ready-capacity]
                          [--min-ready-capacity]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--post-provisioning-delay --provision-delay]
                          [--tags]
                          [--vm-state {Deallocated, Hibernated, Running}]
                          [--vmss-id]

範例

StandbyVirtualMachinePools_CreateOrUpdate

az standby-vm-pool create --resource-group rgstandbypool --name pool --max-ready-capacity 304 --min-ready-capacity 300 --post-provisioning-delay PT2S --dynamic-sizing-enabled True --vm-state Running --vmss-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss --tags "{}" --location West US

必要參數

--name -n

待命虛擬機集區的名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--dynamic-sizing-enabled

指出是否已啟用待命集區的動態大小調整。

屬性	值
參數群組:	DynamicSizing Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

屬性	值
參數群組:	Resource Arguments

--max-ready-capacity

指定待命虛擬機集區中的虛擬機數目上限。

屬性	值
參數群組:	ElasticityProfile Arguments

--min-ready-capacity

指定待命虛擬機集區中所需的虛擬機數目下限。 MinReadyCapacity 不能超過 MaxReadyCapacity。

屬性	值
參數群組:	ElasticityProfile Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--post-provisioning-delay --provision-delay

指定在虛擬機器佈建之後，虛擬機器可供使用之前等待的持續時間。 持續時間應以 ISO 8601 格式指定（例如，PT2S 2 秒）。

屬性	值
參數群組:	ElasticityProfile Arguments

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Resource Arguments

--vm-state

指定集區中虛擬機的所需狀態。

屬性	值
參數群組:	Properties Arguments
接受的值:	Deallocated, Hibernated, Running

--vmss-id

指定集區所連結之虛擬機擴展集的完整資源識別碼。

屬性	值
參數群組:	Properties Arguments

全域參數

--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 standby-vm-pool delete

刪除 StandbyVirtualMachinePoolResource。

az standby-vm-pool delete [--acquire-policy-token]
                          [--change-reference]
                          [--ids]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

範例

StandbyVirtualMachinePools_Delete

az standby-vm-pool delete --resource-group rgstandbypool --name pool

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

待命虛擬機集區的名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--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 standby-vm-pool list

依訂閱 ID 列出 StandbyVirtualMachinePoolResource 資源。

az standby-vm-pool list [--max-items]
                        [--next-token]
                        [--resource-group]

範例

StandbyVirtualMachinePools_ListBySubscription

az standby-vm-pool list

選擇性參數

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

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性	值
參數群組:	Pagination Arguments

--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性	值
參數群組:	Pagination Arguments

--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 standby-vm-pool show

取得 StandbyVirtualMachinePoolResource。

az standby-vm-pool show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

範例

StandbyVirtualMachinePools_Get

az standby-vm-pool show --resource-group rgstandbypool --name pool

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--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 standby-vm-pool status

取得 StandbyVirtualMachinePoolRuntimeViewResource。

az standby-vm-pool status [--acquire-policy-token]
                          [--change-reference]
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--version]

範例

StandbyVirtualMachinePoolRuntimeViews_Get

az standby-vm-pool status --resource-group rgstandbypool --name pool --version latest

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

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

--version

運行時間檢視的唯一標識碼。 輸入字串應該是 『latest』 這個字，它會取得集區的最新運行時間檢視，否則要求將會失敗，而不會發生 NotFound 例外狀況。

屬性	值
參數群組:	Resource Id Arguments
預設值:	latest

全域參數

--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 standby-vm-pool update

更新 StandbyVirtualMachinePoolResource。

az standby-vm-pool update [--acquire-policy-token]
                          [--add]
                          [--change-reference]
                          [--dynamic-sizing-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--max-ready-capacity]
                          [--min-ready-capacity]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--post-provisioning-delay --provision-delay]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]
                          [--tags]
                          [--vm-state {Deallocated, Hibernated, Running}]
                          [--vmss-id]

範例

StandbyVirtualMachinePools_CreateOrUpdate

az standby-vm-pool update --resource-group rgstandbypool --name pool --max-ready-capacity 304 --min-ready-capacity 300 --post-provisioning-delay PT2S --dynamic-sizing-enabled True --vm-state Running --vmss-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss --tags "{}"

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

屬性	值
參數群組:	Generic Update Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--dynamic-sizing-enabled

指出是否已啟用待命集區的動態大小調整。

屬性	值
參數群組:	DynamicSizing Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--max-ready-capacity

指定待命虛擬機集區中的虛擬機數目上限。

屬性	值
參數群組:	ElasticityProfile Arguments

--min-ready-capacity

指定待命虛擬機集區中所需的虛擬機數目下限。 MinReadyCapacity 不能超過 MaxReadyCapacity。

屬性	值
參數群組:	ElasticityProfile Arguments

--name -n

待命虛擬機集區的名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--post-provisioning-delay --provision-delay

指定在虛擬機器佈建之後，虛擬機器可供使用之前等待的持續時間。 持續時間應以 ISO 8601 格式指定（例如，PT2S 2 秒）。

屬性	值
參數群組:	ElasticityProfile Arguments

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

屬性	值
參數群組:	Generic Update Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Resource Arguments

--vm-state

指定集區中虛擬機的所需狀態。

屬性	值
參數群組:	Properties Arguments
接受的值:	Deallocated, Hibernated, Running

--vmss-id

指定集區所連結之虛擬機擴展集的完整資源識別碼。

屬性	值
參數群組:	Properties 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 standby-vm-pool wait

將 CLI 置於等候狀態，直到符合條件為止。

az standby-vm-pool wait [--acquire-policy-token]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

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

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	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