Virtual Machines - Attach Detach Data Disks
Подключайте и отсоединяйте диски данных к виртуальной машине или от нее.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks?api-version=2025-04-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не зависит от регистра. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
vm
|
path | True |
string |
Имя виртуальной машины. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| dataDisksToAttach |
Список подключенных управляемых дисков данных. |
|
| dataDisksToDetach |
Список отсоединяемых дисков с управляемыми данными. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция Azure успешно завершена. |
|
| 202 Accepted |
Операция ресурса принята. Заголовки
|
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| 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=2025-04-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=2025-04-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
Определения
| Имя | Описание |
|---|---|
|
Api |
Справочник по сущностям API. |
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Attach |
Указывает входные данные для подключения и отсоединения списка управляемых дисков данных. |
|
Caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium |
|
Cloud |
Ответ об ошибке от службы вычислений. |
|
Data |
Описание диска с данными. |
|
Data |
Описание подключаемого диска с данными. |
|
Data |
Описывает диск с данными, который необходимо отсоединить. |
|
Diff |
Задает параметр временного диска для диска операционной системы. |
|
Diff |
Задает эфемерное размещение дисков для диска операционной системы. Это свойство может быть использовано пользователем в запросе для выбора местоположения, т.е. кэш-диска, ресурсного диска или дискового пространства nvme для предоставления дискового пространства Ephemeral OS. Дополнительные сведения о требованиях к размеру диска эфемерной ОС см. в разделе "Требования к размеру диска операционной системы" для виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Windows и виртуальной машине Linux.https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Минимальная версия API для NvmeDisk: 2024-03-01. |
|
Diff |
Описывает параметры временных параметров диска, которые можно указать для диска операционной системы. Примечание. Параметры временного диска можно указать только для управляемого диска. |
|
Disk |
Указывает тип контроллера диска, настроенный для виртуальной машины и VirtualMachineScaleSet. Это свойство поддерживается только для виртуальных машин, для которых диск операционной системы и SKU виртуальной машины поддерживают поколение 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), проверьте возможность HyperVGenerations, возвращенную как часть возможностей SKU виртуальной машины в ответ api SKU Microsoft.Compute для региона содержит версию 2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Дополнительные сведения о поддерживаемых типах контроллеров дисков см. в https://aka.ms/azure-diskcontrollertypes. |
|
Disk |
Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска. |
|
Disk |
Указывает поведение управляемого диска при удалении виртуальной машины, например, удаляется или отсоединяется ли управляемый диск. Поддерживаемые значения: Delete. Если это значение используется, управляемый диск удаляется при удалении виртуальной машины. Отделять. Если это значение используется, управляемый диск сохраняется после удаления виртуальной машины. Минимальная версия API: 2021-03-01. |
|
Disk |
Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption : ForceDetach применим только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach. |
|
Disk |
Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview. |
|
Disk |
Описание настроек шифрования для диска |
|
Image |
Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на изображения и предложение можно задать только при создании масштабируемого набора. |
|
Inner |
Сведения о внутренней ошибке. |
|
Key |
Описание ссылки на Key Vault Key |
|
Key |
Описание ссылки на секрет Key Vault |
|
Managed |
Параметры управляемого диска. |
|
Operating |
Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux. |
| OSDisk |
Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure. |
|
Security |
Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин. |
|
Storage |
Указывает тип учетной записи хранения для управляемого диска. Тип учетной записи хранения управляемого диска ОС можно задать только при создании масштабируемого набора. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных. Его нельзя использовать с диском ОС. Standard_LRS использует HDD уровня "Стандартный". StandardSSD_LRS использует SSD уровня "Стандартный". Premium_LRS использует SSD уровня "Премиум". UltraSSD_LRS использует диск "Ультра". Premium_ZRS использует избыточное хранилище зоны SSD уровня "Премиум". StandardSSD_ZRS использует избыточное хранилище зоны SSD уровня "Стандартный". Дополнительные сведения о дисках, поддерживаемых для виртуальных машин Windows, см. в https://docs.microsoft.com/azure/virtual-machines/windows/disks-types и для виртуальных машин Linux см. в https://docs.microsoft.com/azure/virtual-machines/linux/disks-types |
|
Storage |
Задает параметры хранилища для дисков виртуальной машины. |
|
Sub |
|
|
Virtual |
Описывает универсальный код ресурса (URI) диска. |
|
VMDisk |
Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин. |
ApiEntityReference
Справочник по сущностям API.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
ApiError
Ошибка API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке Api |
|
| innererror |
Внутренняя ошибка Api |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
AttachDetachDataDisksRequest
Указывает входные данные для подключения и отсоединения списка управляемых дисков данных.
| Имя | Тип | Описание |
|---|---|---|
| dataDisksToAttach |
Список подключенных управляемых дисков данных. |
|
| dataDisksToDetach |
Список отсоединяемых дисков с управляемыми данными. |
CachingTypes
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium
| Значение | Описание |
|---|---|
| None | |
| ReadOnly | |
| ReadWrite |
CloudError
Ответ об ошибке от службы вычислений.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ошибка API. |
DataDisk
Описание диска с данными.
| Имя | Тип | Описание |
|---|---|---|
| caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium. |
|
| createOption |
Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания диска данных виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска. |
|
| deleteOption |
Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск данных удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. |
|
| detachOption |
Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. отсоединение: ForceDetach применимо только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach. |
|
| diskIOPSReadWrite |
integer (int64) |
Указывает Read-Write операций ввода-вывода в секунду для управляемого диска, если свойство StorageAccountType имеет значение UltraSSD_LRS. |
| diskMBpsReadWrite |
integer (int64) |
Указывает пропускную способность в МБ в секунду для управляемого диска, если значение параметра StorageAccountType равно UltraSSD_LRS. |
| diskSizeGB |
integer (int32) |
Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это число байтов x 1024^3 для диска, а значение не может быть больше 1023. |
| image |
Исходный образ пользователя виртуального жесткого диска. Виртуальный жесткий диск будет скопирован перед присоединением к виртуальной машине. Если предоставляется SourceImage, целевой виртуальный жесткий диск не должен существовать. |
|
| lun |
integer (int32) |
Указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных на виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. |
| managedDisk |
Параметры управляемого диска. |
|
| name |
string |
Имя диска. |
| sourceResource |
Идентификатор исходного ресурса. Это может быть моментальный снимок или точка восстановления диска, из которой создается диск. |
|
| toBeDetached |
boolean |
Указывает, находится ли диск данных в процессе отсоединения от VirtualMachine/VirtualMachineScaleset |
| vhd |
Виртуальный жесткий диск. |
|
| writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить записьAccelerator на диске. |
DataDisksToAttach
Описание подключаемого диска с данными.
| Имя | Тип | Описание |
|---|---|---|
| caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium. |
|
| deleteOption |
Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск данных удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. |
|
| diskEncryptionSet |
Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска. |
|
| diskId |
string |
Идентификатор управляемого диска данных. |
| lun |
integer (int32) |
Номер логической единицы диска данных. Это значение используется для идентификации дисков данных на виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. Если не указано, лунь будет назначен автоматически. |
| writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить записьAccelerator на диске. |
DataDisksToDetach
Описывает диск с данными, который необходимо отсоединить.
| Имя | Тип | Описание |
|---|---|---|
| detachOption |
Доступны поддерживаемые параметры для Отсоединение диска от виртуальной машины. Дополнительные сведения см. в справочнике по объектам DetachOption. |
|
| diskId |
string |
Идентификатор управляемого диска данных. |
DiffDiskOptions
Задает параметр временного диска для диска операционной системы.
| Значение | Описание |
|---|---|
| Local |
DiffDiskPlacement
Задает эфемерное размещение дисков для диска операционной системы. Это свойство может быть использовано пользователем в запросе для выбора местоположения, т.е. кэш-диска, ресурсного диска или дискового пространства nvme для предоставления дискового пространства Ephemeral OS. Дополнительные сведения о требованиях к размеру диска эфемерной ОС см. в разделе "Требования к размеру диска операционной системы" для виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Windows и виртуальной машине Linux.https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Минимальная версия API для NvmeDisk: 2024-03-01.
| Значение | Описание |
|---|---|
| CacheDisk | |
| ResourceDisk | |
| NvmeDisk |
DiffDiskSettings
Описывает параметры временных параметров диска, которые можно указать для диска операционной системы. Примечание. Параметры временного диска можно указать только для управляемого диска.
| Имя | Тип | Описание |
|---|---|---|
| option |
Задает временные параметры диска для диска операционной системы. |
|
| placement |
Задает эфемерное размещение дисков для диска операционной системы. Возможные значения: CacheDisk,ResourceDisk,NvmeDisk. Поведение по умолчанию: CacheDisk, если он настроен для размера виртуальной машины в противном случае используется ResourceDisk или NvmeDisk. Ознакомьтесь с документацией по размеру виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/sizes и виртуальной машине Linux в https://docs.microsoft.com/azure/virtual-machines/linux/sizes, чтобы проверить, какие размеры виртуальных машин предоставляют диск кэша. Минимальная версия API для NvmeDisk: 2024-03-01. |
DiskControllerTypes
Указывает тип контроллера диска, настроенный для виртуальной машины и VirtualMachineScaleSet. Это свойство поддерживается только для виртуальных машин, для которых диск операционной системы и SKU виртуальной машины поддерживают поколение 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), проверьте возможность HyperVGenerations, возвращенную как часть возможностей SKU виртуальной машины в ответ api SKU Microsoft.Compute для региона содержит версию 2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Дополнительные сведения о поддерживаемых типах контроллеров дисков см. в https://aka.ms/azure-diskcontrollertypes.
| Значение | Описание |
|---|---|
| SCSI | |
| NVMe |
DiskCreateOptionTypes
Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска.
| Значение | Описание |
|---|---|
| FromImage | |
| Empty | |
| Attach | |
| Copy | |
| Restore |
DiskDeleteOptionTypes
Указывает поведение управляемого диска при удалении виртуальной машины, например, удаляется или отсоединяется ли управляемый диск. Поддерживаемые значения: Delete. Если это значение используется, управляемый диск удаляется при удалении виртуальной машины. Отделять. Если это значение используется, управляемый диск сохраняется после удаления виртуальной машины. Минимальная версия API: 2021-03-01.
| Значение | Описание |
|---|---|
| Delete | |
| Detach |
DiskDetachOptionTypes
Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption : ForceDetach применим только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach.
| Значение | Описание |
|---|---|
| ForceDetach |
DiskEncryptionSetParameters
Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
DiskEncryptionSettings
Описание настроек шифрования для диска
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionKey |
Указывает расположение ключа шифрования диска, являющегося секретом Key Vault. |
|
| enabled |
boolean |
Указывает, следует ли включить шифрование дисков на виртуальной машине. |
| keyEncryptionKey |
Указывает расположение ключа шифрования ключей в Key Vault. |
ImageReference
Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на изображения и предложение можно задать только при создании масштабируемого набора.
| Имя | Тип | Описание |
|---|---|---|
| communityGalleryImageId |
string |
Укажите уникальный идентификатор образа коллекции сообщества для развертывания виртуальной машины. Это можно получить из вызова GET изображения коллекции сообщества. |
| exactVersion |
string |
Указывает в десятичных числах версию образа платформы или образа маркетплейса, используемого для создания виртуальной машины. Это поле только для чтения отличается от 'version' только в том случае, если значение, указанное в поле 'version', является 'latest'. |
| id |
string |
Идентификатор ресурса |
| offer |
string |
Указывает предложение образа платформы или образа Marketplace, используемого для создания виртуальной машины. |
| publisher |
string |
Издатель образа. |
| sharedGalleryImageId |
string |
Укажите уникальный идентификатор образа общей коллекции для развертывания виртуальной машины. Это можно получить из вызова GET образа общей коллекции. |
| sku |
string |
Номер SKU изображения. |
| version |
string |
Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основные, незначительные и сборки — это десятичные числа. Укажите "последняя", чтобы использовать последнюю версию образа, доступного во время развертывания. Даже если вы используете "последнюю версию", образ виртуальной машины не будет автоматически обновляться после развертывания, даже если новая версия станет доступной. Не используйте поле "версия" для развертывания образа коллекции, образ коллекции всегда должен использовать поле "id" для развертывания, чтобы использовать последнюю версию образа коллекции, просто установить "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле "id" без ввода версии. |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
KeyVaultKeyReference
Описание ссылки на Key Vault Key
| Имя | Тип | Описание |
|---|---|---|
| keyUrl |
string |
URL-адрес, ссылающийся на ключ шифрования ключей в Key Vault. |
| sourceVault |
Относительный URL-адрес Хранилища ключей, содержащий ключ. |
KeyVaultSecretReference
Описание ссылки на секрет Key Vault
| Имя | Тип | Описание |
|---|---|---|
| secretUrl |
string |
URL-адрес, ссылающийся на секрет в Key Vault. |
| sourceVault |
Относительный URL-адрес Хранилища ключей, содержащий секрет. |
ManagedDiskParameters
Параметры управляемого диска.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSet |
Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска. |
|
| id |
string |
Идентификатор ресурса |
| securityProfile |
Указывает профиль безопасности управляемого диска. |
|
| storageAccountType |
Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС. |
OperatingSystemTypes
Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.
| Значение | Описание |
|---|---|
| Windows | |
| Linux |
OSDisk
Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.
| Имя | Тип | Описание |
|---|---|---|
| caching |
Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium. |
|
| createOption |
Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. |
|
| deleteOption |
Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. Для временного диска ОС по умолчанию задано значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС. |
|
| diffDiskSettings |
Задает временные параметры диска для диска операционной системы, используемого виртуальной машиной. |
|
| diskSizeGB |
integer (int32) |
Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это число байтов x 1024^3 для диска, а значение не может быть больше 1023. |
| encryptionSettings |
Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15. |
|
| image |
Исходный образ пользователя виртуального жесткого диска. Виртуальный жесткий диск будет скопирован перед присоединением к виртуальной машине. Если предоставляется SourceImage, целевой виртуальный жесткий диск не должен существовать. |
|
| managedDisk |
Параметры управляемого диска. |
|
| name |
string |
Имя диска. |
| osType |
Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux. |
|
| vhd |
Виртуальный жесткий диск. |
|
| writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить записьAccelerator на диске. |
SecurityEncryptionTypes
Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.
| Значение | Описание |
|---|---|
| VMGuestStateOnly | |
| DiskWithVMGuestState | |
| NonPersistedTPM |
StorageAccountTypes
Указывает тип учетной записи хранения для управляемого диска. Тип учетной записи хранения управляемого диска ОС можно задать только при создании масштабируемого набора. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных. Его нельзя использовать с диском ОС. Standard_LRS использует HDD уровня "Стандартный". StandardSSD_LRS использует SSD уровня "Стандартный". Premium_LRS использует SSD уровня "Премиум". UltraSSD_LRS использует диск "Ультра". Premium_ZRS использует избыточное хранилище зоны SSD уровня "Премиум". StandardSSD_ZRS использует избыточное хранилище зоны SSD уровня "Стандартный". Дополнительные сведения о дисках, поддерживаемых для виртуальных машин Windows, см. в https://docs.microsoft.com/azure/virtual-machines/windows/disks-types и для виртуальных машин Linux см. в https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
| Значение | Описание |
|---|---|
| Standard_LRS | |
| Premium_LRS | |
| StandardSSD_LRS | |
| UltraSSD_LRS | |
| Premium_ZRS | |
| StandardSSD_ZRS | |
| PremiumV2_LRS |
StorageProfile
Задает параметры хранилища для дисков виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| alignRegionalDisksToVMZone |
boolean |
Указывает, должны ли региональные диски быть выровнены или перемещены в зону виртуальной машины. Это применимо только для виртуальных машин с набором свойств размещения. Обратите внимание, что это изменение является необратимым. Минимальная версия API: 2024-11-01. |
| dataDisks |
Data |
Указывает параметры, используемые для добавления диска данных на виртуальную машину. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure. |
| diskControllerType |
Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание. Это свойство будет иметь тип контроллера диска по умолчанию, если не указанная виртуальная машина создается с параметром HyperVGeneration, равным версии 2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перенаправляет виртуальную машину. Минимальная версия API: 2022-08-01. |
|
| imageReference |
Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. |
|
| osDisk |
Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure. |
SubResource
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
VirtualHardDisk
Описывает универсальный код ресурса (URI) диска.
| Имя | Тип | Описание |
|---|---|---|
| uri |
string |
Задает универсальный код ресурса (URI) виртуального жесткого диска. |
VMDiskSecurityProfile
Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSet |
Указывает идентификатор ресурса набора ресурсов шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного диска ОПЕРАЦИОННОй системы Конфиденциальной виртуальной машины и большого двоичного объекта VMGuest. |
|
| securityEncryptionType |
Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин. |