az stack-hci-vm
注意
此參考是 Azure CLI 的 stack-hci-vm 擴充功能的一部分(2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az stack-hci-vm 命令時自動安裝。 深入了解擴充功能。
使用 stack-hci-vm 管理 virtualmachine。
命令
az stack-hci-vm create
建立 VM。
az stack-hci-vm create --custom-location
--name
--resource-group
[--admin-password]
[--admin-username]
[--attach-data-disks]
[--authentication-type {all, password, ssh}]
[--computer-name]
[--enable-agent {false, true}]
[--enable-secure-boot {false, true}]
[--enable-vm-config-agent {false, true}]
[--enable-vtpm {false, true}]
[--image]
[--location]
[--nics]
[--os-disk-name]
[--os-type {linux, windows}]
[--polling-interval]
[--proxy-configuration]
[--security-type {ConfidentialVM, TrustedLaunch}]
[--size]
[--ssh-dest-key-path]
[--ssh-key-values]
[--storage-path-id]
[--tags]
範例
建立 Stack HCI VM
az stack-hci-vm create --resource-group "test-rg" --custom-location "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocatio n/customLocations/dogfood-location" --location "West US2" --size "Default" --nics "test-nic" --computer-name "test-machine" --admin-username xxx --admin-password xxx --image "test-gallery-image" --storage-path-id "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storagecontainers/test-storagepath" --name "test-vm" --authentication-type all --enable-agent true --ssh-key-values @key-file
必要參數
擴充位置的標識碼。
虛擬機的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
如果驗證類型為 「密碼」,則 VM 的密碼。
VM 的用戶名稱。
將現有的數據磁碟連結至 VM。 可以使用受控磁碟的名稱或標識碼。
要與 VM 搭配使用的驗證類型。 預設為 Windows 和 Linux 的 SSH 公鑰密碼。 “all” 同時啟用 ssh 和密碼驗證。
計算機的名稱。
指出虛擬機器代理程式是否應該佈建在虛擬機上。 未指定此屬性時,預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上,以便稍後將擴充功能新增至 VM。
啟用安全開機。
指出虛擬機組態代理程式是否應在虛擬機上佈建。 未指定此屬性時,預設行為是將它設定為 true。
啟用 vtpm - 在 VM 的安全性設定中啟用 vTPM。 如果未提供旗標,預設值為 False。
使用量:--enable-vtpm=XX。
映射 - VM 應該用來布建的映射庫映像名稱。
如果未指定location,則會使用資源群組的位置。
要連結至 VM 之現有 NIC 的名稱或識別碼。
Os 磁碟 - VM 應該用來布建的 vhd 名稱。
安裝在自定義 VHD 上的 OS 類型。 指定 URN 或 URN 別名時請勿使用。
長時間執行作業的ARM輪詢間隔。
ProxyConfiguration - 描述虛擬機的 Proxy 設定。
指定虛擬機的安全性類型。
要建立的 VM 大小。
SSH 金鑰 VM 上的目的地檔案路徑。
SSH 公鑰或公鑰檔案路徑的空間分隔清單。
指向 VM 組態檔儲存位置之記憶體路徑的 Azure 識別碼。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm delete
刪除 VM。
az stack-hci-vm delete [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
[--yes]
範例
DeleteVirtualMachine
az stack-hci-vm delete --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm list
列出所有 VM。
az stack-hci-vm list [--resource-group]
範例
ListVirtualMachineByResourceGroup
az stack-hci-vm list --resource-group "test-rg"
ListVirtualMachineBySubscription
az stack-hci-vm list
選擇性參數
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm pause
暫停 VM。
az stack-hci-vm pause [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
範例
PauseVirtualMachine
az stack-hci-vm pause --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm restart
重新啟動 VM。
az stack-hci-vm restart [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
範例
RestartVirtualMachine
az stack-hci-vm restart --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm save
儲存 VM。
az stack-hci-vm save [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
範例
SaveVirtualMachine
az stack-hci-vm save --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm show
取得 VM 的詳細數據。
az stack-hci-vm show [--ids]
[--name]
[--resource-group]
[--subscription]
範例
GetVirtualMachine
az stack-hci-vm show --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm start
啟動已停止的 VM。
az stack-hci-vm start [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
範例
StartVirtualMachine
az stack-hci-vm start --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm stop
關閉 (停止) 執行中的 VM。
az stack-hci-vm stop [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
範例
StopVirtualMachine
az stack-hci-vm stop --resource-group "test-rg" --name "test-vm"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的名稱。
長時間執行作業的ARM輪詢間隔。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stack-hci-vm update
更新 VM。
az stack-hci-vm update [--add]
[--computer-name]
[--enable-agent {false, true}]
[--enable-vm-config-agent {false, true}]
[--force-string]
[--ids]
[--memory-mb]
[--name]
[--nics]
[--polling-interval]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--v-cpus-available]
[--vhds]
範例
UpdateVirtualMachine
az stack-hci-vm update --resource-group "test-rg" --tags additionalProperties="sample" --name "test-vm" --v-cpus-available XX --memory-mb XX
選擇性參數
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例:--add property.listProperty <key=value, string or JSON string>
。
更新 VM 的主機名。
指出虛擬機更新期間是否應在虛擬機上佈建虛擬機代理程式。 這可確保 VM 代理程式已安裝在 VM 上,以便稍後將擴充功能新增至 VM。
指出虛擬機設定代理程式是否應在虛擬機更新期間佈建在虛擬機上。
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
虛擬機的 RAM 以 mb 為單位。
虛擬機的名稱。
vnic 名稱的清單。
長時間執行作業的ARM輪詢間隔。
從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>
或 --remove propertyToRemove
。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
指定要設定的屬性路徑和值,以更新物件。 範例:--set property1.property2=<value>
。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
指定可用的 vCPU 數目。
虛擬硬碟名稱的清單。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。