Community Gallery Images - Get

Service:: Compute

API Version:: 2024-03-03

Get a community gallery image.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}?api-version=2024-03-03

URI Parameters

Name	In	Required	Type	Description
galleryImageName	path	True	string	The name of the community gallery image definition.
location	path	True	string minLength: 1	The name of Azure region.
publicGalleryName	path	True	string	The public name of the community gallery.
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	CommunityGalleryImage	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

Get a community gallery image.

Sample request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/myLocation/communityGalleries/publicGalleryName/images/myGalleryImageName?api-version=2024-03-03


/**
 * Samples for CommunityGalleryImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/
     * communityGalleryExamples/CommunityGalleryImage_Get.json
     */
    /**
     * Sample code: Get a community gallery image.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getACommunityGalleryImage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getCommunityGalleryImages().getWithResponse("myLocation",
            "publicGalleryName", "myGalleryImageName", 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

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/communityGalleryExamples/CommunityGalleryImage_Get.json
func ExampleCommunityGalleryImagesClient_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.NewCommunityGalleryImagesClient().Get(ctx, "myLocation", "publicGalleryName", "myGalleryImageName", 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.CommunityGalleryImage = armcompute.CommunityGalleryImage{
	// 	Name: to.Ptr("myGalleryImageName"),
	// 	Type: to.Ptr("Microsoft.Compute/locations/communityGalleryImage"),
	// 	Identifier: &armcompute.CommunityGalleryIdentifier{
	// 		UniqueID: to.Ptr("/CommunityGalleries/publicGalleryName/Images/myGalleryImageName"),
	// 	},
	// 	Location: to.Ptr("myLocation"),
	// 	Properties: &armcompute.CommunityGalleryImageProperties{
	// 		ArtifactTags: map[string]*string{
	// 			"ShareTag-CommunityGallery": to.Ptr("CommunityGallery"),
	// 		},
	// 		Disclaimer: to.Ptr("https://test-uri.com"),
	// 		Eula: to.Ptr("https://test-uri.com"),
	// 		HyperVGeneration: to.Ptr(armcompute.HyperVGenerationV1),
	// 		Identifier: &armcompute.CommunityGalleryImageIdentifier{
	// 			Offer: to.Ptr("myOfferName"),
	// 			Publisher: to.Ptr("myPublisherName"),
	// 			SKU: to.Ptr("mySkuName"),
	// 		},
	// 		OSState: to.Ptr(armcompute.OperatingSystemStateTypesGeneralized),
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 		PrivacyStatementURI: to.Ptr("https://test-uri.com"),
	// 	},
	// }
}

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 Get a community gallery image.
 *
 * @summary Get a community gallery image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json
 */
async function getACommunityGalleryImage() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "myLocation";
  const publicGalleryName = "publicGalleryName";
  const galleryImageName = "myGalleryImageName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.communityGalleryImages.get(
    location,
    publicGalleryName,
    galleryImageName,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json
// this example is just showing the usage of "CommunityGalleryImages_Get" 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 CommunityGalleryResource created on azure
// for more information of creating CommunityGalleryResource, please refer to the document of CommunityGalleryResource
string subscriptionId = "{subscription-id}";
AzureLocation location = new AzureLocation("myLocation");
string publicGalleryName = "publicGalleryName";
ResourceIdentifier communityGalleryResourceId = CommunityGalleryResource.CreateResourceIdentifier(subscriptionId, location, publicGalleryName);
CommunityGalleryResource communityGallery = client.GetCommunityGalleryResource(communityGalleryResourceId);

// get the collection of this CommunityGalleryImageResource
CommunityGalleryImageCollection collection = communityGallery.GetCommunityGalleryImages();

// invoke the operation
string galleryImageName = "myGalleryImageName";
NullableResponse<CommunityGalleryImageResource> response = await collection.GetIfExistsAsync(galleryImageName);
CommunityGalleryImageResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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
    CommunityGalleryImageData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "privacyStatementUri": "https://test-uri.com",
    "eula": "https://test-uri.com",
    "artifactTags": {
      "ShareTag-CommunityGallery": "CommunityGallery"
    },
    "disclaimer": "https://test-uri.com"
  },
  "location": "myLocation",
  "name": "myGalleryImageName",
  "type": "Microsoft.Compute/locations/communityGalleryImage",
  "identifier": {
    "uniqueId": "/CommunityGalleries/publicGalleryName/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.
CommunityGalleryImage	Specifies information about the gallery image definition that you want to create or update.
CommunityGalleryImageIdentifier	This is the community gallery image definition identifier.
Disallowed	Describes the disallowed disk types.
GalleryImageFeature	A feature for gallery image.
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.

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.

CommunityGalleryImage

Object

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

Name	Type	Description
identifier.uniqueId	string	The unique id of this community gallery.
location	string	Resource location
name	string	Resource name
properties.architecture	Architecture	The architecture of the image. Applicable to OS disks only.
properties.artifactTags	object	The artifact tags of a community gallery resource.
properties.disallowed	Disallowed	Describes the disallowed disk types.
properties.disclaimer	string	The disclaimer for a community gallery resource.
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 end-user license agreement for the current community gallery image.
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	CommunityGalleryImageIdentifier	This is the community 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	Privacy statement URI for the current community gallery image.
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.
type	string	Resource type

CommunityGalleryImageIdentifier

Object

This is the community 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.

Disallowed

Object

Describes the disallowed disk types.

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

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.

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.

Share via

Community Gallery Images - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get a community gallery image.

Sample request

Sample response

Definitions

ApiError

ApiErrorBase

Architecture

CloudError

CommunityGalleryImage

CommunityGalleryImageIdentifier

Disallowed

GalleryImageFeature

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange