Virtual Machine Images - List With Properties

Service:: Compute

API Version:: 2024-11-01

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions?api-version=2024-11-01&$expand={$expand}&$top={$top}&$orderby={$orderby}

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of Azure region.
offer	path	True	string	A valid image publisher offer.
publisherName	path	True	string	A valid image publisher.
skus	path	True	string	A valid image SKU.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
$expand	query	True	string	The expand expression to apply on the operation.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$orderby	query		string
$top	query		integer (int32)

Responses

Name	Type	Description
200 OK	VirtualMachineImage[]	The request has succeeded.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VirtualMachineImages_ListWithProperties_MaximumSet

VirtualMachineImages_ListWithProperties_MinimumSet

VirtualMachineImages_ListWithProperties_MaximumSet

Sample request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/eastus/publishers/MicrosoftWindowsServer/artifacttypes/vmimage/offers/WindowsServer/skus/2022-datacenter-azure-edition/versions?api-version=2024-11-01&$expand=Properties&$top=4&$orderby=aa


import com.azure.resourcemanager.compute.models.Expand;

/**
 * Samples for VirtualMachineImages ListWithProperties.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/
     * virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImages_ListWithProperties_MaximumSet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineImagesListWithPropertiesMaximumSet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineImages().listWithProperties("eastus",
            "MicrosoftWindowsServer", "WindowsServer", "2022-datacenter-azure-edition", Expand.PROPERTIES, 4, "aa",
            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_images_list_with_properties_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.list_with_properties(
        location="eastus",
        publisher_name="MicrosoftWindowsServer",
        offer="WindowsServer",
        skus="2022-datacenter-azure-edition",
        expand="Properties",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MaximumSet_Gen.json
func ExampleVirtualMachineImagesClient_NewListWithPropertiesPager_virtualMachineImagesListWithPropertiesMaximumSet() {
	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)
	}
	pager := clientFactory.NewVirtualMachineImagesClient().NewListWithPropertiesPager("eastus", "MicrosoftWindowsServer", "WindowsServer", "2022-datacenter-azure-edition", armcompute.ExpandProperties, &armcompute.VirtualMachineImagesClientListWithPropertiesOptions{Top: to.Ptr[int32](4),
		Orderby: to.Ptr("aa"),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineImagesWithPropertiesListResult = armcompute.VirtualMachineImagesWithPropertiesListResult{
		// 	Value: []*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{
		// 			},
		// 			Properties: &armcompute.VirtualMachineImageProperties{
		// 				Architecture: to.Ptr(armcompute.ArchitectureTypesX64),
		// 				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("MicrosoftWindowsServer"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to
 *
 * @summary
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MaximumSet_Gen.json
 */
async function virtualMachineImagesListWithPropertiesMaximumSet() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "eastus";
  const publisherName = "MicrosoftWindowsServer";
  const offer = "WindowsServer";
  const skus = "2022-datacenter-azure-edition";
  const expand = "Properties";
  const top = 4;
  const orderby = "aa";
  const options = {
    top,
    orderby,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.virtualMachineImages.listWithProperties(
    location,
    publisherName,
    offer,
    skus,
    expand,
    options,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

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/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_ListWithProperties" 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 and iterate over the result
AzureLocation location = new AzureLocation("eastus");
string publisherName = "MicrosoftWindowsServer";
string offer = "WindowsServer";
string skus = "2022-datacenter-azure-edition";
GetVirtualMachineImagesWithPropertiesExpand expand = GetVirtualMachineImagesWithPropertiesExpand.Properties;
SubscriptionResourceGetVirtualMachineImagesWithPropertiesOptions options = new SubscriptionResourceGetVirtualMachineImagesWithPropertiesOptions(location, publisherName, offer, skus, expand) { Top = 4, Orderby = "aa" };
await foreach (VirtualMachineImage item in subscriptionResource.GetVirtualMachineImagesWithPropertiesAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "properties": {
        "plan": {
          "publisher": "MicrosoftWindowsServer",
          "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"
          }
        },
        "architecture": "x64"
      },
      "name": "aaaaaaaaa",
      "location": "aaaaa",
      "tags": {},
      "extendedLocation": {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "type": "EdgeZone"
      },
      "id": "aaaaaaaaaaa"
    }
  ],
  "nextLink": "a://example.com/aaaa"
}

VirtualMachineImages_ListWithProperties_MinimumSet

Sample request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/eastus/publishers/MicrosoftWindowsServer/artifacttypes/vmimage/offers/WindowsServer/skus/2022-datacenter-azure-edition/versions?api-version=2024-11-01&$expand=Properties


import com.azure.resourcemanager.compute.models.Expand;

/**
 * Samples for VirtualMachineImages ListWithProperties.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/
     * virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineImages_ListWithProperties_MinimumSet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineImagesListWithPropertiesMinimumSet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineImages().listWithProperties("eastus",
            "MicrosoftWindowsServer", "WindowsServer", "2022-datacenter-azure-edition", Expand.PROPERTIES, null, 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 virtual_machine_images_list_with_properties_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.list_with_properties(
        location="eastus",
        publisher_name="MicrosoftWindowsServer",
        offer="WindowsServer",
        skus="2022-datacenter-azure-edition",
        expand="Properties",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MinimumSet_Gen.json
func ExampleVirtualMachineImagesClient_NewListWithPropertiesPager_virtualMachineImagesListWithPropertiesMinimumSet() {
	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)
	}
	pager := clientFactory.NewVirtualMachineImagesClient().NewListWithPropertiesPager("eastus", "MicrosoftWindowsServer", "WindowsServer", "2022-datacenter-azure-edition", armcompute.ExpandProperties, &armcompute.VirtualMachineImagesClientListWithPropertiesOptions{Top: nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineImagesWithPropertiesListResult = armcompute.VirtualMachineImagesWithPropertiesListResult{
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to
 *
 * @summary
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MinimumSet_Gen.json
 */
async function virtualMachineImagesListWithPropertiesMinimumSet() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "eastus";
  const publisherName = "MicrosoftWindowsServer";
  const offer = "WindowsServer";
  const skus = "2022-datacenter-azure-edition";
  const expand = "Properties";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.virtualMachineImages.listWithProperties(
    location,
    publisherName,
    offer,
    skus,
    expand,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

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/ComputeRP/stable/2024-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListWithProperties_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_ListWithProperties" 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 and iterate over the result
AzureLocation location = new AzureLocation("eastus");
string publisherName = "MicrosoftWindowsServer";
string offer = "WindowsServer";
string skus = "2022-datacenter-azure-edition";
GetVirtualMachineImagesWithPropertiesExpand expand = GetVirtualMachineImagesWithPropertiesExpand.Properties;
SubscriptionResourceGetVirtualMachineImagesWithPropertiesOptions options = new SubscriptionResourceGetVirtualMachineImagesWithPropertiesOptions(location, publisherName, offer, skus, expand);
await foreach (VirtualMachineImage item in subscriptionResource.GetVirtualMachineImagesWithPropertiesAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{}

Definitions

Name	Description
AlternativeOption	Describes the alternative option specified by the Publisher for this image when this image is deprecated.
AlternativeType	Describes the type of the alternative option.
ApiError	Api error.
ApiErrorBase	Api error base.
ArchitectureTypes	Specifies the Architecture Type
AutomaticOSUpgradeProperties	Describes automatic OS upgrade properties on the image.
CloudError	An error response from the Compute service.
DataDiskImage	Contains the data disk images information.
DisallowedConfiguration	Specifies the disallowed configuration for a virtual machine image.
ExtendedLocation	The complex type of the extended location.
ExtendedLocationTypes	The type of the extended location.
HyperVGenerationTypes	Specifies the HyperVGeneration Type
ImageDeprecationStatus	Describes image deprecation status properties on the image.
ImageState	Describes the state of the image.
InnerError	Inner error details.
OperatingSystemTypes	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.
OSDiskImage	Contains the os disk image information.
PurchasePlan	Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
VirtualMachineImage	Describes a Virtual Machine Image.
VirtualMachineImageFeature	Specifies additional capabilities supported by the image
VmDiskTypes	VM disk types which are disallowed.

AlternativeOption

Object

Describes the alternative option specified by the Publisher for this image when this image is deprecated.

Name	Type	Description
type	AlternativeType	Describes the type of the alternative option.
value	string	Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan.

AlternativeType

Enumeration

Describes the type of the alternative option.

Value	Description
None
Offer
Plan

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

ArchitectureTypes

Enumeration

Specifies the Architecture Type

Value	Description
x64
Arm64

AutomaticOSUpgradeProperties

Object

Describes automatic OS upgrade properties on the image.

Name	Type	Description
automaticOSUpgradeSupported	boolean	Specifies whether automatic OS upgrade is supported on the image.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

DataDiskImage

Object

Contains the data disk images information.

Name	Type	Description
lun	integer (int32)	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

DisallowedConfiguration

Object

Specifies the disallowed configuration for a virtual machine image.

Name	Type	Description
vmDiskType	VmDiskTypes	VM disk types which are disallowed.

ExtendedLocation

Object

The complex type of the extended location.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationTypes	The type of the extended location.

ExtendedLocationTypes

Enumeration

The type of the extended location.

Value	Description
EdgeZone

HyperVGenerationTypes

Enumeration

Specifies the HyperVGeneration Type

Value	Description
V1
V2

ImageDeprecationStatus

Object

Describes image deprecation status properties on the image.

Name	Type	Description
alternativeOption	AlternativeOption	Describes the alternative option specified by the Publisher for this image when this image is deprecated.
imageState	ImageState	Describes the state of the image.
scheduledDeprecationTime	string (date-time)	The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher.

ImageState

Enumeration

Describes the state of the image.

Value	Description
Active
ScheduledForDeprecation
Deprecated

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

OperatingSystemTypes

Enumeration

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.

Value	Description
Windows
Linux

OSDiskImage

Object

Contains the os disk image information.

Name	Type	Description
operatingSystem	OperatingSystemTypes	The operating system of the osDiskImage.

PurchasePlan

Object

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Name	Type	Description
name	string	The plan ID.
product	string	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
publisher	string	The publisher ID.

VirtualMachineImage

Object

Describes a Virtual Machine Image.

Name	Type	Description
extendedLocation	ExtendedLocation	The extended location of the Virtual Machine.
id	string	Resource Id
location	string	The supported Azure location of the resource.
name	string	The name of the resource.
properties.architecture	ArchitectureTypes	Specifies the Architecture Type
properties.automaticOSUpgradeProperties	AutomaticOSUpgradeProperties	Describes automatic OS upgrade properties on the image.
properties.dataDiskImages	DataDiskImage[]	The list of data disk images information.
properties.disallowed	DisallowedConfiguration	Specifies disallowed configuration for the VirtualMachine created from the image
properties.features	VirtualMachineImageFeature[]	Specifies additional capabilities supported by the image
properties.hyperVGeneration	HyperVGenerationTypes	Specifies the HyperVGeneration Type
properties.imageDeprecationStatus	ImageDeprecationStatus	Describes image deprecation status properties on the image.
properties.osDiskImage	OSDiskImage	Contains the os disk image information.
properties.plan	PurchasePlan	Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
tags	object	Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

VirtualMachineImageFeature

Object

Specifies additional capabilities supported by the image

Name	Type	Description
name	string	The name of the feature.
value	string	The corresponding value for the feature.

VmDiskTypes

Enumeration

VM disk types which are disallowed.

Value	Description
None
Unmanaged

Share via

Virtual Machine Images - List With Properties

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

VirtualMachineImages_ListWithProperties_MaximumSet

Sample request

Sample response

VirtualMachineImages_ListWithProperties_MinimumSet

Sample request

Sample response

Definitions

AlternativeOption

AlternativeType

ApiError

ApiErrorBase

ArchitectureTypes

AutomaticOSUpgradeProperties

CloudError

DataDiskImage

DisallowedConfiguration

ExtendedLocation

ExtendedLocationTypes

HyperVGenerationTypes

ImageDeprecationStatus

ImageState

InnerError

OperatingSystemTypes

OSDiskImage

PurchasePlan

VirtualMachineImage

VirtualMachineImageFeature

VmDiskTypes