Images - Get

Referencia

Service:: Compute

API Version:: 2024-03-01

Obtiene una imagen.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
imageName	path	True	string	Nombre de la imagen.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
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.
api-version	query	True	string	Versión de api de cliente.
$expand	query		string	Expresión expand que se va a aplicar en la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Image	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

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get information about a virtual machine image.

Sample Request

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


/**
 * Samples for Images GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/imageExamples/
     * Image_Get.json
     */
    /**
     * Sample code: Get information about a virtual machine image.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getInformationAboutAVirtualMachineImage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getImages().getByResourceGroupWithResponse("myResourceGroup",
            "myImage", null, com.azure.core.util.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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python image_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.images.get(
        resource_group_name="myResourceGroup",
        image_name="myImage",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/imageExamples/Image_Get.json
if __name__ == "__main__":
    main()

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/imageExamples/Image_Get.json
func ExampleImagesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewImagesClient().Get(ctx, "myResourceGroup", "myImage", &armcompute.ImagesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Image = armcompute.Image{
	// 	Name: to.Ptr("myImage"),
	// 	Type: to.Ptr("Microsoft.Compute/images"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcompute.ImageProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.ImageStorageProfile{
	// 			DataDisks: []*armcompute.ImageDataDisk{
	// 				{
	// 					BlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd"),
	// 					ManagedDisk: &armcompute.SubResource{
	// 						ID: to.Ptr("subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"),
	// 					},
	// 					Snapshot: &armcompute.SubResource{
	// 						ID: to.Ptr("subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"),
	// 					},
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					Lun: to.Ptr[int32](1),
	// 			}},
	// 			OSDisk: &armcompute.ImageOSDisk{
	// 				BlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"),
	// 				DiskSizeGB: to.Ptr[int32](20),
	// 				ManagedDisk: &armcompute.SubResource{
	// 					ID: to.Ptr("subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"),
	// 				},
	// 				Snapshot: &armcompute.SubResource{
	// 					ID: to.Ptr("subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"),
	// 				},
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				OSState: to.Ptr(armcompute.OperatingSystemStateTypesGeneralized),
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 			ZoneResilient: to.Ptr(true),
	// 		},
	// 	},
	// }
}

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 an image.
 *
 * @summary Gets an image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/imageExamples/Image_Get.json
 */
async function getInformationAboutAVirtualMachineImage() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const imageName = "myImage";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.images.get(resourceGroupName, imageName);
  console.log(result);
}

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
  "name": "myImage",
  "type": "Microsoft.Compute/images",
  "location": "West US",
  "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"
  }
}

Definiciones

Nombre	Description
ApiError	Error de api.
ApiErrorBase	Base de errores de api.
CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. Los valores predeterminados son: None para standard storage. ReadOnly para Premium Storage.
CloudError	Respuesta de error del servicio Compute.
DiskEncryptionSetParameters	Describe el parámetro del identificador de recurso del conjunto de cifrado de disco administrado por el cliente que se puede especificar para el disco. Nota: El identificador de recurso del conjunto de cifrado de disco solo se puede especificar para el disco administrado. https://aka.ms/mdssewithcmkoverview Consulte para obtener más detalles.
ExtendedLocation	Tipo complejo de la ubicación extendida.
ExtendedLocationTypes	Tipo de la ubicación extendida.
HyperVGenerationTypes	Especifica el HyperVGenerationType del objeto VirtualMachine creado a partir de la imagen. Desde la versión de API 2019-03-01 si el origen de la imagen es un blob, es necesario que el usuario especifique el valor, si el origen es un recurso administrado como disco o instantánea, es posible que sea necesario que el usuario especifique la propiedad si no se puede deducir del recurso administrado de origen.
Image	Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.
ImageDataDisk	Describe un disco de datos.
ImageOSDisk	Describe un disco del sistema operativo.
ImageStorageProfile	Describe un perfil de almacenamiento.
InnerError	Detalles del error interno.
OperatingSystemStateTypes	Estado del sistema operativo. En el caso de las imágenes administradas, use Generalizado.
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.
StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.
SubResource

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 determinado.

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 determinado.

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. Los valores predeterminados son: None para standard storage. ReadOnly para Premium Storage.

Nombre	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de api.

DiskEncryptionSetParameters

Describe el parámetro del identificador de recurso del conjunto de cifrado de disco administrado por el cliente que se puede especificar para el disco. Nota: El identificador de recurso del conjunto de cifrado de disco solo se puede especificar para el disco administrado. https://aka.ms/mdssewithcmkoverview Consulte para obtener más detalles.

Nombre	Tipo	Description
id	string	Id. de recurso

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 HyperVGenerationType del objeto VirtualMachine creado a partir de la imagen. Desde la versión de API 2019-03-01 si el origen de la imagen es un blob, es necesario que el usuario especifique el valor, si el origen es un recurso administrado como disco o instantánea, es posible que sea necesario que el usuario especifique la propiedad si no se puede deducir del recurso administrado de origen.

Nombre	Tipo	Description
V1	string
V2	string

Image

Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.

Nombre	Tipo	Description
extendedLocation	ExtendedLocation	Ubicación extendida de la imagen.
id	string	Id. de recurso
location	string	Ubicación de los recursos
name	string	Nombre del recurso
properties.hyperVGeneration	HyperVGenerationTypes	Especifica el HyperVGenerationType del objeto VirtualMachine creado a partir de la imagen. Desde la versión de API 2019-03-01 si el origen de la imagen es un blob, es necesario que el usuario especifique el valor, si el origen es un recurso administrado como disco o instantánea, es posible que sea necesario que el usuario especifique la propiedad si no se puede deducir del recurso administrado de origen.
properties.provisioningState	string	Estado de aprovisionamiento.
properties.sourceVirtualMachine	SubResource	Máquina virtual de origen desde la que se crea la imagen.
properties.storageProfile	ImageStorageProfile	Especifica la configuración de almacenamiento de los discos de máquina virtual.
tags	object	Etiquetas del recurso
type	string	Tipo de recurso

ImageDataDisk

Describe un disco de datos.

Nombre	Tipo	Description
blobUri	string	Disco duro virtual.
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. Los valores predeterminados son: None para standard storage. ReadOnly para Premium Storage.
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco de imagen administrada.
diskSizeGB	integer	Especifica el tamaño de los discos de datos vacíos en gigabytes. Este elemento se puede usar para sobrescribir el nombre del disco en una imagen de máquina virtual. Este valor no puede ser mayor que 1023 GB.
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.
managedDisk	SubResource	ManagedDisk.
snapshot	SubResource	Instantánea.
storageAccountType	StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

ImageOSDisk

Describe un disco del sistema operativo.

Nombre	Tipo	Description
blobUri	string	Disco duro virtual.
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. Los valores predeterminados son: None para standard storage. ReadOnly para Premium Storage.
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco de imagen administrada.
diskSizeGB	integer	Especifica el tamaño de los discos de datos vacíos en gigabytes. Este elemento se puede usar para sobrescribir el nombre del disco en una imagen de máquina virtual. Este valor no puede ser mayor que 1023 GB.
managedDisk	SubResource	ManagedDisk.
osState	OperatingSystemStateTypes	Estado del sistema operativo. En el caso de las imágenes administradas, use Generalizado.
osType	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.
snapshot	SubResource	Instantánea.
storageAccountType	StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

ImageStorageProfile

Describe un perfil de almacenamiento.

Nombre	Tipo	Description
dataDisks	ImageDataDisk[]	Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.
osDisk	ImageOSDisk	Especifica información sobre el disco del sistema operativo usado por la máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.
zoneResilient	boolean	Especifica si una imagen es resistente a zonas o no. El valor predeterminado es False. Las imágenes resistentes a zonas solo se pueden crear en regiones que proporcionan almacenamiento con redundancia de zona (ZRS).

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.

OperatingSystemStateTypes

Estado del sistema operativo. En el caso de las imágenes administradas, use Generalizado.

Nombre	Tipo	Description
Generalized	string	Imagen generalizada. Debe aprovisionarse durante el tiempo de implementación.
Specialized	string	Imagen especializada. Contiene el disco del sistema operativo ya aprovisionado.

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.

Nombre	Tipo	Description
Linux	string
Windows	string

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

Nombre	Tipo	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

Nombre	Tipo	Description
id	string	Id. de recurso

Images - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Get information about a virtual machine image.

Sample Request

Sample Response

Definiciones

ApiError

ApiErrorBase

CachingTypes

CloudError

DiskEncryptionSetParameters

ExtendedLocation

ExtendedLocationTypes

HyperVGenerationTypes

Image

ImageDataDisk

ImageOSDisk

ImageStorageProfile

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

StorageAccountTypes

SubResource

Recursos adicionales