Поделиться через


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

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

vmName
path True

string

Имя виртуальной машины.

api-version
query True

string

Версия API клиента.

Текст запроса

Имя Тип Описание
parameters

AttachDetachDataDisksRequest

Параметры, предоставляемые операции подключения и отсоединения дисков данных на виртуальной машине.

Ответы

Имя Тип Описание
200 OK

StorageProfile

ОК

202 Accepted

Принято

Заголовки

Location: string

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen
VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

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

Определения

Имя Описание
ApiEntityReference

Идентификатор исходного ресурса. Это может быть snapshot или точка восстановления диска, из которой создается диск.

ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

AttachDetachDataDisksRequest

Параметры, предоставляемые операции подключения и отсоединения дисков данных на виртуальной машине.

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

CloudError

Ответ об ошибке от службы вычислений.

DataDisk

Задает параметры, используемые для добавления диска данных к виртуальной машине. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

DataDisksToAttach

Список подключенных управляемых дисков данных.

DataDisksToDetach

Список отсоединяемых управляемых дисков данных.

DiffDiskOptions

Указывает временные параметры диска для диска операционной системы.

DiffDiskPlacement

Указывает временное размещение диска для диска операционной системы. Возможные значения: 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.

DiffDiskSettings

Указывает временные параметры диска для диска операционной системы, используемого виртуальной машиной.

DiskControllerTypes

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип контроллера диска по умолчанию, если не указана виртуальная машина при создании с параметром hyperVGeneration, для которой задано значение V2 на основе возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

DiskCreateOptionTypes

Указывает способ создания диска виртуальной машины. Возможные значения: Присоединить. Это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, следует также использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, следует также использовать элемент плана, описанный выше.

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение. Для эфемерного диска ОС по умолчанию устанавливается значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отсоединение диска или уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за неожиданного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи не были удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения обновления диска данных toBeDetached до true вместе с параметром detachOption: ForceDetach.

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

ImageReference

Указывает сведения об используемом изображении. Вы можете указать сведения об образах платформ, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если требуется использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.

InnerError

Сведения о внутренней ошибке.

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

ManagedDiskParameters

Параметры управляемого диска.

OperatingSystemTypes

Тип операционной системы.

OSDisk

Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

StorageProfile

Указывает параметры хранилища дисков виртуальной машины.

SubResource
VirtualHardDisk

Виртуальный жесткий диск.

VMDiskSecurityProfile

Указывает профиль безопасности для управляемого диска.

ApiEntityReference

Идентификатор исходного ресурса. Это может быть snapshot или точка восстановления диска, из которой создается диск.

Имя Тип Описание
id

string

Идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

AttachDetachDataDisksRequest

Параметры, предоставляемые операции подключения и отсоединения дисков данных на виртуальной машине.

Имя Тип Описание
dataDisksToAttach

DataDisksToAttach[]

Список подключенных управляемых дисков данных.

dataDisksToDetach

DataDisksToDetach[]

Список отсоединяемых управляемых дисков данных.

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

Имя Тип Описание
None

string

ReadOnly

string

ReadWrite

string

CloudError

Ответ об ошибке от службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

DataDisk

Задает параметры, используемые для добавления диска данных к виртуальной машине. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

Имя Тип Описание
caching

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

createOption

DiskCreateOptionTypes

Указывает способ создания диска виртуальной машины. Возможные значения: Присоединить. Это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания диска данных виртуальной машины. Если вы используете образ платформы, следует также использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, следует также использовать элемент плана, описанный выше. Пустой: Это значение используется при создании пустого диска данных. Копировать: Это значение используется для создания диска данных из snapshot или другого диска. Восстановить: Это значение используется для создания диска данных из точки восстановления диска.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск данных удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение.

detachOption

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отсоединение диска или уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за неожиданного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи не были удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения обновления диска данных toBeDetached до true вместе с параметром detachOption: ForceDetach.

diskIOPSReadWrite

integer

Указывает Read-Write операций ввода-вывода в секунду для управляемого диска, если StorageAccountType имеет значение UltraSSD_LRS. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновить только с помощью обновлений масштабируемого набора VirtualMachine.

diskMBpsReadWrite

integer

Указывает пропускную способность в МБ в секунду для управляемого диска, если StorageAccountType UltraSSD_LRS. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновить только с помощью обновлений масштабируемого набора VirtualMachine.

diskSizeGB

integer

Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство "diskSizeGB" — это количество байтов x 1024^3 для диска и не может быть больше 1023.

image

VirtualHardDisk

Виртуальный жесткий диск исходного образа пользователя. Виртуальный жесткий диск будет скопирован перед подключением к виртуальной машине. Если указан параметр SourceImage, целевой виртуальный жесткий диск не должен существовать.

lun

integer

Указывает номер логической единицы диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине.

managedDisk

ManagedDiskParameters

Параметры управляемого диска.

name

string

имя диска.

sourceResource

ApiEntityReference

Идентификатор исходного ресурса. Это может быть snapshot или точка восстановления диска, из которой создается диск.

toBeDetached

boolean

Указывает, находится ли диск данных в процессе отсоединения от VirtualMachine/VirtualMachineScaleset.

vhd

VirtualHardDisk

Виртуальный жесткий диск.

writeAcceleratorEnabled

boolean

Указывает, следует ли включить или отключить writeAccelerator на диске.

DataDisksToAttach

Список подключенных управляемых дисков данных.

Имя Тип Описание
caching

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск данных удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение.

diskEncryptionSet

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.

diskId

string

Идентификатор управляемого диска данных.

lun

integer

Номер логической единицы диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. Если значение не указано, lun будет назначено автоматически.

writeAcceleratorEnabled

boolean

Указывает, следует ли включить или отключить writeAccelerator на диске.

DataDisksToDetach

Список отсоединяемых управляемых дисков данных.

Имя Тип Описание
detachOption

DiskDetachOptionTypes

Поддерживаемые параметры, доступные для отсоединения диска от виртуальной машины. Дополнительные сведения см. в справочнике по объекту DetachOption.

diskId

string

Идентификатор управляемого диска данных.

DiffDiskOptions

Указывает временные параметры диска для диска операционной системы.

Имя Тип Описание
Local

string

DiffDiskPlacement

Указывает временное размещение диска для диска операционной системы. Возможные значения: 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.

Имя Тип Описание
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

Указывает временные параметры диска для диска операционной системы, используемого виртуальной машиной.

Имя Тип Описание
option

DiffDiskOptions

Указывает временные параметры диска для диска операционной системы.

placement

DiffDiskPlacement

Указывает временное размещение диска для диска операционной системы. Возможные значения: 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

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип контроллера диска по умолчанию, если не указана виртуальная машина при создании с параметром hyperVGeneration, для которой задано значение V2 на основе возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

Имя Тип Описание
NVMe

string

SCSI

string

DiskCreateOptionTypes

Указывает способ создания диска виртуальной машины. Возможные значения: Присоединить. Это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, следует также использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, следует также использовать элемент плана, описанный выше.

Имя Тип Описание
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение. Для эфемерного диска ОС по умолчанию устанавливается значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

Имя Тип Описание
Delete

string

Detach

string

DiskDetachOptionTypes

Указывает поведение отсоединения, используемое при отсоединение диска или уже находится в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption: ForceDetach применяется только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершилась из-за неожиданного сбоя виртуальной машины и диск по-прежнему не освобожден, используйте принудительное отсоединение в качестве крайнего средства, чтобы принудительно отсоединить диск от виртуальной машины. При использовании этого поведения отсоединения все операции записи не были удалены. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Для принудительного отсоединения обновления диска данных toBeDetached до true вместе с параметром detachOption: ForceDetach.

Имя Тип Описание
ForceDetach

string

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.

Имя Тип Описание
id

string

Идентификатор ресурса

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

Имя Тип Описание
diskEncryptionKey

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

enabled

boolean

Указывает, следует ли включить шифрование дисков на виртуальной машине.

keyEncryptionKey

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

ImageReference

Указывает сведения об используемом изображении. Вы можете указать сведения об образах платформ, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если требуется использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.

Имя Тип Описание
communityGalleryImageId

string

Укажите уникальный идентификатор образа коллекции сообщества для развертывания виртуальной машины. Его можно получить из коллекции сообщества образ get call.

exactVersion

string

Указывает в десятичных числах версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Это поле только для чтения отличается от "version" только в том случае, если в поле "версия" указано значение "latest".

id

string

Идентификатор ресурса

offer

string

Указывает предложение образа платформы или образа Marketplace, используемого для создания виртуальной машины.

publisher

string

Издатель образа.

sharedGalleryImageId

string

Укажите уникальный идентификатор образа общей коллекции для развертывания виртуальной машины. Его можно получить из вызова GET образа общей коллекции.

sku

string

SKU образа.

version

string

Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основной, Дополнительный и Сборка являются десятичными числами. Укажите "latest", чтобы использовать последнюю версию образа, доступную во время развертывания. Даже если вы используете последнюю версию, образ виртуальной машины не будет автоматически обновляться после развертывания, даже если станет доступна новая версия. Не используйте поле "версия" для развертывания образа коллекции. Образ коллекции всегда должен использовать поле id для развертывания, чтобы использовать "последнюю" версию образа коллекции, просто задайте "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле id без ввода версии.

InnerError

Сведения о внутренней ошибке.

Имя Тип Описание
errordetail

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

Имя Тип Описание
keyUrl

string

URL-адрес, ссылающийся на ключ шифрования ключа в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащий ключ.

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

Имя Тип Описание
secretUrl

string

URL-адрес, ссылающийся на секрет в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащий секрет.

ManagedDiskParameters

Параметры управляемого диска.

Имя Тип Описание
diskEncryptionSet

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.

id

string

Идентификатор ресурса

securityProfile

VMDiskSecurityProfile

Указывает профиль безопасности для управляемого диска.

storageAccountType

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

OperatingSystemTypes

Тип операционной системы.

Имя Тип Описание
Linux

string

Windows

string

OSDisk

Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

Имя Тип Описание
caching

CachingTypes

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium.

createOption

DiskCreateOptionTypes

Указывает способ создания диска виртуальной машины. Возможные значения: Присоединить. Это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания виртуальной машины. Если вы используете образ платформы, следует также использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, следует также использовать элемент плана, описанный выше.

deleteOption

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отсоединить. Если используется это значение, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию — Отсоединение. Для эфемерного диска ОС по умолчанию устанавливается значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

diffDiskSettings

DiffDiskSettings

Указывает временные параметры диска для диска операционной системы, используемого виртуальной машиной.

diskSizeGB

integer

Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство "diskSizeGB" — это количество байтов x 1024^3 для диска и не может быть больше 1023.

encryptionSettings

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 15.06.2015.

image

VirtualHardDisk

Виртуальный жесткий диск исходного образа пользователя. Виртуальный жесткий диск будет скопирован перед подключением к виртуальной машине. Если указан параметр SourceImage, целевой виртуальный жесткий диск не должен существовать.

managedDisk

ManagedDiskParameters

Параметры управляемого диска.

name

string

имя диска.

osType

OperatingSystemTypes

Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, которая включена в диск при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.

vhd

VirtualHardDisk

Виртуальный жесткий диск.

writeAcceleratorEnabled

boolean

Указывает, следует ли включить или отключить writeAccelerator на диске.

securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.

Имя Тип Описание
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, нельзя использовать с диском ОС.

Имя Тип Описание
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

StorageProfile

Указывает параметры хранилища дисков виртуальной машины.

Имя Тип Описание
dataDisks

DataDisk[]

Задает параметры, используемые для добавления диска данных к виртуальной машине. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

diskControllerType

DiskControllerTypes

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание: Для этого свойства будет задан тип контроллера диска по умолчанию, если не указана виртуальная машина при создании с параметром hyperVGeneration, для которой задано значение V2 на основе возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если только вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перераспределяет виртуальную машину. Минимальная версия API: 2022-08-01.

imageReference

ImageReference

Указывает сведения об используемом изображении. Вы можете указать сведения об образах платформ, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если требуется использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.

osDisk

OSDisk

Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

SubResource

Имя Тип Описание
id

string

Идентификатор ресурса

VirtualHardDisk

Виртуальный жесткий диск.

Имя Тип Описание
uri

string

Указывает универсальный код ресурса (URI) виртуального жесткого диска.

VMDiskSecurityProfile

Указывает профиль безопасности для управляемого диска.

Имя Тип Описание
diskEncryptionSet

DiskEncryptionSetParameters

Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного ключа конфиденциальной виртуальной машины и большого двоичного объекта VMGuest.

securityEncryptionType

securityEncryptionTypes

Указывает Тип шифрования управляемого диска. Для него задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с BLOB-объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для того, чтобы не сохранять состояние встроенного ПО в BLOB-объекте VMGuestState. Примечание: Его можно задать только для конфиденциальных виртуальных машин.