Gallery Images - List By Gallery

Service:

Compute

API Version:

2024-03-03

List gallery image definitions in a gallery.

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

URI Parameters

Name	In	Required	Type	Description
galleryName	path	True	string	The name of the Shared Image Gallery.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	GalleryImageList	Azure operation completed successfully.
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

List gallery images in a gallery.

Sample request

HTTP

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

Java

/**
 * Samples for GalleryImages ListByGallery.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/
     * GalleryImage_ListByGallery.json
     */
    /**
     * Sample code: List gallery images in a gallery.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listGalleryImagesInAGallery(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getGalleryImages().listByGallery("myResourceGroup",
            "myGalleryName", 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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryImage_ListByGallery.json
func ExampleGalleryImagesClient_NewListByGalleryPager() {
	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.NewGalleryImagesClient().NewListByGalleryPager("myResourceGroup", "myGalleryName", 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.GalleryImageList = armcompute.GalleryImageList{
		// 	Value: []*armcompute.GalleryImage{
		// 		{
		// 			Name: to.Ptr("myGalleryImageName"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armcompute.GalleryImageProperties{
		// 				HyperVGeneration: to.Ptr(armcompute.HyperVGenerationV1),
		// 				Identifier: &armcompute.GalleryImageIdentifier{
		// 					Offer: to.Ptr("myOfferName"),
		// 					Publisher: to.Ptr("myPublisherName"),
		// 					SKU: to.Ptr("mySkuName"),
		// 				},
		// 				OSState: to.Ptr(armcompute.OperatingSystemStateTypesGeneralized),
		// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
		// 				ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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

/**
 * This sample demonstrates how to List gallery image definitions in a gallery.
 *
 * @summary List gallery image definitions in a gallery.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryImage_ListByGallery.json
 */
async function listGalleryImagesInAGallery() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.galleryImages.listByGallery(resourceGroupName, galleryName)) {
    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

dotnet

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.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryImage_ListByGallery.json
// this example is just showing the usage of "GalleryImages_ListByGallery" 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 GalleryResource created on azure
// for more information of creating GalleryResource, please refer to the document of GalleryResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string galleryName = "myGalleryName";
ResourceIdentifier galleryResourceId = GalleryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName);
GalleryResource gallery = client.GetGalleryResource(galleryResourceId);

// get the collection of this GalleryImageResource
GalleryImageCollection collection = gallery.GetGalleryImages();

// invoke the operation and iterate over the result
await foreach (GalleryImageResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    GalleryImageData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName",
      "properties": {
        "osType": "Windows",
        "osState": "Generalized",
        "hyperVGeneration": "V1",
        "identifier": {
          "publisher": "myPublisherName",
          "offer": "myOfferName",
          "sku": "mySkuName"
        },
        "provisioningState": "Succeeded"
      },
      "location": "West US",
      "name": "myGalleryImageName"
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images?$skiptoken=token/Subscriptions/subscriptionId/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName"
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
Architecture	The architecture of the image. Applicable to OS disks only.
CloudError	An error response from the Compute service.
createdByType	The type of identity that created the resource.
Disallowed	Describes the disallowed disk types.
GalleryImage	Specifies information about the gallery image definition that you want to create or update.
GalleryImageFeature	A feature for gallery image.
GalleryImageIdentifier	This is the gallery image definition identifier.
GalleryImageList	The List Gallery Images operation response.
GalleryProvisioningState	The provisioning state, which only appears in the response.
HyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
ImagePurchasePlan	Describes the gallery image definition purchase plan. This is used by marketplace images.
InnerError	Inner error details.
OperatingSystemStateTypes	This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.
RecommendedMachineConfiguration	The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
ResourceRange	Describes the resource range.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

Architecture

Enumeration

The architecture of the image. Applicable to OS disks only.

Value	Description
x64
Arm64

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Disallowed

Object

Describes the disallowed disk types.

Name	Type	Description
diskTypes	string[]	A list of disk types.

GalleryImage

Object

Specifies information about the gallery image definition that you want to create or update.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.allowUpdateImage	boolean	Optional. Must be set to true if the gallery image features are being updated.
properties.architecture	Architecture	The architecture of the image. Applicable to OS disks only.
properties.description	string	The description of this gallery image definition resource. This property is updatable.
properties.disallowed	Disallowed	Describes the disallowed disk types.
properties.endOfLifeDate	string (date-time)	The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
properties.eula	string	The Eula agreement for the gallery image definition.
properties.features	GalleryImageFeature[]	A list of gallery image features.
properties.hyperVGeneration	HyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
properties.identifier	GalleryImageIdentifier	This is the gallery image definition identifier.
properties.osState	OperatingSystemStateTypes	This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
properties.osType	OperatingSystemTypes	This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
properties.privacyStatementUri	string	The privacy statement uri.
properties.provisioningState	GalleryProvisioningState	The provisioning state, which only appears in the response.
properties.purchasePlan	ImagePurchasePlan	Describes the gallery image definition purchase plan. This is used by marketplace images.
properties.recommended	RecommendedMachineConfiguration	The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
properties.releaseNoteUri	string	The release note uri.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GalleryImageFeature

Object

A feature for gallery image.

Name	Type	Description
name	string	The name of the gallery image feature.
startsAtVersion	string	The minimum gallery image version which supports this feature.
value	string	The value of the gallery image feature.

GalleryImageIdentifier

Object

This is the gallery image definition identifier.

Name	Type	Description
offer	string	The name of the gallery image definition offer.
publisher	string	The name of the gallery image definition publisher.
sku	string	The name of the gallery image definition SKU.

GalleryImageList

Object

The List Gallery Images operation response.

Name	Type	Description
nextLink	string (uri)	The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions.
value	GalleryImage[]	A list of Shared Image Gallery images.

GalleryProvisioningState

Enumeration

The provisioning state, which only appears in the response.

Value	Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

HyperVGeneration

Enumeration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

Value	Description
V1
V2

ImagePurchasePlan

Object

Describes the gallery image definition purchase plan. This is used by marketplace images.

Name	Type	Description
name	string	The plan ID.
product	string	The product ID.
publisher	string	The publisher ID.

InnerError

Object

Inner error details.

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

OperatingSystemStateTypes

Enumeration

This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.

Value	Description
Generalized
Specialized

OperatingSystemTypes

Enumeration

This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.

Value	Description
Windows
Linux

RecommendedMachineConfiguration

Object

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

Name	Type	Description
memory	ResourceRange	Describes the resource range.
vCPUs	ResourceRange	Describes the resource range.

ResourceRange

Object

Describes the resource range.

Name	Type	Description
max	integer (int32)	The maximum number of the resource.
min	integer (int32)	The minimum number of the resource.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.