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


Virtual Machine Images - Get

Возвращает образ виртуальной машины.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}?api-version=2024-07-01

Параметры URI

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

string

Имя поддерживаемого региона Azure.

offer
path True

string

Допустимое предложение издателя образов.

publisherName
path True

string

Допустимый издатель изображений.

skus
path True

string

Допустимый номер SKU изображения.

subscriptionId
path True

string

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

version
path True

string

Допустимая версия SKU образа.

api-version
query True

string

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

Ответы

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

VirtualMachineImage

ХОРОШО

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Образец запроса

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/aaaaaa/publishers/aaa/artifacttypes/vmimage/offers/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/skus/aaaaaaaaaaaaaaaaaaaaaaaaaaa/versions/aaaaaaaaaaaaaaaaaaa?api-version=2024-07-01

Пример ответа

{
  "properties": {
    "plan": {
      "publisher": "aaaaaaaaaaaaaaaaaaa",
      "name": "aaaaaaaaa",
      "product": "aaaaaaaaaaaaaa"
    },
    "osDiskImage": {
      "operatingSystem": "Windows"
    },
    "dataDiskImages": [
      {
        "lun": 17
      }
    ],
    "automaticOSUpgradeProperties": {
      "automaticOSUpgradeSupported": true
    },
    "hyperVGeneration": "V1",
    "disallowed": {
      "vmDiskType": "None"
    },
    "features": [
      {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "value": "aaaaaaaaaaaaaaaaaaaa"
      }
    ],
    "imageDeprecationStatus": {
      "imageState": "ScheduledForDeprecation",
      "scheduledDeprecationTime": "2023-01-13T00:00:00+00:00",
      "alternativeOption": {
        "type": "Offer",
        "value": "aaaaaaa"
      }
    }
  },
  "name": "aaaaaaaaa",
  "location": "aaaaa",
  "tags": {
    "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "extendedLocation": {
    "name": "aaaaaaaaaaaaaaaaaaaaa",
    "type": "EdgeZone"
  },
  "id": "aaaaaaaaaaa"
}

VirtualMachineImage_Get_MinimumSet_Gen

Образец запроса

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/aaaaaaaaaaaa/publishers/aaaaaaaaaaa/artifacttypes/vmimage/offers/aa/skus/aaaaaaaaa/versions/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa?api-version=2024-07-01

Пример ответа

{
  "name": "aaaaaaaaa",
  "location": "aaaaa",
  "id": "aaaaaaaaaaa"
}

Определения

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

Описывает альтернативный параметр, указанный издателем для этого образа, если этот образ не рекомендуется.

AlternativeType

Описывает тип альтернативного параметра.

ApiError

Ошибка API.

ApiErrorBase

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

ArchitectureTypes

Указывает тип архитектуры

AutomaticOSUpgradeProperties

Описывает свойства автоматического обновления ОС на изображении.

CloudError

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

DataDiskImage

Содержит сведения о образах дисков данных.

DisallowedConfiguration

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

ExtendedLocation

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

ExtendedLocationTypes

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

HyperVGenerationTypes

Указывает тип HyperVGeneration

ImageDeprecationStatus

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

ImageState

Описывает состояние изображения.

InnerError

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

OperatingSystemTypes

Операционная система osDiskImage.

OSDiskImage

Содержит сведения о образе диска ос.

PurchasePlan

Используется для установления контекста покупки любого 3-го стороннего артефакта через MarketPlace.

VirtualMachineImage

Описывает образ виртуальной машины.

VirtualMachineImageFeature

Указывает дополнительные возможности, поддерживаемые изображением

VmDiskTypes

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

AlternativeOption

Описывает альтернативный параметр, указанный издателем для этого образа, если этот образ не рекомендуется.

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

AlternativeType

Описывает тип альтернативного параметра.

value

string

Указывает альтернативное значение параметра, указанное издателем. Это имя предложения, если тип предложения или имя плана, если тип — Plan.

AlternativeType

Описывает тип альтернативного параметра.

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

string

Offer

string

Plan

string

ApiError

Ошибка API.

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

string

Код ошибки.

details

ApiErrorBase[]

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

innererror

InnerError

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

message

string

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

target

string

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

ApiErrorBase

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

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

string

Код ошибки.

message

string

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

target

string

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

ArchitectureTypes

Указывает тип архитектуры

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

string

x64

string

AutomaticOSUpgradeProperties

Описывает свойства автоматического обновления ОС на изображении.

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

boolean

Указывает, поддерживается ли автоматическое обновление ОС на изображении.

CloudError

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

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

ApiError

Ошибка API.

DataDiskImage

Содержит сведения о образах дисков данных.

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

integer

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

DisallowedConfiguration

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

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

VmDiskTypes

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

ExtendedLocation

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

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

string

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

type

ExtendedLocationTypes

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

ExtendedLocationTypes

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

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

string

HyperVGenerationTypes

Указывает тип HyperVGeneration

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

string

V2

string

ImageDeprecationStatus

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

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

AlternativeOption

Описывает альтернативный параметр, указанный издателем для этого образа, если этот образ не рекомендуется.

imageState

ImageState

Описывает состояние изображения.

scheduledDeprecationTime

string

Время, в будущем, в котором это изображение будет отмечено как нерекомендуемое. Это запланированное время выбирается издателем.

ImageState

Описывает состояние изображения.

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

string

Deprecated

string

ScheduledForDeprecation

string

InnerError

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

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

string

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

exceptiontype

string

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

OperatingSystemTypes

Операционная система osDiskImage.

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

string

Windows

string

OSDiskImage

Содержит сведения о образе диска ос.

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

OperatingSystemTypes

Операционная система osDiskImage.

PurchasePlan

Используется для установления контекста покупки любого 3-го стороннего артефакта через MarketPlace.

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

string

Идентификатор плана.

product

string

Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference.

publisher

string

Идентификатор издателя.

VirtualMachineImage

Описывает образ виртуальной машины.

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

ExtendedLocation

Расширенное расположение виртуальной машины.

id

string

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

location

string

Поддерживаемая расположение ресурса в Azure.

name

string

Имя ресурса.

properties.architecture

ArchitectureTypes

Указывает тип архитектуры

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Описывает свойства автоматического обновления ОС на изображении.

properties.dataDiskImages

DataDiskImage[]

Содержит сведения о образах дисков данных.

properties.disallowed

DisallowedConfiguration

Указывает запрещенную конфигурацию для VirtualMachine, созданной на основе образа.

properties.features

VirtualMachineImageFeature[]

Указывает дополнительные возможности, поддерживаемые изображением

properties.hyperVGeneration

HyperVGenerationTypes

Указывает тип HyperVGeneration

properties.imageDeprecationStatus

ImageDeprecationStatus

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

properties.osDiskImage

OSDiskImage

Содержит сведения о образе диска ос.

properties.plan

PurchasePlan

Используется для установления контекста покупки любого 3-го стороннего артефакта через MarketPlace.

tags

object

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

VirtualMachineImageFeature

Указывает дополнительные возможности, поддерживаемые изображением

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

string

Имя функции.

value

string

Соответствующее значение функции.

VmDiskTypes

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

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

string

Unmanaged

string