Gallery Images - Create Or Update

Servizio:

Compute

Versione API:

2024-03-03

Creare o aggiornare una definizione di immagine della raccolta.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
galleryImageName	path	True	string	Nome della definizione dell'immagine della raccolta da creare o aggiornare. I caratteri consentiti sono alfabeti e numeri con punti, trattini e punti consentiti al centro. La lunghezza massima è di 80 caratteri.
galleryName	path	True	string	Nome della raccolta di immagini condivise in cui deve essere creata la definizione dell'immagine.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso risorsa
properties.identifier	True	GalleryImageIdentifier	Si tratta dell'identificatore di definizione dell'immagine della raccolta.
properties.osState	True	OperatingSystemStateTypes	Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specialized".
properties.osType	True	OperatingSystemTypes	Questa proprietà consente di specificare il tipo di sistema operativo incluso nel disco durante la creazione di una macchina virtuale da un'immagine gestita. I valori possibili sono: Windows,Linux.
properties.allowUpdateImage		boolean	Opzionale. Deve essere impostato su true se le funzionalità dell'immagine della raccolta vengono aggiornate.
properties.architecture		Architecture	Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.
properties.description		string	Descrizione della risorsa di definizione dell'immagine della raccolta. Questa proprietà è aggiornabile.
properties.disallowed		Disallowed	Descrive i tipi di disco non consentiti.
properties.endOfLifeDate		string	Data di fine vita della definizione dell'immagine della raccolta. Questa proprietà può essere utilizzata per scopi di rimozione delle autorizzazioni. Questa proprietà è aggiornabile.
properties.eula		string	Contratto di licenza per la definizione dell'immagine della raccolta.
properties.features		GalleryImageFeature[]	Elenco delle funzionalità dell'immagine della raccolta.
properties.hyperVGeneration		HyperVGeneration	Generazione dell'hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.
properties.privacyStatementUri		string	URI dell'informativa sulla privacy.
properties.purchasePlan		ImagePurchasePlan	Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del Marketplace.
properties.recommended		RecommendedMachineConfiguration	Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.
properties.releaseNoteUri		string	URI della nota di versione.
tags		object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	GalleryImage	OK
201 Created	GalleryImage	Creato
202 Accepted	GalleryImage	Accettato
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or update a simple gallery image.

Esempio di richiesta

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/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");

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
Architecture	Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.
CloudError	Risposta di errore dal servizio di calcolo.
Disallowed	Descrive i tipi di disco non consentiti.
GalleryImage	Specifica informazioni sulla definizione dell'immagine della raccolta che si desidera creare o aggiornare.
GalleryImageFeature	Funzionalità per l'immagine della raccolta.
GalleryImageIdentifier	Si tratta dell'identificatore di definizione dell'immagine della raccolta.
GalleryProvisioningState	Stato corrente dell'artefatto della raccolta o della raccolta.
HyperVGeneration	Generazione dell'hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.
ImagePurchasePlan	Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del Marketplace.
InnerError	Dettagli dell'errore interno.
OperatingSystemStateTypes	Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specialized".
OperatingSystemTypes	Questa proprietà consente di specificare il tipo supportato del sistema operativo per cui viene compilata l'applicazione. I valori possibili sono: Windows,Linux.
RecommendedMachineConfiguration	Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.
ResourceRange	Descrive l'intervallo di risorse.

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

Architecture

Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.

Nome	Tipo	Descrizione
Arm64	string
x64	string

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

Disallowed

Descrive i tipi di disco non consentiti.

Nome	Tipo	Descrizione
diskTypes	string[]	Elenco dei tipi di disco.

GalleryImage

Specifica informazioni sulla definizione dell'immagine della raccolta che si desidera creare o aggiornare.

Nome	Tipo	Descrizione
id	string	ID risorsa
location	string	Percorso risorsa
name	string	Nome risorsa
properties.allowUpdateImage	boolean	Opzionale. Deve essere impostato su true se le funzionalità dell'immagine della raccolta vengono aggiornate.
properties.architecture	Architecture	Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.
properties.description	string	Descrizione della risorsa di definizione dell'immagine della raccolta. Questa proprietà è aggiornabile.
properties.disallowed	Disallowed	Descrive i tipi di disco non consentiti.
properties.endOfLifeDate	string	Data di fine vita della definizione dell'immagine della raccolta. Questa proprietà può essere utilizzata per scopi di rimozione delle autorizzazioni. Questa proprietà è aggiornabile.
properties.eula	string	Contratto di licenza per la definizione dell'immagine della raccolta.
properties.features	GalleryImageFeature[]	Elenco delle funzionalità dell'immagine della raccolta.
properties.hyperVGeneration	HyperVGeneration	Generazione dell'hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.
properties.identifier	GalleryImageIdentifier	Si tratta dell'identificatore di definizione dell'immagine della raccolta.
properties.osState	OperatingSystemStateTypes	Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specialized".
properties.osType	OperatingSystemTypes	Questa proprietà consente di specificare il tipo di sistema operativo incluso nel disco durante la creazione di una macchina virtuale da un'immagine gestita. I valori possibili sono: Windows,Linux.
properties.privacyStatementUri	string	URI dell'informativa sulla privacy.
properties.provisioningState	GalleryProvisioningState	Stato corrente dell'artefatto della raccolta o della raccolta. Stato di provisioning, visualizzato solo nella risposta.
properties.purchasePlan	ImagePurchasePlan	Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del Marketplace.
properties.recommended	RecommendedMachineConfiguration	Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.
properties.releaseNoteUri	string	URI della nota di versione.
tags	object	Tag delle risorse
type	string	Tipo di risorsa

GalleryImageFeature

Funzionalità per l'immagine della raccolta.

Nome	Tipo	Descrizione
name	string	Nome della funzionalità di immagine della raccolta.
startsAtVersion	string	Versione minima dell'immagine della raccolta che supporta questa funzionalità.
value	string	Valore della funzionalità di immagine della raccolta.

GalleryImageIdentifier

Si tratta dell'identificatore di definizione dell'immagine della raccolta.

Nome	Tipo	Descrizione
offer	string	Nome dell'offerta di definizione dell'immagine della raccolta.
publisher	string	Nome dell'autore delle definizioni di immagini della raccolta.
sku	string	Nome dello SKU di definizione dell'immagine della raccolta.

GalleryProvisioningState

Stato corrente dell'artefatto della raccolta o della raccolta.

Nome	Tipo	Descrizione
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Generazione dell'hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.

Nome	Tipo	Descrizione
V1	string
V2	string

ImagePurchasePlan

Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del Marketplace.

Nome	Tipo	Descrizione
name	string	ID del piano.
product	string	ID prodotto.
publisher	string	ID editore.

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

OperatingSystemStateTypes

Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specialized".

Nome	Tipo	Descrizione
Generalized	string
Specialized	string

OperatingSystemTypes

Questa proprietà consente di specificare il tipo supportato del sistema operativo per cui viene compilata l'applicazione. I valori possibili sono: Windows,Linux.

Nome	Tipo	Descrizione
Linux	string
Windows	string

RecommendedMachineConfiguration

Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.

Nome	Tipo	Descrizione
memory	ResourceRange	Descrive l'intervallo di risorse.
vCPUs	ResourceRange	Descrive l'intervallo di risorse.

ResourceRange

Descrive l'intervallo di risorse.

Nome	Tipo	Descrizione
max	integer	Numero massimo della risorsa.
min	integer	Numero minimo della risorsa.