Gallery Images - Create Or Update

Service:

Compute

API Version:

2023-07-03

Create or update a gallery image definition.

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

URI Parameters

Name	In	Required	Type	Description
galleryImageName	path	True	string	The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
galleryName	path	True	string	The name of the Shared Image Gallery in which the Image Definition is to be created.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
location	True	string	Resource location
properties.identifier	True	GalleryImageIdentifier	This is the gallery image definition identifier.
properties.osState	True	OperatingSystemStateTypes	This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
properties.osType	True	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.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	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.privacyStatementUri		string	The privacy statement uri.
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.
tags		object	Resource tags

Responses

Name	Type	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Created
202 Accepted	GalleryImage	Accepted
Other Status Codes	CloudError	Error response describing why the operation failed.

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

Create or update a simple gallery image.

Sample request

HTTP

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

{
  "location": "West US",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    }
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.GalleryImageInner;
import com.azure.resourcemanager.compute.models.GalleryImageIdentifier;
import com.azure.resourcemanager.compute.models.HyperVGeneration;
import com.azure.resourcemanager.compute.models.OperatingSystemStateTypes;
import com.azure.resourcemanager.compute.models.OperatingSystemTypes;

/**
 * Samples for GalleryImages CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/
     * GalleryImage_Create.json
     */
    /**
     * Sample code: Create or update a simple gallery image.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateASimpleGalleryImage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getGalleryImages().createOrUpdate(
            "myResourceGroup", "myGalleryName", "myGalleryImageName", new GalleryImageInner().withLocation("West US")
                .withOsType(OperatingSystemTypes.WINDOWS).withOsState(OperatingSystemStateTypes.GENERALIZED)
                .withHyperVGeneration(HyperVGeneration.V1).withIdentifier(new GalleryImageIdentifier()
                    .withPublisher("myPublisherName").withOffer("myOfferName").withSku("mySkuName")),
            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/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/c7b98b36e4023331545051284d8500adf98f02fe/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json
func ExampleGalleryImagesClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewGalleryImagesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myGalleryName", "myGalleryImageName", armcompute.GalleryImage{
		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),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.GalleryImage = armcompute.GalleryImage{
	// 	Name: to.Ptr("myGalleryImageName"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/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");

/**
 * This sample demonstrates how to Create or update a gallery image definition.
 *
 * @summary Create or update a gallery image definition.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json
 */
async function createOrUpdateASimpleGalleryImage() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const galleryImageName = "myGalleryImageName";
  const galleryImage = {
    hyperVGeneration: "V1",
    identifier: {
      offer: "myOfferName",
      publisher: "myPublisherName",
      sku: "mySkuName",
    },
    location: "West US",
    osState: "Generalized",
    osType: "Windows",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryImages.beginCreateOrUpdateAndWait(
    resourceGroupName,
    galleryName,
    galleryImageName,
    galleryImage,
  );
  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

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/2023-07-03/examples/galleryExamples/GalleryImage_Create.json
// this example is just showing the usage of "GalleryImages_CreateOrUpdate" 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
string galleryImageName = "myGalleryImageName";
GalleryImageData data = new GalleryImageData(new AzureLocation("West US"))
{
    OSType = SupportedOperatingSystemType.Windows,
    OSState = OperatingSystemStateType.Generalized,
    HyperVGeneration = HyperVGeneration.V1,
    Identifier = new GalleryImageIdentifier("myPublisherName", "myOfferName", "mySkuName"),
};
ArmOperation<GalleryImageResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, galleryImageName, data);
GalleryImageResource result = lro.Value;

// 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
GalleryImageData 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

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

Status code:

201

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

Status code:

202

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "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.
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.
GalleryProvisioningState	The current state of the gallery or gallery artifact.
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

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

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

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

Name	Type	Description
Arm64	string
x64	string

CloudError

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

Disallowed

Describes the disallowed disk types.

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

GalleryImage

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

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
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	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 current state of the gallery or gallery artifact. 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.
tags	object	Resource tags
type	string	Resource type

GalleryImageFeature

A feature for gallery image.

Name	Type	Description
name	string	The name of the gallery image feature.
value	string	The value of the gallery image feature.

GalleryImageIdentifier

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.

GalleryProvisioningState

The current state of the gallery or gallery artifact.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

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

Name	Type	Description
V1	string
V2	string

ImagePurchasePlan

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

Inner error details.

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

OperatingSystemStateTypes

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

Name	Type	Description
Generalized	string
Specialized	string

OperatingSystemTypes

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

Name	Type	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

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

Describes the resource range.

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