az vm host

管理 虛擬機器 專用主機。

命令

名稱	Description	類型	狀態
az vm host create	建立專用主機。	核心	GA
az vm host delete	刪除專用主機。	核心	GA
az vm host get-instance-view	取得專用主機的實例資訊。	核心	GA
az vm host group	管理專用主機群組。	核心	GA
az vm host group create	建立專用主機群組。	核心	GA
az vm host group delete	刪除專用主機群組。	核心	GA
az vm host group get-instance-view	取得專用主機群組的實例檢視。	核心	GA
az vm host group list	列出專用主機群組。	核心	GA
az vm host group show	取得專用主機群組的詳細數據。	核心	GA
az vm host group update	更新專用主機群組。	核心	GA
az vm host list	列出專用主機。	核心	GA
az vm host list-resize-options	列出可調整指定專用主機大小的所有可用專用主機大小。 注意：提供的專用主機大小只能用來相應增加現有的專用主機。	核心	GA
az vm host redeploy	重新部署專用主機。	核心	GA
az vm host resize	調整專用主機的大小。	核心	GA
az vm host restart	重新啟動專用主機。	核心	GA
az vm host show	取得專用主機的詳細數據。	核心	GA
az vm host update	更新專用主機。	核心	GA
az vm host wait	將 CLI 置於等候狀態，直到符合條件為止。	核心	GA

az vm host create

建立專用主機。

az vm host create --host-group
                  --name
                  --resource-group
                  --sku
                  [--auto-replace {false, true}]
                  [--license-type {None, Windows_Server_Hybrid, Windows_Server_Perpetual}]
                  [--location]
                  [--platform-fault-domain]
                  [--tags]

範例

建立專用主機。 確定它在失敗時自動取代

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 2 \
    --auto-replace --resource-group my-resource-group --sku DSv3-Type1

在「東亞」區域中建立專用主機。 請勿在失敗時自動取代。

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 0 \
    --auto-replace false --resource-group my-resource-group --sku ESv3-Type1 --location eastasia

建立專用主機 （自動產生）

az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1

必要參數

--host-group

專用主機群組的名稱。

--name -n

專用主機的名稱。

--resource-group -g

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

--sku

專用主機的 SKU。 可用的 SKU： https://azure.microsoft.com/pricing/details/virtual-machines/dedicated-host/。

選擇性參數

--auto-replace

如果發生失敗，請自動取代主機。

接受的值: false, true

--license-type

將套用至部署在專用主機上的 VM 的軟體授權類型。

接受的值: None, Windows_Server_Hybrid, Windows_Server_Perpetual

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。 否則，位置會預設為資源群組的位置。

--platform-fault-domain -d

群組中主機的容錯網域。 允許的值：0、1、2。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host delete

刪除專用主機。

az vm host delete [--host-group]
                  [--host-name]
                  [--ids]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--resource-group]
                  [--subscription]
                  [--yes]

選擇性參數

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--no-wait

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

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

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host get-instance-view

取得專用主機的實例資訊。

az vm host get-instance-view [--host-group]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

範例

取得專用主機的實例檢視資訊。

az vm host get-instance-view --host-group my-host-group --name my-host -g my-rg

取得主機群組中所有專用主機的實例檢視。

az vm host get-instance-view --ids $(az vm host list -g my-rg --host-group my-host-group --query "[].id" -o tsv)

選擇性參數

--host-group

專用主機群組的名稱。

--ids

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

--name -n

專用主機的名稱。

--resource-group -g

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

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host list

列出專用主機。

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

範例

列出專用主機。

az vm host list --host-group MyHostGroup --resource-group MyResourceGroup

必要參數

--host-group --host-group-name

專用主機群組的名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host list-resize-options

列出可調整指定專用主機大小的所有可用專用主機大小。 注意：提供的專用主機大小只能用來相應增加現有的專用主機。

az vm host list-resize-options [--host-group]
                               [--host-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

範例

列出可調整指定專用主機大小的所有可用專用主機大小。

az vm host list-resize-options --host-group MyHostGroup --name MyHost --resource-group MyResourceGroup

選擇性參數

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host redeploy

重新部署專用主機。

一旦專用主機移轉至新的節點且正在執行，作業就會順利完成。 在重新部署之後，判斷部署在專用主機上的 VM 健康情況，請檢查 Azure 入口網站中的 資源健康狀態 中心。 如需詳細資訊， https://docs.microsoft.com/azure/service-health/resource-health-overview 請參閱 。

az vm host redeploy [--host-group]
                    [--host-name]
                    [--ids]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--resource-group]
                    [--subscription]

選擇性參數

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--no-wait

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

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

--resource-group -g

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

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host resize

調整專用主機的大小。

az vm host resize [--host-group]
                  [--host-name]
                  [--ids]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--resource-group]
                  [--sku]
                  [--subscription]

範例

調整專用主機的大小。

az vm host resize --host-group MyHostGroup --name MyHost --resource-group MyResourceGroup --sku-name DSv3-Type1

選擇性參數

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--no-wait

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

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

--resource-group -g

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

--sku

重設大小的專用主機大小。 執行 'az vm host list-resize-options'，可以列出重設大小可用的專用主機大小。

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host restart

重新啟動專用主機。

一旦專用主機重新啟動且正在執行，作業就會順利完成。 若要在重新啟動后判斷部署在專用主機上的 VM 健康情況，請檢查 Azure 入口網站中的 資源健康狀態 中心。 如需詳細資訊， https://docs.microsoft.com/azure/service-health/resource-health-overview 請參閱 。

az vm host restart [--host-group]
                   [--host-name]
                   [--ids]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]

選擇性參數

--host-group --host-group-name

專用主機群組的名稱。

--host-name

專用主機的名稱。

--ids

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

--no-wait

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

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

--resource-group -g

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

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host show

取得專用主機的詳細數據。

az vm host show [--expand {instanceView, userData}]
                [--host-group]
                [--host-name]
                [--ids]
                [--resource-group]
                [--subscription]

範例

取得專用主機的詳細數據。

az vm host show --host-group MyHostGroup --name MyDedicatedHost --resource-group MyResourceGroup

選擇性參數

--expand

要套用至作業的展開表達式。 'InstanceView' 會擷取專用主機的實例檢視清單。 專用主機不支援 『UserData』。

接受的值: instanceView, userData

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host update

更新專用主機。

az vm host update [--add]
                  [--force-string]
                  [--host-group]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]

範例

更新專用主機的 [autoReplaceOnFailure] 字段。

az vm host update --host-group my-host-group --name my-host \
    --resource-group my-resource-group --set autoReplaceOnFailure=True

選擇性參數

--add

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

預設值: []

--force-string

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

預設值: False

--host-group

專用主機群組的名稱。

--ids

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

--name -n

專用主機的名稱。

--remove

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

預設值: []

--resource-group -g

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

--set

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

預設值: []

--subscription

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az vm host wait

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

az vm host wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--expand {instanceView, userData}]
                [--host-group]
                [--host-name]
                [--ids]
                [--interval]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--expand

要套用至作業的展開表達式。 'InstanceView' 會擷取專用主機的實例檢視清單。 專用主機不支援 『UserData』。

接受的值: instanceView, userData

--host-group --host-group-name

專用主機群組的名稱。

--host-name --name -n

專用主機的名稱。

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。