Images - Update

Обновление образа.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}?api-version=2024-03-01

Параметры URI

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

string

Имя изображения.

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

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

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

Имя Тип Описание
properties.hyperVGeneration

HyperVGenerationTypes

Указывает тип HyperVGenerationType виртуальной машины, созданной на основе образа. В API версии 2019-03-01, если источником образа является BLOB-объект, необходимо, чтобы пользователь указал значение. Если источником является управляемый ресурс, например диск или snapshot, мы можем потребовать, чтобы пользователь указал свойство, если мы не можем вывести его из управляемого ресурса источника.

properties.sourceVirtualMachine

SubResource

Исходная виртуальная машина, на основе которой создается образ.

properties.storageProfile

ImageStorageProfile

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

tags

object

Теги ресурсов

Ответы

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

Image

ОК

201 Created

Image

Создание

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

Updates tags of an Image.

Sample Request

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage?api-version=2024-03-01

{
  "properties": {
    "sourceVirtualMachine": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
    },
    "hyperVGeneration": "V1"
  },
  "tags": {
    "department": "HR"
  }
}

Sample Response

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
  "name": "myImage",
  "type": "Microsoft.Compute/images",
  "location": "West US",
  "tags": {
    "department": "HR"
  },
  "properties": {
    "storageProfile": {
      "osDisk": {
        "osType": "Windows",
        "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
        "snapshot": {
          "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
        },
        "managedDisk": {
          "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
        },
        "osState": "Generalized",
        "storageAccountType": "Standard_LRS",
        "diskSizeGB": 20
      },
      "dataDisks": [
        {
          "lun": 1,
          "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
          "snapshot": {
            "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
          },
          "managedDisk": {
            "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
          },
          "storageAccountType": "Standard_LRS"
        }
      ],
      "zoneResilient": true
    },
    "provisioningState": "created"
  }
}
{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
  "name": "myImage",
  "type": "Microsoft.Compute/images",
  "location": "West US",
  "tags": {
    "department": "HR"
  },
  "properties": {
    "storageProfile": {
      "osDisk": {
        "osType": "Windows",
        "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
        "snapshot": {
          "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
        },
        "managedDisk": {
          "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
        },
        "osState": "Generalized",
        "storageAccountType": "Standard_LRS",
        "diskSizeGB": 20
      },
      "dataDisks": [
        {
          "lun": 1,
          "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
          "snapshot": {
            "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
          },
          "managedDisk": {
            "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
          },
          "storageAccountType": "Standard_LRS"
        }
      ],
      "zoneResilient": true
    },
    "provisioningState": "created"
  }
}

Определения

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

Ошибка API.

ApiErrorBase

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

CachingTypes

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

CloudError

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

DiskEncryptionSetParameters

Описывает параметр управляемого клиентом идентификатора ресурса набора шифрования дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview .

ExtendedLocation

Сложный тип расширенного расположения.

ExtendedLocationTypes

Тип расширенного расположения.

HyperVGenerationTypes

Указывает Тип HyperVGenerationType виртуальной машины, созданной на основе образа. Из API версии 2019-03-01, если источником образа является BLOB-объект, необходимо, чтобы пользователь указал значение. Если источником является управляемый ресурс, например диск или snapshot, может потребоваться указать свойство, если мы не можем вывести его из управляемого исходного ресурса.

Image

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

ImageDataDisk

Описывает диск данных.

ImageOSDisk

Описывает диск операционной системы.

ImageStorageProfile

Описывает профиль хранилища.

ImageUpdate

Виртуальный жесткий диск исходного образа пользователя. Могут обновляться только теги.

InnerError

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

OperatingSystemStateTypes

Состояние ОС. Для управляемых образов используйте generalized.

OperatingSystemTypes

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

StorageAccountTypes

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

SubResource

ApiError

Ошибка API.

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

string

Код ошибки.

details

ApiErrorBase[]

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

innererror

InnerError

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

message

string

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

target

string

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

ApiErrorBase

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

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

string

Код ошибки.

message

string

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

target

string

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

CachingTypes

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

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

string

ReadOnly

string

ReadWrite

string

CloudError

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

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

ApiError

Ошибка API.

DiskEncryptionSetParameters

Описывает параметр управляемого клиентом идентификатора ресурса набора шифрования дисков, который можно указать для диска. Примечание: Идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в этой статье https://aka.ms/mdssewithcmkoverview .

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

string

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

ExtendedLocation

Сложный тип расширенного расположения.

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

string

Имя расширенного расположения.

type

ExtendedLocationTypes

Тип расширенного расположения.

ExtendedLocationTypes

Тип расширенного расположения.

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

string

HyperVGenerationTypes

Указывает Тип HyperVGenerationType виртуальной машины, созданной на основе образа. Из API версии 2019-03-01, если источником образа является BLOB-объект, необходимо, чтобы пользователь указал значение. Если источником является управляемый ресурс, например диск или snapshot, может потребоваться указать свойство, если мы не можем вывести его из управляемого исходного ресурса.

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

string

V2

string

Image

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

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

ExtendedLocation

Расширенное расположение образа.

id

string

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

location

string

Расположение ресурса

name

string

Имя ресурса

properties.hyperVGeneration

HyperVGenerationTypes

Указывает Тип HyperVGenerationType виртуальной машины, созданной на основе образа. Из API версии 2019-03-01, если источником образа является BLOB-объект, необходимо, чтобы пользователь указал значение. Если источником является управляемый ресурс, например диск или snapshot, может потребоваться указать свойство, если мы не можем вывести его из управляемого исходного ресурса.

properties.provisioningState

string

Состояние подготовки.

properties.sourceVirtualMachine

SubResource

Исходная виртуальная машина, на основе которой создается образ.

properties.storageProfile

ImageStorageProfile

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

tags

object

Теги ресурсов

type

string

Тип ресурса

ImageDataDisk

Описывает диск данных.

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

string

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

caching

CachingTypes

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

diskEncryptionSet

DiskEncryptionSetParameters

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

diskSizeGB

integer

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

lun

integer

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

managedDisk

SubResource

ManagedDisk.

snapshot

SubResource

Snapshot.

storageAccountType

StorageAccountTypes

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

ImageOSDisk

Описывает диск операционной системы.

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

string

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

caching

CachingTypes

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

diskEncryptionSet

DiskEncryptionSetParameters

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

diskSizeGB

integer

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

managedDisk

SubResource

ManagedDisk.

osState

OperatingSystemStateTypes

Состояние ОС. Для управляемых образов используйте generalized.

osType

OperatingSystemTypes

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

snapshot

SubResource

Snapshot.

storageAccountType

StorageAccountTypes

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

ImageStorageProfile

Описывает профиль хранилища.

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

ImageDataDisk[]

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

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

osDisk

ImageOSDisk

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

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

zoneResilient

boolean

Указывает, является ли образ устойчивым к зоне. Значение по умолчанию — false. Образы, устойчивые к зонам, можно создавать только в регионах, которые предоставляют хранилище, избыточное между зонами (ZRS).

ImageUpdate

Виртуальный жесткий диск исходного образа пользователя. Могут обновляться только теги.

Имя Тип Описание
properties.hyperVGeneration

HyperVGenerationTypes

Указывает Тип HyperVGenerationType виртуальной машины, созданной на основе образа. Из API версии 2019-03-01, если источником образа является BLOB-объект, необходимо, чтобы пользователь указал значение. Если источником является управляемый ресурс, например диск или snapshot, может потребоваться указать свойство, если мы не можем вывести его из управляемого исходного ресурса.

properties.provisioningState

string

Состояние подготовки.

properties.sourceVirtualMachine

SubResource

Исходная виртуальная машина, на основе которой создается образ.

properties.storageProfile

ImageStorageProfile

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

tags

object

Теги ресурсов

InnerError

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

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

string

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

exceptiontype

string

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

OperatingSystemStateTypes

Состояние ОС. Для управляемых образов используйте generalized.

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

string

Обобщенное изображение. Необходимо подготовить во время развертывания.

Specialized

string

Специализированное изображение. Содержит уже подготовленный диск ОС.

OperatingSystemTypes

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

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

string

Windows

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

SubResource

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

string

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