Virtual Machine Images - Get

Servicio:: Compute

Versión de la API:: 2025-11-01

Obtiene una imagen de máquina virtual.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
location	path	True	string minLength: 1	El nombre de la región de Azure.
offer	path	True	string	Una oferta válida del publicador de imágenes.
publisherName	path	True	string	Publicador de imágenes válido.
skus	path	True	string	Una SKU de imagen válida.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
version	path	True	string	Una versión válida de SKU de imagen.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineImage	Operación de Azure completada con éxito.
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AlternativeOption	Describe la opción alternativa especificada por el publicador para esta imagen cuando esta imagen está en desuso.
AlternativeType	Describe el tipo de la opción alternativa.
ApiError	Error de API.
ApiErrorBase	Base de errores de API.
ArchitectureTypes	Especifica el tipo de arquitectura.
AutomaticOSUpgradeProperties	Describe las propiedades de actualización automática del sistema operativo en la imagen.
CloudError	Una respuesta de error del servicio de proceso.
DataDiskImage	Contiene la información de las imágenes de disco de datos.
DisallowedConfiguration	Especifica la configuración no permitida para una imagen de máquina virtual.
ExtendedLocation	Tipo complejo de la ubicación extendida.
ExtendedLocationTypes	El tipo de la ubicación extendida.
HyperVGenerationTypes	Especifica el tipo de HyperVGeneration
ImageDeprecationStatus	Describe las propiedades de estado de desuso de la imagen en la imagen.
ImageState	Describe el estado de la imagen.
InnerError	Detalles del error interno.
OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco si crea una máquina virtual a partir de una imagen personalizada. Los valores posibles son: Windows,Linux.
OSDiskImage	Contiene la información de la imagen del disco del sistema operativo.
PurchasePlan	Se usa para establecer el contexto de compra de cualquier artefacto de terceros a través de MarketPlace.
VirtualMachineImage	Describe una imagen de máquina virtual.
VirtualMachineImageFeature	Especifica funcionalidades adicionales admitidas por la imagen
VmDiskTypes	Tipos de disco de máquina virtual que no se permiten.

AlternativeOption

Objeto

Describe la opción alternativa especificada por el publicador para esta imagen cuando esta imagen está en desuso.

Nombre	Tipo	Description
type	AlternativeType	Describe el tipo de la opción alternativa.
value	string	Indica el valor de opción alternativo especificado por el publicador. Este es el nombre de la oferta cuando el tipo es Oferta o el nombre del plan cuando el tipo es Plan.

AlternativeType

Enumeración

Describe el tipo de la opción alternativa.

Valor	Description
None
Offer
Plan

ApiError

Objeto

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de la API
innererror	InnerError	El error interno de la API
message	string	El mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Objeto

Base de errores de API.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

ArchitectureTypes

Enumeración

Especifica el tipo de arquitectura.

Valor	Description
x64
Arm64

AutomaticOSUpgradeProperties

Objeto

Describe las propiedades de actualización automática del sistema operativo en la imagen.

Nombre	Tipo	Description
automaticOSUpgradeSupported	boolean	Especifica si se admite la actualización automática del sistema operativo en la imagen.

CloudError

Objeto

Una respuesta de error del servicio de proceso.

Nombre	Tipo	Description
error	ApiError	Error de API.

DataDiskImage

Objeto

Contiene la información de las imágenes de disco de datos.

Nombre	Tipo	Description
lun	integer (int32)	Especifica el número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a una máquina virtual.

DisallowedConfiguration

Objeto

Especifica la configuración no permitida para una imagen de máquina virtual.

Nombre	Tipo	Description
vmDiskType	VmDiskTypes	Tipos de disco de máquina virtual que no se permiten.

ExtendedLocation

Objeto

Tipo complejo de la ubicación extendida.

Nombre	Tipo	Description
name	string	Nombre de la ubicación extendida.
type	ExtendedLocationTypes	El tipo de la ubicación extendida.

ExtendedLocationTypes

Enumeración

El tipo de la ubicación extendida.

Valor	Description
EdgeZone

HyperVGenerationTypes

Enumeración

Especifica el tipo de HyperVGeneration

Valor	Description
V1
V2

ImageDeprecationStatus

Objeto

Describe las propiedades de estado de desuso de la imagen en la imagen.

Nombre	Tipo	Description
alternativeOption	AlternativeOption	Describe la opción alternativa especificada por el publicador para esta imagen cuando esta imagen está en desuso.
imageState	ImageState	Describe el estado de la imagen.
scheduledDeprecationTime	string (date-time)	El momento, en el futuro, en el que esta imagen se marcará como en desuso. El publicador elige esta hora programada.

ImageState

Enumeración

Describe el estado de la imagen.

Valor	Description
Active
ScheduledForDeprecation
Deprecated

InnerError

Objeto

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	El mensaje de error interno o el volcado de excepción.
exceptiontype	string	Tipo de la excepción.

OperatingSystemTypes

Enumeración

Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco si crea una máquina virtual a partir de una imagen personalizada. Los valores posibles son: Windows,Linux.

Valor	Description
Windows
Linux

OSDiskImage

Objeto

Contiene la información de la imagen del disco del sistema operativo.

Nombre	Tipo	Description
operatingSystem	OperatingSystemTypes	Sistema operativo de osDiskImage.

PurchasePlan

Objeto

Se usa para establecer el contexto de compra de cualquier artefacto de terceros a través de MarketPlace.

Nombre	Tipo	Description
name	string	Identificador del plan.
product	string	Especifica el producto de la imagen de Marketplace. Este es el mismo valor que Offer en el elemento imageReference.
publisher	string	Identificador del publicador.