Virtual Machines - Attach Detach Data Disks
將數據磁碟連結至虛擬機或從虛擬機中斷連結。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks?api-version=2024-03-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
vm
|
path | True |
string |
虛擬機器的名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
parameters |
提供給虛擬機上連結和卸離數據磁碟作業的參數。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
202 Accepted |
已接受 標題 Location: string |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Virtual |
Virtual |
VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen
範例要求
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/attachDetachDataDisks?api-version=2024-03-01
{
"dataDisksToAttach": [
{
"lun": 1,
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"diskEncryptionSet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
},
"caching": "ReadOnly",
"deleteOption": "Delete",
"writeAcceleratorEnabled": true
},
{
"lun": 2,
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
"diskEncryptionSet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
},
"caching": "ReadWrite",
"deleteOption": "Detach",
"writeAcceleratorEnabled": false
}
],
"dataDisksToDetach": [
{
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
"detachOption": "ForceDetach"
},
{
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
"detachOption": "ForceDetach"
}
]
}
範例回覆
location: https://foo.com/operationstatus
{
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-Datacenter",
"version": "latest"
},
"osDisk": {
"osType": "Windows",
"name": "myOsDisk",
"createOption": "FromImage",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Premium_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
},
"diskSizeGB": 30
},
"dataDisks": [
{
"lun": 1,
"name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"createOption": "Attach",
"caching": "ReadOnly",
"managedDisk": {
"storageAccountType": "Premium_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"diskEncryptionSet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
}
},
"deleteOption": "Delete",
"diskSizeGB": 30,
"writeAcceleratorEnabled": true
},
{
"lun": 2,
"name": "vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
"createOption": "Attach",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Premium_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
"diskEncryptionSet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
}
},
"deleteOption": "Detach",
"diskSizeGB": 100,
"writeAcceleratorEnabled": false
}
]
}
location: https://foo.com/operationstatus
VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen
範例要求
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/azure-vm/attachDetachDataDisks?api-version=2024-03-01
{
"dataDisksToAttach": [
{
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
}
],
"dataDisksToDetach": [
{
"diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"
}
]
}
範例回覆
location: https://foo.com/operationstatus
{
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-Datacenter",
"version": "latest"
},
"osDisk": {
"osType": "Windows",
"name": "myOsDisk",
"createOption": "FromImage",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Premium_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
},
"diskSizeGB": 30
},
"dataDisks": [
{
"lun": 0,
"name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
"createOption": "Attach",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Premium_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
},
"diskSizeGB": 30
}
]
}
location: https://foo.com/operationstatus
定義
名稱 | Description |
---|---|
Api |
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。 |
Api |
API 錯誤。 |
Api |
API 錯誤基底。 |
Attach |
提供給虛擬機上連結和卸離數據磁碟作業的參數。 |
Caching |
指定快取需求。 可能的值為: None、ReadOnly、ReadWrite。 默認行為為: 標準記憶體的 None。進階記憶體的 ReadOnly。 |
Cloud |
來自計算服務的錯誤回應。 |
Data |
指定用來將資料磁碟加入至虛擬機器的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。 |
Data |
要連結的受控數據磁碟清單。 |
Data |
要卸離的受控數據磁碟清單。 |
Diff |
指定作業系統磁碟的暫時磁碟設定。 |
Diff |
指定作業系統磁碟的暫時磁碟位置。 可能的值為: CacheDisk、ResourceDisk、NvmeDisk。 默認行為為:如果已針對 VM 大小設定快取 Disk ,否則會使用 ResourceDisk 或 NvmeDisk 。 請參閱 上的 https://docs.microsoft.com/azure/virtual-machines/windows/sizes Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。 |
Diff |
指定虛擬機所使用作業系統磁碟的暫時磁碟設定。 |
Disk |
指定為 VM 設定的磁碟控制器類型。 注意: 如果未指定,則會使用 『hyperVGeneration』 設定為 V2,根據指定之最低 API 版本之作業系統磁碟和 VM 大小的功能,將此屬性設定為預設磁碟控制器類型。 除非您更新 VM 組態中的 VM 大小,以隱含地解除分配和重新配置 VM,否則您必須在更新其磁碟控制器類型之前解除分配 VM。 API 版本下限:2022-08-01。 |
Disk |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映像來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用 Marketplace 映射,則也應該使用先前所述的方案元素。 |
Disk |
指定在 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為: Delete。 如果使用此值,則會在刪除 VM 時刪除 OS 磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留 os 磁碟。 默認值設定為 [卸離]。 若為暫時OS磁碟,預設值會設定為 Delete。 使用者無法變更暫時 OS 磁碟的刪除選項。 |
Disk |
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用。 支援的值: ForceDetach。 detachOption: ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁碟斷連結嘗試因為虛擬機發生非預期的失敗而未完成,但磁碟仍然未釋放,請使用強制中斷連結作為最後一個從 VM 中斷連結磁碟的最後一個選項。 使用此卸離行為時,可能不會排清所有寫入。 此功能仍處於預覽 模式,且 VirtualMachineScaleSet 不支援此功能。 若要強制中斷數據磁碟更新至BeDetached 為 『true』,以及設定 detachOption: 'ForceDetach'。 |
Disk |
指定受控磁碟的客戶受控磁碟加密集資源標識符。 |
Disk |
指定 OS 磁碟的加密設定。 API 版本下限:2015-06-15。 |
Image |
指定要使用之映像的相關信息。 您可以指定平臺映像、Marketplace 映像或虛擬機映射的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。 |
Inner |
內部錯誤詳細數據。 |
Key |
指定 金鑰保存庫 中金鑰加密金鑰的位置。 |
Key |
指定磁碟加密金鑰的位置,這是 金鑰保存庫 秘密。 |
Managed |
受控磁碟參數。 |
Operating |
操作系統類型。 |
OSDisk |
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。 |
security |
指定受控磁碟的 EncryptionType。 它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly 只加密 VMGuestState Blob,以及 NonPersistedTPM 表示未在 VMGuestState Blob 中保存韌體狀態。 注意: 它只能設定為機密 VM。 |
Storage |
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。 |
Storage |
指定虛擬機器磁碟的儲存體設定。 |
Sub |
|
Virtual |
虛擬硬碟。 |
VMDisk |
指定受控磁碟的安全性配置檔。 |
ApiEntityReference
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。
名稱 | 類型 | Description |
---|---|---|
id |
string |
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 形式的 ARM 資源標識符 |
ApiError
API 錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
API 錯誤詳細數據 |
|
innererror |
Api 內部錯誤 |
|
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApiErrorBase
API 錯誤基底。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
AttachDetachDataDisksRequest
提供給虛擬機上連結和卸離數據磁碟作業的參數。
名稱 | 類型 | Description |
---|---|---|
dataDisksToAttach |
要連結的受控數據磁碟清單。 |
|
dataDisksToDetach |
要卸離的受控數據磁碟清單。 |
CachingTypes
指定快取需求。 可能的值為: None、ReadOnly、ReadWrite。 默認行為為: 標準記憶體的 None。進階記憶體的 ReadOnly。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
CloudError
來自計算服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
API 錯誤。 |
DataDisk
指定用來將資料磁碟加入至虛擬機器的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為: None、ReadOnly、ReadWrite。 默認行為為: 標準記憶體的 None。進階記憶體的 ReadOnly。 |
|
createOption |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映像來建立虛擬機數據磁碟時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用 Marketplace 映射,則也應該使用先前所述的方案元素。 空: 建立空的數據磁碟時會使用這個值。 複製: 這個值是用來從快照集或其他磁碟建立數據磁碟。 恢復: 這個值是用來從磁碟還原點建立數據磁碟。 |
|
deleteOption |
指定在 VM 刪除時應該刪除或中斷連結資料磁碟。 可能的值為: Delete。 如果使用此值,則會在刪除 VM 時刪除資料磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留資料磁碟。 默認值設定為 [卸離]。 |
|
detachOption |
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用。 支援的值: ForceDetach。 detachOption: ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁碟斷連結嘗試因為虛擬機發生非預期的失敗而未完成,但磁碟仍然未釋放,請使用強制中斷連結作為最後一個從 VM 中斷連結磁碟的最後一個選項。 使用此卸離行為時,可能不會排清所有寫入。 此功能仍處於預覽 模式,且 VirtualMachineScaleSet 不支援此功能。 若要強制中斷數據磁碟更新至BeDetached 為 『true』,以及設定 detachOption: 'ForceDetach'。 |
|
diskIOPSReadWrite |
integer |
指定 storageAccountType UltraSSD_LRS時,受控磁碟的 Read-Write IOPS。 僅針對 VirtualMachine ScaleSet VM 磁碟傳回。 只能透過 VirtualMachine 擴展集的更新來更新。 |
diskMBpsReadWrite |
integer |
指定 StorageAccountType UltraSSD_LRS時,受控磁碟的每秒 MB 頻寬。 僅針對 VirtualMachine ScaleSet VM 磁碟傳回。 只能透過 VirtualMachine 擴展集的更新來更新。 |
diskSizeGB |
integer |
指定以 GB 為單位的空白資料磁碟大小。 此元素可用來覆寫虛擬機映像中的磁碟大小。 屬性 'diskSizeGB' 是磁碟的位元組 x 1024^3 數目,且值不能大於 1023。 |
image |
來源使用者映像虛擬硬碟。 虛擬硬碟將會先複製,再連結至虛擬機。 如果提供SourceImage,目的地虛擬硬碟不得存在。 |
|
lun |
integer |
指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟,因此對於連結至 VM 的每個數據磁碟都必須是唯一的。 |
managedDisk |
受控磁碟參數。 |
|
name |
string |
磁碟名稱。 |
sourceResource |
來源資源標識碼。 它可以是建立磁碟的快照集或磁碟還原點。 |
|
toBeDetached |
boolean |
指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結 |
vhd |
虛擬硬碟。 |
|
writeAcceleratorEnabled |
boolean |
指定是否應該在磁碟上啟用或停用 writeAccelerator。 |
DataDisksToAttach
要連結的受控數據磁碟清單。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為: None、ReadOnly、ReadWrite。 默認行為為: 標準記憶體的 None。進階記憶體的 ReadOnly。 |
|
deleteOption |
指定在 VM 刪除時應該刪除或中斷連結資料磁碟。 可能的值為: Delete。 如果使用此值,則會在刪除 VM 時刪除資料磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留資料磁碟。 默認值設定為 [卸離]。 |
|
diskEncryptionSet |
指定受控磁碟的客戶受控磁碟加密集資源標識符。 |
|
diskId |
string |
受控數據磁碟的標識碼。 |
lun |
integer |
數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟,因此對於連結至 VM 的每個數據磁碟都必須是唯一的。 如果未指定,則會自動指派 lun。 |
writeAcceleratorEnabled |
boolean |
指定是否應該在磁碟上啟用或停用 writeAccelerator。 |
DataDisksToDetach
要卸離的受控數據磁碟清單。
名稱 | 類型 | Description |
---|---|---|
detachOption |
支援從 VM 卸離磁碟的選項。 如需詳細資訊,請參閱DetachOption對象參考。 |
|
diskId |
string |
受控數據磁碟的標識碼。 |
DiffDiskOptions
指定作業系統磁碟的暫時磁碟設定。
名稱 | 類型 | Description |
---|---|---|
Local |
string |
DiffDiskPlacement
指定作業系統磁碟的暫時磁碟位置。 可能的值為: CacheDisk、ResourceDisk、NvmeDisk。 默認行為為:如果已針對 VM 大小設定快取 Disk ,否則會使用 ResourceDisk 或 NvmeDisk 。 請參閱 上的 https://docs.microsoft.com/azure/virtual-machines/windows/sizes Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。
名稱 | 類型 | Description |
---|---|---|
CacheDisk |
string |
|
NvmeDisk |
string |
|
ResourceDisk |
string |
DiffDiskSettings
指定虛擬機所使用作業系統磁碟的暫時磁碟設定。
名稱 | 類型 | Description |
---|---|---|
option |
指定作業系統磁碟的暫時磁碟設定。 |
|
placement |
指定作業系統磁碟的暫時磁碟位置。 可能的值為: CacheDisk、ResourceDisk、NvmeDisk。 默認行為為:如果已針對 VM 大小設定快取 Disk ,否則會使用 ResourceDisk 或 NvmeDisk 。 請參閱 上的 https://docs.microsoft.com/azure/virtual-machines/windows/sizes Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes 的 VM 大小檔,以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本:2024-03-01。 |
DiskControllerTypes
指定為 VM 設定的磁碟控制器類型。 注意: 如果未指定,則會使用 『hyperVGeneration』 設定為 V2,根據指定之最低 API 版本之作業系統磁碟和 VM 大小的功能,將此屬性設定為預設磁碟控制器類型。 除非您更新 VM 組態中的 VM 大小,以隱含地解除分配和重新配置 VM,否則您必須在更新其磁碟控制器類型之前解除分配 VM。 API 版本下限:2022-08-01。
名稱 | 類型 | Description |
---|---|---|
NVMe |
string |
|
SCSI |
string |
DiskCreateOptionTypes
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映像來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用 Marketplace 映射,則也應該使用先前所述的方案元素。
名稱 | 類型 | Description |
---|---|---|
Attach |
string |
|
Copy |
string |
|
Empty |
string |
|
FromImage |
string |
|
Restore |
string |
DiskDeleteOptionTypes
指定在 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為: Delete。 如果使用此值,則會在刪除 VM 時刪除 OS 磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留 os 磁碟。 默認值設定為 [卸離]。 若為暫時OS磁碟,預設值會設定為 Delete。 使用者無法變更暫時 OS 磁碟的刪除選項。
名稱 | 類型 | Description |
---|---|---|
Delete |
string |
|
Detach |
string |
DiskDetachOptionTypes
指定卸離磁碟時所要使用的卸離行為,或已在從虛擬機中斷鏈接的過程中使用。 支援的值: ForceDetach。 detachOption: ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁碟斷連結嘗試因為虛擬機發生非預期的失敗而未完成,但磁碟仍然未釋放,請使用強制中斷連結作為最後一個從 VM 中斷連結磁碟的最後一個選項。 使用此卸離行為時,可能不會排清所有寫入。 此功能仍處於預覽 模式,且 VirtualMachineScaleSet 不支援此功能。 若要強制中斷數據磁碟更新至BeDetached 為 『true』,以及設定 detachOption: 'ForceDetach'。
名稱 | 類型 | Description |
---|---|---|
ForceDetach |
string |
DiskEncryptionSetParameters
指定受控磁碟的客戶受控磁碟加密集資源標識符。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
DiskEncryptionSettings
指定 OS 磁碟的加密設定。 API 版本下限:2015-06-15。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionKey |
指定磁碟加密金鑰的位置,這是 金鑰保存庫 秘密。 |
|
enabled |
boolean |
指定是否應在虛擬機上啟用磁碟加密。 |
keyEncryptionKey |
指定 金鑰保存庫 中金鑰加密金鑰的位置。 |
ImageReference
指定要使用之映像的相關信息。 您可以指定平臺映像、Marketplace 映像或虛擬機映射的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。
名稱 | 類型 | Description |
---|---|---|
communityGalleryImageId |
string |
指定 VM 部署的社群資源庫映像唯一標識碼。 這可以從社群資源庫映像 GET 呼叫擷取。 |
exactVersion |
string |
以十進位數指定,也就是用來建立虛擬機的平臺映像或市集映射版本。 這個只讀欄位與 'version' 不同,只有在 'version' 字段中指定的值為 'latest' 時。 |
id |
string |
資源標識碼 |
offer |
string |
指定用來建立虛擬機的平臺映像或市集映像供應專案。 |
publisher |
string |
映像發行者。 |
sharedGalleryImageId |
string |
指定 VM 部署的共享資源庫映像唯一識別碼。 這可以從共用資源庫映像 GET 呼叫擷取。 |
sku |
string |
映像 SKU。 |
version |
string |
指定用來建立虛擬機的平臺映像或 Marketplace 映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建都是十進位數。 指定「最新」以使用部署階段可用的最新映像版本。 即使您使用「最新」,即使有新版本可供使用,VM 映像也不會在部署時間之後自動更新。 請勿針對資源庫映射部署使用字段 'version',資源庫映射應該一律使用 'id' 字段進行部署,若要使用資源庫映射的 'latest' 版本,只要設定 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}',就不需要輸入版本。 |
InnerError
內部錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
errordetail |
string |
內部錯誤訊息或例外狀況傾印。 |
exceptiontype |
string |
例外狀況型別。 |
KeyVaultKeyReference
指定 金鑰保存庫 中金鑰加密金鑰的位置。
名稱 | 類型 | Description |
---|---|---|
keyUrl |
string |
參考 金鑰保存庫 中金鑰加密金鑰的 URL。 |
sourceVault |
包含金鑰之 金鑰保存庫 的相對 URL。 |
KeyVaultSecretReference
指定磁碟加密金鑰的位置,這是 金鑰保存庫 秘密。
名稱 | 類型 | Description |
---|---|---|
secretUrl |
string |
參考 金鑰保存庫 中秘密的URL。 |
sourceVault |
包含秘密之 金鑰保存庫的相對 URL。 |
ManagedDiskParameters
受控磁碟參數。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionSet |
指定受控磁碟的客戶受控磁碟加密集資源標識符。 |
|
id |
string |
資源標識碼 |
securityProfile |
指定受控磁碟的安全性配置檔。 |
|
storageAccountType |
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。 |
OperatingSystemTypes
操作系統類型。
名稱 | 類型 | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDisk
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為: None、ReadOnly、ReadWrite。 默認行為為: 標準記憶體的 None。進階記憶體的 ReadOnly。 |
|
createOption |
指定應如何建立虛擬機磁碟。 可能的值為 Attach: 當您使用特製化磁碟來建立虛擬機時,會使用此值。 FromImage: 當您使用映像來建立虛擬機時,會使用此值。 如果您使用平臺映像,則也應該使用上述的 imageReference 元素。 如果您使用 Marketplace 映射,則也應該使用先前所述的方案元素。 |
|
deleteOption |
指定在 VM 刪除時應刪除或中斷連結 OS 磁碟。 可能的值為: Delete。 如果使用此值,則會在刪除 VM 時刪除 OS 磁碟。 分離。 如果使用此值,則會在刪除 VM 之後保留 os 磁碟。 默認值設定為 [卸離]。 若為暫時OS磁碟,預設值會設定為 Delete。 使用者無法變更暫時 OS 磁碟的刪除選項。 |
|
diffDiskSettings |
指定虛擬機所使用作業系統磁碟的暫時磁碟設定。 |
|
diskSizeGB |
integer |
指定以 GB 為單位的空白資料磁碟大小。 此元素可用來覆寫虛擬機映像中的磁碟大小。 屬性 'diskSizeGB' 是磁碟的位元組 x 1024^3 數目,且值不能大於 1023。 |
encryptionSettings |
指定 OS 磁碟的加密設定。 API 版本下限:2015-06-15。 |
|
image |
來源使用者映像虛擬硬碟。 虛擬硬碟將會先複製,再連結至虛擬機。 如果提供SourceImage,目的地虛擬硬碟不得存在。 |
|
managedDisk |
受控磁碟參數。 |
|
name |
string |
磁碟名稱。 |
osType |
此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時,磁碟包含的 OS 類型。 可能的值為: Windows、Linux。 |
|
vhd |
虛擬硬碟。 |
|
writeAcceleratorEnabled |
boolean |
指定是否應該在磁碟上啟用或停用 writeAccelerator。 |
securityEncryptionTypes
指定受控磁碟的 EncryptionType。 它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly 只加密 VMGuestState Blob,以及 NonPersistedTPM 表示未在 VMGuestState Blob 中保存韌體狀態。 注意: 它只能設定為機密 VM。
名稱 | 類型 | Description |
---|---|---|
DiskWithVMGuestState |
string |
|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
StorageAccountTypes
指定受控磁碟的記憶體帳戶類型。 注意:UltraSSD_LRS只能與數據磁碟搭配使用,因此無法與OS磁碟搭配使用。
名稱 | 類型 | Description |
---|---|---|
PremiumV2_LRS |
string |
|
Premium_LRS |
string |
|
Premium_ZRS |
string |
|
StandardSSD_LRS |
string |
|
StandardSSD_ZRS |
string |
|
Standard_LRS |
string |
|
UltraSSD_LRS |
string |
StorageProfile
指定虛擬機器磁碟的儲存體設定。
名稱 | 類型 | Description |
---|---|---|
dataDisks |
Data |
指定用來將資料磁碟加入至虛擬機器的參數。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。 |
diskControllerType |
指定為 VM 設定的磁碟控制器類型。 注意: 如果未指定,則會使用 『hyperVGeneration』 設定為 V2,根據指定之最低 API 版本之作業系統磁碟和 VM 大小的功能,將此屬性設定為預設磁碟控制器類型。 除非您更新 VM 組態中的 VM 大小,以隱含地解除分配和重新配置 VM,否則您必須在更新其磁碟控制器類型之前解除分配 VM。 API 版本下限:2022-08-01。 |
|
imageReference |
指定要使用之映像的相關信息。 您可以指定平臺映像、Marketplace 映像或虛擬機映射的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像,但不會用於其他建立作業時,需要此元素。 |
|
osDisk |
指定虛擬機所使用的作業系統磁碟相關信息。 如需磁碟的詳細資訊,請參閱 關於 Azure 虛擬機的磁碟和 VHD。 |
SubResource
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
VirtualHardDisk
虛擬硬碟。
名稱 | 類型 | Description |
---|---|---|
uri |
string |
指定虛擬硬碟的 URI。 |
VMDiskSecurityProfile
指定受控磁碟的安全性配置檔。
名稱 | 類型 | Description |
---|---|---|
diskEncryptionSet |
針對客戶受控密鑰加密的機密VM OS 磁碟和 VMGuest Blob 所使用的受控磁碟,指定客戶受控磁碟加密集資源識別碼。 |
|
securityEncryptionType |
指定受控磁碟的 EncryptionType。 它設定為 DiskWithVMGuestState 以加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly 只加密 VMGuestState Blob,以及 NonPersistedTPM 表示未在 VMGuestState Blob 中保存韌體狀態。 注意: 它只能設定為機密 VM。 |