az networkcloud virtualmachine

Note

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

管理虛擬機。

命令

名稱	Description	類型	狀態
az networkcloud virtualmachine assign-relay	將轉送指派給與所提供虛擬機器相關聯的指定 Microsoft.HybridCompute 機器。	Extension	Preview
az networkcloud virtualmachine console	管理虛擬機的控制台。	Extension	GA
az networkcloud virtualmachine console create	建立新的虛擬機主控台，或更新現有虛擬機主控台的屬性。	Extension	Preview
az networkcloud virtualmachine console delete	刪除提供的虛擬機控制台。	Extension	Preview
az networkcloud virtualmachine console list	列出虛擬機的控制台。	Extension	Preview
az networkcloud virtualmachine console show	取得所提供虛擬機控制台的屬性。	Extension	Preview
az networkcloud virtualmachine console update	更新所提供虛擬機控制台的屬性，或更新與虛擬機控制台相關聯的標記。 屬性和標籤更新可以獨立完成。	Extension	Preview
az networkcloud virtualmachine console wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA
az networkcloud virtualmachine create	建立新的虛擬機，或更新現有虛擬機的屬性。	Extension	Preview
az networkcloud virtualmachine delete	刪除提供的虛擬機。	Extension	Preview
az networkcloud virtualmachine list	列出所提供資源群組或訂用帳戶中的虛擬機。	Extension	Preview
az networkcloud virtualmachine power-off	關閉提供的虛擬機電源。	Extension	Preview
az networkcloud virtualmachine reimage	重新建立所提供虛擬機的映像。	Extension	Preview
az networkcloud virtualmachine restart	重新啟動提供的虛擬機。	Extension	Preview
az networkcloud virtualmachine show	取得所提供虛擬機的屬性。	Extension	Preview
az networkcloud virtualmachine start	啟動提供的虛擬機。	Extension	Preview
az networkcloud virtualmachine update	更新所提供虛擬機的屬性，或更新與虛擬機相關聯的標記。 屬性和標籤更新可以獨立完成。	Extension	Preview
az networkcloud virtualmachine wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az networkcloud virtualmachine assign-relay

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將轉送指派給與所提供虛擬機器相關聯的指定 Microsoft.HybridCompute 機器。

az networkcloud virtualmachine assign-relay [--ids]
                                            [--machine-id]
                                            [--name --virtual-machine-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--relay-type {Platform, Public}]
                                            [--resource-group]
                                            [--subscription]

範例

將轉送指派給虛擬機器的 Microsoft.HybridCompute 機器

az networkcloud virtualmachine assign-relay --resource-group "resourceGroupName" --name "virtualMachineName" --machine-id "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.HybridCompute/machines/machineName" --relay-type "Platform"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--machine-id

Microsoft.HybridCompute 機器資源的 resourceId，以指派轉送使用量。

屬性	值
參數群組:	VirtualMachineAssignRelayParameters Arguments

--name --virtual-machine-name -n

虛擬機器的名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

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

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

--relay-type

應分配機器使用的繼電器類型的指示器。 平台 表示使用平台專用轉遞。 Public 表示使用 Arc 服務的標準公用轉送。

屬性	值
參數群組:	VirtualMachineAssignRelayParameters Arguments
預設值:	Platform
接受的值:	Platform, Public

--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 networkcloud virtualmachine create

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立新的虛擬機，或更新現有虛擬機的屬性。

az networkcloud virtualmachine create --admin-username
                                      --cloud-services-network-attachment --csn
                                      --cpu-cores
                                      --extended-location
                                      --memory-size --memory-size-gb --memory-size-gib
                                      --name --virtual-machine-name
                                      --resource-group
                                      --storage-profile
                                      --vm-image
                                      [--boot-method {BIOS, UEFI}]
                                      [--ce-location --console-extended-location]
                                      [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--if-match]
                                      [--if-none-match]
                                      [--location]
                                      [--mi-system-assigned --system-assigned]
                                      [--mi-user-assigned --user-assigned]
                                      [--na --network-attachments]
                                      [--nd --network-data]
                                      [--ndc --network-data-content]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ph --placement-hints]
                                      [--ssh-dest-key-path]
                                      [--ssh-key-values]
                                      [--tags]
                                      [--ud --user-data]
                                      [--udc --user-data-content]
                                      [--vm-device-model {T1, T2, T3}]
                                      [--vm-image-repository-credentials --vmi-creds]

範例

建立虛擬機

az networkcloud virtualmachine create --resource-group "resourceGroupName" --name "virtualMachineName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --admin-username "admin" --boot-method "UEFI" --cloud-services-network-attachment attached-network-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/CloudServicesNetworks/cloudServicesNetworkName" --cpu-cores 2 --memory-size 8 --network-attachments "[{attachedNetworkId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName',defaultGateway:'True',ipAllocationMethod:'Dynamic',ipv4Address:'198.51.100.1',ipv6Address:'2001:0db8:0000:0000:0000:0000:0000:0000',networkAttachmentName:'networkAttachmentName'}]" --network-data-content "bmV0d29ya0RhdGVTYW1wbGU=" --placement-hints "[{hintType:'Affinity',resourceId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName',schedulingExecution:'Hard,scope:''}]" --ssh-key-values "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT= admin@vm" --storage-profile disk-size=120 create-option="Ephemeral" delete-option="Delete" --tags key1="myvalues1" --tags key2="myvalues2" --user-data-content "dXNlckRhdGVTYW1wbGU=" --vm-device-model "T2" --vm-image "myacr.azurecr.io/ubuntu-pw:20.04" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="username"

必要參數

--admin-username

將 SSH 公鑰新增至授權金鑰的系統管理員名稱。

屬性	值
參數群組:	Authentication Arguments

--cloud-services-network-attachment --csn

提供虛擬機平臺層級服務的雲端服務網路。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--cpu-cores

虛擬機中的 CPU 核心數目。

屬性	值
參數群組:	Properties Arguments

--extended-location

與資源相關聯的叢集擴充位置。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	VirtualMachineParameters Arguments

--memory-size --memory-size-gb --memory-size-gib

以 gibibytes 為單位的虛擬機記憶體大小。

屬性	值
參數群組:	Properties Arguments

--name --virtual-machine-name -n

虛擬機器的名稱。

--resource-group -g

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

--storage-profile

記憶體配置檔，指定與虛擬機相關磁碟的大小和其他參數。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--vm-image

目前布建至 OS 磁碟的虛擬機映射，使用用來提取映射的完整 URL 和標記表示法。

屬性	值
參數群組:	Properties Arguments

選擇性參數

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

--boot-method

選取虛擬機的開機方法。

屬性	值
參數群組:	Properties Arguments
預設值:	UEFI
接受的值:	BIOS, UEFI

--ce-location --console-extended-location

用來建立 VM 控制台資源的擴充位置。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--generate-ssh-keys

如果遺失，請產生 SSH 公開和私鑰檔案。 密鑰會儲存在 '~/.ssh' 底下。

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

--if-match

轉換的ETag。 請省略此值以一律覆寫目前的資源。 指定最後看到的 ETag 值，以防止意外覆寫並行變更。

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--location -l

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

屬性	值
參數群組:	VirtualMachineParameters Arguments

--mi-system-assigned --system-assigned

設定系統受控識別。

屬性	值
參數群組:	Identity Arguments

--mi-user-assigned --user-assigned

設定使用者受控識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Identity Arguments

--na --network-attachments

虛擬機的網路附件清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--nd --network-data

欄位已棄用：Base64 編碼的 cloud-init 網路資料。 networkDataContent 屬性將優先使用此屬性。

屬性	值
參數群組:	Properties Arguments

--ndc --network-data-content

Base64 編碼的 cloud-init 網路數據。

屬性	值
參數群組:	Properties Arguments

--no-wait

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

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

--ph --placement-hints

虛擬機的排程提示。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--ssh-dest-key-path

ssh 公鑰的空間分隔路徑清單。 您可以提供檔案路徑或目錄。 如果提供目錄，將會嘗試載入找到的所有公鑰（.pub）。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Authentication Arguments

--ssh-key-values

以空格分隔的 SSH 公鑰清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Authentication Arguments

--tags

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

屬性	值
參數群組:	VirtualMachineParameters Arguments

--ud --user-data

欄位已棄用：Base64 編碼的 cloud-init 使用者資料。 userDataContent 屬性將優先使用此屬性。

屬性	值
參數群組:	Properties Arguments

--udc --user-data-content

Base64 編碼的 cloud-init 用戶數據。

屬性	值
參數群組:	Properties Arguments

--vm-device-model

要使用的裝置型號類型。

屬性	值
參數群組:	Properties Arguments
預設值:	T2
接受的值:	T1, T2, T3

--vm-image-repository-credentials --vmi-creds

用來登入可存取指定映像之映像存放庫的認證。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	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 networkcloud virtualmachine delete

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除提供的虛擬機。

az networkcloud virtualmachine delete [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--name --virtual-machine-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

範例

刪除虛擬機

az networkcloud virtualmachine delete --resource-group "resourceGroupName" --name "virtualMachineName"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--if-match

轉換的ETag。 請省略此值以一律覆寫目前的資源。 指定最後看到的 ETag 值，以防止意外覆寫並行變更。

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--name --virtual-machine-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 networkcloud virtualmachine list

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出所提供資源群組或訂用帳戶中的虛擬機。

az networkcloud virtualmachine list [--max-items]
                                    [--next-token]
                                    [--resource-group]
                                    [--skip-token]
                                    [--top]

範例

列出資源群組的虛擬機

az networkcloud virtualmachine list --resource-group "resourceGroupName"

列出訂用帳戶的虛擬機

az networkcloud virtualmachine list

選擇性參數

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

--max-items

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

屬性	值
參數群組:	Pagination Arguments

--next-token

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

屬性	值
參數群組:	Pagination Arguments

--resource-group -g

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

--skip-token

伺服器傳回的不透明記號，以指出要從何處繼續列出資源。 這用於分頁大型結果集。

--top

從作業傳回的資源數目上限。 範例：「$top=10」。

全域參數

--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 networkcloud virtualmachine power-off

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

關閉提供的虛擬機電源。

az networkcloud virtualmachine power-off [--ids]
                                         [--name --virtual-machine-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--skip-shutdown {False, True}]
                                         [--subscription]

範例

關閉虛擬機電源

az networkcloud virtualmachine power-off --resource-group "resourceGroupName" --name "virtualMachineName" --skip-shutdown "True"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name --virtual-machine-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

--skip-shutdown

是否要立即略過正常 OS 關機和關閉虛擬機電源的指標。

屬性	值
參數群組:	VirtualMachinePowerOffParameters Arguments
預設值:	False
接受的值:	False, True

--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 networkcloud virtualmachine reimage

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

重新建立所提供虛擬機的映像。

az networkcloud virtualmachine reimage [--ids]
                                       [--name --virtual-machine-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

範例

重新映像虛擬機

az networkcloud virtualmachine reimage --resource-group "resourceGroupName" --name "virtualMachineName"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name --virtual-machine-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

全域參數

--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 networkcloud virtualmachine restart

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

重新啟動提供的虛擬機。

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

範例

重新啟動虛擬機器

az networkcloud virtualmachine restart --resource-group "resourceGroupName" --name "virtualMachineName"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name --virtual-machine-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

全域參數

--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 networkcloud virtualmachine show

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得所提供虛擬機的屬性。

az networkcloud virtualmachine show [--ids]
                                    [--name --virtual-machine-name]
                                    [--resource-group]
                                    [--subscription]

範例

取得虛擬機器

az networkcloud virtualmachine show --resource-group "resourceGroupName" --name "virtualMachineName"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name --virtual-machine-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 networkcloud virtualmachine start

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

啟動提供的虛擬機。

az networkcloud virtualmachine start [--ids]
                                     [--name --virtual-machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

範例

啟動虛擬機器

az networkcloud virtualmachine start --resource-group "resourceGroupName" --name "virtualMachineName"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name --virtual-machine-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

全域參數

--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 networkcloud virtualmachine update

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新所提供虛擬機的屬性，或更新與虛擬機相關聯的標記。 屬性和標籤更新可以獨立完成。

az networkcloud virtualmachine update [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--mi-system-assigned --system-assigned]
                                      [--mi-user-assigned --user-assigned]
                                      [--name --virtual-machine-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]
                                      [--vm-image-repository-credentials --vmi-creds]

範例

修補虛擬機

az networkcloud virtualmachine update --resource-group "resourceGroupName" --name "virtualMachineName" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="myuser" --tags key1="myvalue1" key2="myvalue2"

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--if-match

轉換的ETag。 請省略此值以一律覆寫目前的資源。 指定最後看到的 ETag 值，以防止意外覆寫並行變更。

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--mi-system-assigned --system-assigned

設定系統受控識別。

屬性	值
參數群組:	Identity Arguments

--mi-user-assigned --user-assigned

設定使用者受控識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Identity Arguments

--name --virtual-machine-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

--tags

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

屬性	值
參數群組:	VirtualMachineUpdateParameters Arguments

--vm-image-repository-credentials --vmi-creds

用來登入可存取指定映像之映像存放庫的認證。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	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 networkcloud virtualmachine wait

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

az networkcloud virtualmachine wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name --virtual-machine-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

選擇性參數

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

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