Virtual Machine Images - Get

Reference

Service:: Compute

API Version:: 2024-03-01

Získá image 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=2024-03-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
location	path	True	string	Název podporované oblasti Azure.
offer	path	True	string	Platná nabídka vydavatele obrázků.
publisherName	path	True	string	Platný vydavatel image.
skus	path	True	string	Platná skladová položka image.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
version	path	True	string	Platná verze skladové položky image.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineImage	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

VirtualMachineImage_Get_MaximumSet_Gen

VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Sample Request

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


/**
 * Samples for VirtualMachineImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImage_Get_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineImageGetMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().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

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: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/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

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

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/ComputeRP/stable/2024-03-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
 */
async function virtualMachineImageGetMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{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);
}

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

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

Sample Request

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


/**
 * Samples for VirtualMachineImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImage_Get_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineImageGetMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().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

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: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/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

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/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.VirtualMachineImage = armcompute.VirtualMachineImage{
	// 	ID: to.Ptr("aaaaaaaaaaa"),
	// 	Name: to.Ptr("aaaaaaaaa"),
	// 	Location: to.Ptr("aaaaa"),
	// }
}

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/ComputeRP/stable/2024-03-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
 */
async function virtualMachineImageGetMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{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);
}

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

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

Definice

Name	Description
AlternativeOption	Popisuje alternativní možnost určenou vydavatelem pro tuto image, když 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	Chybová odpověď ze služby Compute.
DataDiskImage	Obsahuje informace o imagích datových disků.
DisallowedConfiguration	Určuje nepovolenou konfiguraci 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í image na obrázku.
ImageState	Popisuje stav image.
InnerError	Podrobnosti o vnitřní chybě.
OperatingSystemTypes	Operační systém osDiskImage.
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é image.
VmDiskTypes	Typy disků virtuálních počítačů, které jsou zakázány.

AlternativeOption

Popisuje alternativní možnost určenou vydavatelem pro tuto image, když 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. Jedná se o název nabídky, pokud je typ Nabídka, nebo název plánu, pokud je typ Plán.

AlternativeType

Popisuje typ alternativní možnosti.

Name	Typ	Description
None	string
Offer	string
Plan	string

ApiError

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

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

Určuje typ architektury.

Name	Typ	Description
Arm64	string
x64	string

AutomaticOSUpgradeProperties

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

Name	Typ	Description
automaticOSUpgradeSupported	boolean	Určuje, jestli se v imagi podporuje automatický upgrade operačního systému.

CloudError

Chybová odpověď ze služby Compute.

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DataDiskImage

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

Name	Typ	Description
lun	integer	Určuje číslo logické jednotky 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

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

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

ExtendedLocation

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

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

Name	Typ	Description
EdgeZone	string

HyperVGenerationTypes

Určuje typ HyperVGeneration.

Name	Typ	Description
V1	string
V2	string

ImageDeprecationStatus

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

Name	Typ	Description
alternativeOption	AlternativeOption	Popisuje alternativní možnost určenou vydavatelem pro tuto image, když je tato image zastaralá.
imageState	ImageState	Popisuje stav image.
scheduledDeprecationTime	string	V budoucnu bude tento obrázek označen jako zastaralý. Tento naplánovaný čas zvolí vydavatel.

ImageState

Popisuje stav image.

Name	Typ	Description
Active	string
Deprecated	string
ScheduledForDeprecation	string

InnerError

Podrobnosti o vnitřní chybě.

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

OperatingSystemTypes

Operační systém osDiskImage.

Name	Typ	Description
Linux	string
Windows	string

OSDiskImage

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

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

PurchasePlan

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 součin obrázku z marketplace. To je stejná hodnota jako Nabídka v elementu imageReference.
publisher	string	ID vydavatele.