Gallery Images - Create Or Update

Service:

Compute

Version d'API:

2024-03-03

Créez ou mettez à jour une définition d’image de galerie.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
galleryImageName	path	True	string	Nom de la définition d’image de la galerie à créer ou à mettre à jour. Les caractères autorisés sont des alphabets et des nombres avec des points, des tirets et des points autorisés au milieu. La longueur maximale est de 80 caractères.
galleryName	path	True	string	Nom de la galerie d’images partagées dans laquelle la définition d’image doit être créée.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement des ressources
properties.identifier	True	GalleryImageIdentifier	Il s’agit de l’identificateur de définition d’image de la galerie.
properties.osState	True	OperatingSystemStateTypes	Cette propriété permet à l’utilisateur de spécifier si les machines virtuelles créées sous cette image sont « généralisées » ou « Spécialisées ».
properties.osType	True	OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque lors de la création d’une machine virtuelle à partir d’une image managée. Les valeurs possibles sont : Windows,Linux.
properties.allowUpdateImage		boolean	Optionnel. Doit être défini sur true si les fonctionnalités d’image de la galerie sont mises à jour.
properties.architecture		Architecture	Architecture de l’image. Applicable uniquement aux disques du système d’exploitation.
properties.description		string	Description de cette ressource de définition d’image de galerie. Cette propriété est pouvant être mise à jour.
properties.disallowed		Disallowed	Décrit les types de disques non autorisés.
properties.endOfLifeDate		string	Date de fin de vie de la définition d’image de la galerie. Cette propriété peut être utilisée à des fins de désaffectation. Cette propriété est pouvant être mise à jour.
properties.eula		string	Accord Eula pour la définition d’image de la galerie.
properties.features		GalleryImageFeature[]	Liste des fonctionnalités d’image de la galerie.
properties.hyperVGeneration		HyperVGeneration	Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation.
properties.privacyStatementUri		string	URI de déclaration de confidentialité.
properties.purchasePlan		ImagePurchasePlan	Décrit le plan d’achat de définition d’image de la galerie. Cela est utilisé par les images de la Place de marché.
properties.recommended		RecommendedMachineConfiguration	Les propriétés décrivent la configuration de machine recommandée pour cette définition d’image. Ces propriétés sont pouvant être mises à jour.
properties.releaseNoteUri		string	URI de note de publication.
tags		object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	GalleryImage	D’ACCORD
201 Created	GalleryImage	Créé
202 Accepted	GalleryImage	Accepté
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update a simple gallery image.

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName?api-version=2024-03-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/2024-03-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/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-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");
require("dotenv/config");

/**
 * 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/2024-03-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/2024-03-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

Exemple de réponse

Code d’état:

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

Code d’état:

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

Code d’état:

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

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs d’API.
Architecture	Architecture de l’image. Applicable uniquement aux disques du système d’exploitation.
CloudError	Réponse d’erreur du service de calcul.
Disallowed	Décrit les types de disques non autorisés.
GalleryImage	Spécifie des informations sur la définition d’image de la galerie que vous souhaitez créer ou mettre à jour.
GalleryImageFeature	Fonctionnalité pour l’image de la galerie.
GalleryImageIdentifier	Il s’agit de l’identificateur de définition d’image de la galerie.
GalleryProvisioningState	État actuel de la galerie ou de l’artefact de la galerie.
HyperVGeneration	Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation.
ImagePurchasePlan	Décrit le plan d’achat de définition d’image de la galerie. Cela est utilisé par les images de la Place de marché.
InnerError	Détails de l’erreur interne.
OperatingSystemStateTypes	Cette propriété permet à l’utilisateur de spécifier si les machines virtuelles créées sous cette image sont « généralisées » ou « Spécialisées ».
OperatingSystemTypes	Cette propriété vous permet de spécifier le type pris en charge du système d’exploitation pour lequel l’application est créée. Les valeurs possibles sont : Windows,Linux.
RecommendedMachineConfiguration	Les propriétés décrivent la configuration de machine recommandée pour cette définition d’image. Ces propriétés sont pouvant être mises à jour.
ResourceRange	Décrit la plage de ressources.

ApiError

Object

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Object

Base d’erreurs d’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

Architecture

Enumeration

Architecture de l’image. Applicable uniquement aux disques du système d’exploitation.

Valeur	Description
Arm64
x64

CloudError

Object

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

Disallowed

Object

Décrit les types de disques non autorisés.

Nom	Type	Description
diskTypes	string[]	Liste des types de disques.

GalleryImage

Object

Spécifie des informations sur la définition d’image de la galerie que vous souhaitez créer ou mettre à jour.

Nom	Type	Description
id	string	ID de ressource
location	string	Emplacement des ressources
name	string	Nom de la ressource
properties.allowUpdateImage	boolean	Optionnel. Doit être défini sur true si les fonctionnalités d’image de la galerie sont mises à jour.
properties.architecture	Architecture	Architecture de l’image. Applicable uniquement aux disques du système d’exploitation.
properties.description	string	Description de cette ressource de définition d’image de galerie. Cette propriété est pouvant être mise à jour.
properties.disallowed	Disallowed	Décrit les types de disques non autorisés.
properties.endOfLifeDate	string	Date de fin de vie de la définition d’image de la galerie. Cette propriété peut être utilisée à des fins de désaffectation. Cette propriété est pouvant être mise à jour.
properties.eula	string	Accord Eula pour la définition d’image de la galerie.
properties.features	GalleryImageFeature[]	Liste des fonctionnalités d’image de la galerie.
properties.hyperVGeneration	HyperVGeneration	Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation.
properties.identifier	GalleryImageIdentifier	Il s’agit de l’identificateur de définition d’image de la galerie.
properties.osState	OperatingSystemStateTypes	Cette propriété permet à l’utilisateur de spécifier si les machines virtuelles créées sous cette image sont « généralisées » ou « Spécialisées ».
properties.osType	OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque lors de la création d’une machine virtuelle à partir d’une image managée. Les valeurs possibles sont : Windows,Linux.
properties.privacyStatementUri	string	URI de déclaration de confidentialité.
properties.provisioningState	GalleryProvisioningState	État actuel de la galerie ou de l’artefact de la galerie. État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.purchasePlan	ImagePurchasePlan	Décrit le plan d’achat de définition d’image de la galerie. Cela est utilisé par les images de la Place de marché.
properties.recommended	RecommendedMachineConfiguration	Les propriétés décrivent la configuration de machine recommandée pour cette définition d’image. Ces propriétés sont pouvant être mises à jour.
properties.releaseNoteUri	string	URI de note de publication.
tags	object	Balises de ressource
type	string	Type de ressource

GalleryImageFeature

Object

Fonctionnalité pour l’image de la galerie.

Nom	Type	Description
name	string	Nom de la fonctionnalité d’image de la galerie.
startsAtVersion	string	Version minimale de l’image de galerie qui prend en charge cette fonctionnalité.
value	string	Valeur de la fonctionnalité d’image de la galerie.

GalleryImageIdentifier

Object

Il s’agit de l’identificateur de définition d’image de la galerie.

Nom	Type	Description
offer	string	Nom de l’offre de définition d’image de la galerie.
publisher	string	Nom de l’éditeur de définition d’image de la galerie.
sku	string	Nom de la référence SKU de définition d’image de la galerie.

GalleryProvisioningState

Enumeration

État actuel de la galerie ou de l’artefact de la galerie.

Valeur	Description
Creating
Deleting
Failed
Migrating
Succeeded
Updating

HyperVGeneration

Enumeration

Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation.

Valeur	Description
V1
V2

ImagePurchasePlan

Object

Décrit le plan d’achat de définition d’image de la galerie. Cela est utilisé par les images de la Place de marché.

Nom	Type	Description
name	string	ID du plan.
product	string	ID de produit.
publisher	string	ID de l’éditeur.

InnerError

Object

Détails de l’erreur interne.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d’exception.

OperatingSystemStateTypes

Enumeration

Cette propriété permet à l’utilisateur de spécifier si les machines virtuelles créées sous cette image sont « généralisées » ou « Spécialisées ».

Valeur	Description
Generalized
Specialized

OperatingSystemTypes

Enumeration

Cette propriété vous permet de spécifier le type pris en charge du système d’exploitation pour lequel l’application est créée. Les valeurs possibles sont : Windows,Linux.

Valeur	Description
Linux
Windows

RecommendedMachineConfiguration

Object

Les propriétés décrivent la configuration de machine recommandée pour cette définition d’image. Ces propriétés sont pouvant être mises à jour.

Nom	Type	Description
memory	ResourceRange	Décrit la plage de ressources.
vCPUs	ResourceRange	Décrit la plage de ressources.

ResourceRange

Object

Décrit la plage de ressources.

Nom	Type	Description
max	integer	Nombre maximal de la ressource.
min	integer	Nombre minimal de la ressource.