Virtual Machine Images - Get

Служба:: Compute

Версия API:: 2025-11-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
location	path	True	string minLength: 1	Название региона Azure.
offer	path	True	string	Допустимое предложение издателя образов.
publisherName	path	True	string	Допустимый издатель изображений.
skus	path	True	string	Допустимый номер SKU изображения.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
version	path	True	string	Допустимая версия SKU образа.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineImage	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: 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=2025-11-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("aaaaaa");
string publisherName = "aaa";
string offer = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
string skus = "aaaaaaaaaaaaaaaaaaaaaaaaaaa";
string version = "aaaaaaaaaaaaaaaaaaa";
VirtualMachineImage result = await subscriptionResource.GetVirtualMachineImageAsync(location, publisherName, offer, skus, version);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "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

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

HTTP
dotnet

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=2025-11-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("aaaaaaaaaaaa");
string publisherName = "aaaaaaaaaaa";
string offer = "aa";
string skus = "aaaaaaaaa";
string version = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
VirtualMachineImage result = await subscriptionResource.GetVirtualMachineImageAsync(location, publisherName, offer, skus, version);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "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	Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа. Возможные значения: Windows,Linux.
OSDiskImage	Содержит сведения о образе диска ос.
PurchasePlan	Используется для установления контекста покупки любого 3-го стороннего артефакта через MarketPlace.
VirtualMachineImage	Описывает образ виртуальной машины.
VirtualMachineImageFeature	Указывает дополнительные возможности, поддерживаемые изображением
VmDiskTypes	Типы дисков виртуальной машины, которые запрещены.

AlternativeOption

Объект

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

Имя	Тип	Описание
type	AlternativeType	Описывает тип альтернативного параметра.
value	string	Указывает альтернативное значение параметра, указанное издателем. Это имя предложения, если тип предложения или имя плана, если тип — Plan.

AlternativeType

Перечисление

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

Значение	Описание
None
Offer
Plan

ApiError

Объект

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

Объект

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ArchitectureTypes

Перечисление

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

Значение	Описание
x64
Arm64

AutomaticOSUpgradeProperties

Объект

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

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

CloudError

Объект

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

Имя	Тип	Описание
error	ApiError	Ошибка API.

DataDiskImage

Объект

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

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

DisallowedConfiguration

Объект

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

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

ExtendedLocation

Объект

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

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	ExtendedLocationTypes	Тип расширенного расположения.

ExtendedLocationTypes

Перечисление

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

Значение	Описание
EdgeZone

HyperVGenerationTypes

Перечисление

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

Значение	Описание
V1
V2

ImageDeprecationStatus

Объект

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

Имя	Тип	Описание
alternativeOption	AlternativeOption	Описывает альтернативный параметр, указанный издателем для этого образа, если этот образ не рекомендуется.
imageState	ImageState	Описывает состояние изображения.
scheduledDeprecationTime	string (date-time)	Время, в будущем, в котором это изображение будет отмечено как нерекомендуемое. Это запланированное время выбирается издателем.

ImageState

Перечисление

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

Значение	Описание
Active
ScheduledForDeprecation
Deprecated

InnerError

Объект

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

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

OperatingSystemTypes

Перечисление

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

Значение	Описание
Windows
Linux

OSDiskImage

Объект

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

Имя	Тип	Описание
operatingSystem	OperatingSystemTypes	Операционная система osDiskImage.

PurchasePlan

Объект

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

Имя	Тип	Описание
name	string	Идентификатор плана.
product	string	Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference.
publisher	string	Идентификатор издателя.