Virtual Machine Images - Get

Služba:

Compute

Verze rozhraní API:

2026-03-01

Získá obraz virtuálního počítače.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
location	path	True	string minLength: 1	Název oblasti Azure.
offer	path	True	string	Platná nabídka vydavatele imagí
publisherName	path	True	string	Platný vydavatel image.
skus	path	True	string	Platná skladová položka image.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
version	path	True	string	Platná verze skladové položky image.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineImage	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 služby Azure Active Directory.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	vydávat se za svůj uživatelský účet

Příklady

VirtualMachineImage_Get_MaximumSet_Gen

VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Ukázkový požadavek

HTTP

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=2026-03-01

Java

/**
 * Samples for VirtualMachineImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImage_Get_MaximumSet_Gen.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void virtualMachineImageGetMaximumSetGen(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getVirtualMachineImages().getWithResponse("aaaaaa", "aaa",
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaaaa",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_image_get_maximum_set_gen.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.virtual_machine_images.get(
        location="aaaaaa",
        publisher_name="aaa",
        offer="aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        skus="aaaaaaaaaaaaaaaaaaaaaaaaaaa",
        version="aaaaaaaaaaaaaaaaaaa",
    )
    print(response)


# x-ms-original-file: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.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

Go

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

// Generated from example definition: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
func ExampleVirtualMachineImagesClient_Get_virtualMachineImageGetMaximumSetGen() {
	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.NewVirtualMachineImagesClient().Get(ctx, "aaaaaa", "aaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaaaa", 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 = armcompute.VirtualMachineImagesClientGetResponse{
	// 	VirtualMachineImage: armcompute.VirtualMachineImage{
	// 		Properties: &armcompute.VirtualMachineImageProperties{
	// 			Plan: &armcompute.PurchasePlan{
	// 				Publisher: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
	// 				Name: to.Ptr("aaaaaaaaa"),
	// 				Product: to.Ptr("aaaaaaaaaaaaaa"),
	// 			},
	// 			OSDiskImage: &armcompute.OSDiskImage{
	// 				OperatingSystem: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 			DataDiskImages: []*armcompute.DataDiskImage{
	// 				{
	// 					Lun: to.Ptr[int32](17),
	// 				},
	// 			},
	// 			AutomaticOSUpgradeProperties: &armcompute.AutomaticOSUpgradeProperties{
	// 				AutomaticOSUpgradeSupported: to.Ptr(true),
	// 			},
	// 			HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypesV1),
	// 			Disallowed: &armcompute.DisallowedConfiguration{
	// 				VMDiskType: to.Ptr(armcompute.VMDiskTypesNone),
	// 			},
	// 			Features: []*armcompute.VirtualMachineImageFeature{
	// 				{
	// 					Name: to.Ptr("aaaaaaaaaaaaaaaaaaaaa"),
	// 					Value: to.Ptr("aaaaaaaaaaaaaaaaaaaa"),
	// 				},
	// 			},
	// 			ImageDeprecationStatus: &armcompute.ImageDeprecationStatus{
	// 				ImageState: to.Ptr(armcompute.ImageStateScheduledForDeprecation),
	// 				ScheduledDeprecationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-13T00:00:00+00:00"); return t}()),
	// 				AlternativeOption: &armcompute.AlternativeOption{
	// 					Type: to.Ptr(armcompute.AlternativeTypeOffer),
	// 					Value: to.Ptr("aaaaaaa"),
	// 				},
	// 			},
	// 		},
	// 		Name: to.Ptr("aaaaaaaaa"),
	// 		Location: to.Ptr("aaaaa"),
	// 		Tags: map[string]*string{
	// 			"key6817": to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 		},
	// 		ExtendedLocation: &armcompute.ExtendedLocation{
	// 			Name: to.Ptr("aaaaaaaaaaaaaaaaaaaaa"),
	// 			Type: to.Ptr(armcompute.ExtendedLocationTypesEdgeZone),
	// 		},
	// 		ID: to.Ptr("aaaaaaaaaaa"),
	// 	},
	// }
}

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

JavaScript

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: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
 */
async function virtualMachineImageGetMaximumSetGen() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineImages.get(
    "aaaaaa",
    "aaa",
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "aaaaaaaaaaaaaaaaaaa",
  );
  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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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=2026-03-01

Java

/**
 * Samples for VirtualMachineImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImage_Get_MinimumSet_Gen.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void virtualMachineImageGetMinimumSetGen(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getVirtualMachineImages().getWithResponse("aaaaaaaaaaaa", "aaaaaaaaaaa", "aa",
            "aaaaaaaaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_image_get_minimum_set_gen.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.virtual_machine_images.get(
        location="aaaaaaaaaaaa",
        publisher_name="aaaaaaaaaaa",
        offer="aa",
        skus="aaaaaaaaa",
        version="aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    )
    print(response)


# x-ms-original-file: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.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

Go

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

// Generated from example definition: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
func ExampleVirtualMachineImagesClient_Get_virtualMachineImageGetMinimumSetGen() {
	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.NewVirtualMachineImagesClient().Get(ctx, "aaaaaaaaaaaa", "aaaaaaaaaaa", "aa", "aaaaaaaaa", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 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 = armcompute.VirtualMachineImagesClientGetResponse{
	// 	VirtualMachineImage: armcompute.VirtualMachineImage{
	// 		Name: to.Ptr("aaaaaaaaa"),
	// 		Location: to.Ptr("aaaaa"),
	// 		ID: to.Ptr("aaaaaaaaaaa"),
	// 	},
	// }
}

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

JavaScript

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: 2026-03-01/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
 */
async function virtualMachineImageGetMinimumSetGen() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineImages.get(
    "aaaaaaaaaaaa",
    "aaaaaaaaaaa",
    "aa",
    "aaaaaaaaa",
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  );
  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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AlternativeOption	Popisuje alternativní možnost určenou publisherem pro tento obrázek, pokud je tato image zastaralá.
AlternativeType	Popisuje typ alternativní možnosti.
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
ArchitectureTypes	Určuje typ architektury.
AutomaticOSUpgradeProperties	Popisuje vlastnosti automatického upgradu operačního systému na imagi.
CloudError	Odpověď na chybu z výpočetní služby
DataDiskImage	Obsahuje informace o imagích datových disků.
DisallowedConfiguration	Určuje nepovolenou konfiguraci pro image virtuálního počítače.
ExtendedLocation	Komplexní typ rozšířeného umístění.
ExtendedLocationTypes	Typ rozšířeného umístění.
HyperVGenerationTypes	Určuje typ HyperVGeneration
ImageDeprecationStatus	Popisuje vlastnosti stavu vyřazení obrázku na obrázku.
ImageState	Popisuje stav image.
InnerError	Podrobnosti vnitřní chyby.
OperatingSystemTypes	Tato vlastnost umožňuje určit typ operačního systému, který je součástí disku při vytváření virtuálního počítače z vlastní image. Možné hodnoty jsou: Windows,Linux.
OSDiskImage	Obsahuje informace o imagi disku s operačním systémem.
PurchasePlan	Používá se k vytvoření kontextu nákupu jakéhokoli artefaktu třetí strany prostřednictvím MarketPlace.
VirtualMachineImage	Popisuje image virtuálního počítače.
VirtualMachineImageFeature	Určuje další možnosti podporované imagí.
VmDiskTypes	Typy disků virtuálních počítačů, které nejsou zakázány.

AlternativeOption

Objekt

Popisuje alternativní možnost určenou publisherem pro tento obrázek, pokud je tato image zastaralá.

Name	Typ	Description
type	AlternativeType	Popisuje typ alternativní možnosti.
value	string	Označuje alternativní hodnotu možnosti určenou vydavatelem. Toto je název nabídky, pokud je typ Nabídka nebo Název plánu, pokud je typ Plán.

AlternativeType

Výčet

Popisuje typ alternativní možnosti.

Hodnota	Description
None
Offer
Plan

ApiError

Objekt

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Objekt

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ArchitectureTypes

Výčet

Určuje typ architektury.

Hodnota	Description
x64
Arm64

AutomaticOSUpgradeProperties

Objekt

Popisuje vlastnosti automatického upgradu operačního systému na imagi.

Name	Typ	Description
automaticOSUpgradeSupported	boolean	Určuje, jestli je na imagi podporován automatický upgrade operačního systému.

CloudError

Objekt

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DataDiskImage

Objekt

Obsahuje informace o imagích datových disků.

Name	Typ	Description
lun	integer (int32)	Určuje počet logických jednotek datového disku. Tato hodnota se používá k identifikaci datových disků v rámci virtuálního počítače, a proto musí být jedinečná pro každý datový disk připojený k virtuálnímu počítači.

DisallowedConfiguration

Objekt

Určuje nepovolenou konfiguraci pro image virtuálního počítače.

Name	Typ	Description
vmDiskType	VmDiskTypes	Typy disků virtuálních počítačů, které nejsou zakázány.

ExtendedLocation

Objekt

Komplexní typ rozšířeného umístění.

Name	Typ	Description
name	string	Název rozšířeného umístění.
type	ExtendedLocationTypes	Typ rozšířeného umístění.

ExtendedLocationTypes

Výčet

Typ rozšířeného umístění.

Hodnota	Description
EdgeZone

HyperVGenerationTypes

Výčet

Určuje typ HyperVGeneration

Hodnota	Description
V1
V2

ImageDeprecationStatus

Objekt

Popisuje vlastnosti stavu vyřazení obrázku na obrázku.

Name	Typ	Description
alternativeOption	AlternativeOption	Popisuje alternativní možnost určenou publisherem pro tento obrázek, pokud je tato image zastaralá.
imageState	ImageState	Popisuje stav image.
scheduledDeprecationTime	string (date-time)	V budoucnu bude tento obrázek označený jako zastaralý. Tento naplánovaný čas zvolí Publisher.

ImageState

Výčet

Popisuje stav image.

Hodnota	Description
Active
ScheduledForDeprecation
Deprecated

InnerError

Objekt

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

OperatingSystemTypes

Výčet

Tato vlastnost umožňuje určit typ operačního systému, který je součástí disku při vytváření virtuálního počítače z vlastní image. Možné hodnoty jsou: Windows,Linux.

Hodnota	Description
Windows
Linux

OSDiskImage

Objekt

Obsahuje informace o imagi disku s operačním systémem.

Name	Typ	Description
operatingSystem	OperatingSystemTypes	Operační systém osDiskImage.

PurchasePlan

Objekt

Používá se k vytvoření kontextu nákupu jakéhokoli artefaktu třetí strany prostřednictvím MarketPlace.

Name	Typ	Description
name	string	ID plánu.
product	string	Určuje produkt image z marketplace. Jedná se o stejnou hodnotu jako Offer pod elementem imageReference.
publisher	string	ID vydavatele.

VirtualMachineImage

Objekt

Popisuje image virtuálního počítače.

Name	Typ	Description
extendedLocation	ExtendedLocation	Rozšířené umístění virtuálního počítače.
id	string	ID prostředku
location	string	Podporované umístění prostředku v Azure
name	string	Název zdroje.
properties.architecture	ArchitectureTypes	Určuje typ architektury.
properties.automaticOSUpgradeProperties	AutomaticOSUpgradeProperties	Popisuje vlastnosti automatického upgradu operačního systému na imagi.
properties.dataDiskImages	DataDiskImage[]	Seznam informací o bitových kopiích datových disků.
properties.disallowed	DisallowedConfiguration	Určuje nepovolenou konfiguraci virtuálního počítače vytvořeného z image.
properties.features	VirtualMachineImageFeature[]	Určuje další možnosti podporované imagí.
properties.hyperVGeneration	HyperVGenerationTypes	Určuje typ HyperVGeneration
properties.imageDeprecationStatus	ImageDeprecationStatus	Popisuje vlastnosti stavu vyřazení obrázku na obrázku.
properties.osDiskImage	OSDiskImage	Obsahuje informace o imagi disku s operačním systémem.
properties.plan	PurchasePlan	Používá se k vytvoření kontextu nákupu jakéhokoli artefaktu třetí strany prostřednictvím MarketPlace.
tags	object	Určuje značky, které jsou přiřazeny k virtuálnímu počítači. Další informace o používání značek najdete v tématu Použití značek k uspořádání prostředků Azure.

VirtualMachineImageFeature

Objekt

Určuje další možnosti podporované imagí.

Name	Typ	Description
name	string	Název funkce.
value	string	Odpovídající hodnota funkce.

VmDiskTypes

Výčet

Typy disků virtuálních počítačů, které nejsou zakázány.

Hodnota	Description
None
Unmanaged