Virtual Machine Images - Get

Referencia

Servicio:: Compute

Versión de la API:: 2021-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=2021-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
location	path	True	string	Nombre de una región de Azure admitida.
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	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
version	path	True	string	Una versión válida de SKU de imagen.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineImage	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

VirtualMachineImages_Get_MaximumSet_Gen

VirtualMachineImages_Get_MinimumSet_Gen

VirtualMachineImages_Get_MaximumSet_Gen

Solicitud de ejemplo

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

import com.azure.core.util.Context;

/** Samples for VirtualMachineImages Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/examples/compute/VirtualMachineImages_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImages_Get_MaximumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineImagesGetMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineImages()
            .getWithResponse(
                "aaaaaa",
                "aaa",
                "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                "aaaaaaaaaaaaaaaaaaa",
                Context.NONE);
    }
}

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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/examples/compute/VirtualMachineImages_Get_MaximumSet_Gen.json
func ExampleVirtualMachineImagesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armcompute.NewVirtualMachineImagesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<location>",
		"<publisher-name>",
		"<offer>",
		"<skus>",
		"<version>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a virtual machine image.
 *
 * @summary Gets a virtual machine image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/examples/compute/VirtualMachineImages_Get_MaximumSet_Gen.json
 */
async function virtualMachineImagesGetMaximumSetGen() {
  const subscriptionId = "{subscription-id}";
  const location = "aaaaaa";
  const publisherName = "aaa";
  const offer = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const skus = "aaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const version = "aaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineImages.get(
    location,
    publisherName,
    offer,
    skus,
    version
  );
  console.log(result);
}

virtualMachineImagesGetMaximumSetGen().catch(console.error);

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"
      }
    ]
  },
  "name": "aaaaaaaaa",
  "location": "aaaaa",
  "tags": {
    "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "extendedLocation": {
    "name": "aaaaaaaaaaaaaaaaaaaaa",
    "type": "EdgeZone"
  },
  "id": "aaaaaaaaaaa"
}

VirtualMachineImages_Get_MinimumSet_Gen

Solicitud de ejemplo

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

import com.azure.core.util.Context;

/** Samples for VirtualMachineImages Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/examples/compute/VirtualMachineImages_Get_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImages_Get_MinimumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineImagesGetMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineImages()
            .getWithResponse(
                "aaaaaaaaaaaa", "aaaaaaaaaaa", "aa", "aaaaaaaaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", Context.NONE);
    }
}

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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a virtual machine image.
 *
 * @summary Gets a virtual machine image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/examples/compute/VirtualMachineImages_Get_MinimumSet_Gen.json
 */
async function virtualMachineImagesGetMinimumSetGen() {
  const subscriptionId = "{subscription-id}";
  const location = "aaaaaaaaaaaa";
  const publisherName = "aaaaaaaaaaa";
  const offer = "aa";
  const skus = "aaaaaaaaa";
  const version = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineImages.get(
    location,
    publisherName,
    offer,
    skus,
    version
  );
  console.log(result);
}

virtualMachineImagesGetMinimumSetGen().catch(console.error);

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

Definiciones

Nombre	Description
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	Respuesta de error del servicio Compute.
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	Tipo de la ubicación extendida.
HyperVGenerationTypes	Especifica el tipo HyperVGeneration.
InnerError	Detalles del error interno.
OperatingSystemTypes	Sistema operativo de osDiskImage.
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 están permitidos.

ApiError

Error de API.

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

ApiErrorBase

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

Especifica el tipo de arquitectura.

Nombre	Tipo	Description
Arm64	string
x64	string

AutomaticOSUpgradeProperties

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

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

DataDiskImage

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

Nombre	Tipo	Description
lun	integer	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

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 están permitidos.

ExtendedLocation

Tipo complejo de la ubicación extendida.

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

ExtendedLocationTypes

Tipo de la ubicación extendida.

Nombre	Tipo	Description
EdgeZone	string

HyperVGenerationTypes

Especifica el tipo HyperVGeneration.

Nombre	Tipo	Description
V1	string
V2	string

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de la excepción.

OperatingSystemTypes

Sistema operativo de osDiskImage.

Nombre	Tipo	Description
Linux	string
Windows	string

OSDiskImage

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

Nombre	Tipo	Description
operatingSystem	OperatingSystemTypes	Sistema operativo de osDiskImage.

PurchasePlan

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.

VirtualMachineImage

Describe una imagen de máquina virtual.

Nombre	Tipo	Description
extendedLocation	ExtendedLocation	Ubicación extendida de la máquina virtual.
id	string	Id. de recurso
location	string	La ubicación de Azure admitida del recurso.
name	string	Nombre del recurso.
properties.architecture	ArchitectureTypes	Especifica el tipo de arquitectura.
properties.automaticOSUpgradeProperties	AutomaticOSUpgradeProperties	Describe las propiedades de actualización automática del sistema operativo en la imagen.
properties.dataDiskImages	DataDiskImage[]	Contiene la información de las imágenes de disco de datos.
properties.disallowed	DisallowedConfiguration	Especifica la configuración no permitida para la máquina virtual creada a partir de la imagen.
properties.features	VirtualMachineImageFeature[]	Especifica funcionalidades adicionales admitidas por la imagen.
properties.hyperVGeneration	HyperVGenerationTypes	Especifica el tipo HyperVGeneration.
properties.osDiskImage	OSDiskImage	Contiene la información de la imagen del disco del sistema operativo.
properties.plan	PurchasePlan	Se usa para establecer el contexto de compra de cualquier artefacto de terceros a través de MarketPlace.
tags	object	Especifica las etiquetas asignadas a la máquina virtual. Para más información sobre el uso de etiquetas, consulte Uso de etiquetas para organizar los recursos de Azure.

VirtualMachineImageFeature

Especifica funcionalidades adicionales admitidas por la imagen.

Nombre	Tipo	Description
name	string	Nombre de la característica.
value	string	Valor correspondiente de la característica.

VmDiskTypes

Tipos de disco de máquina virtual que no están permitidos.

Nombre	Tipo	Description
None	string
Unmanaged	string

The future is yours

Compartir a través de

Virtual Machine Images - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

VirtualMachineImages_Get_MaximumSet_Gen

Solicitud de ejemplo

Respuesta de muestra

VirtualMachineImages_Get_MinimumSet_Gen

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiError

ApiErrorBase

ArchitectureTypes

AutomaticOSUpgradeProperties

CloudError

DataDiskImage

DisallowedConfiguration

ExtendedLocation

ExtendedLocationTypes

HyperVGenerationTypes

InnerError

OperatingSystemTypes

OSDiskImage

PurchasePlan

VirtualMachineImage

VirtualMachineImageFeature

VmDiskTypes

Recursos adicionales