Gallery Images - Create Or Update

Service:

Compute

API Version:

2023-07-03

Cree o actualice una definición de imagen de la galería.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
galleryImageName	path	True	string	Nombre de la definición de imagen de la galería que se va a crear o actualizar. Los caracteres permitidos son alfabetos y números con puntos, guiones y puntos permitidos en el medio. La longitud máxima es de 80 caracteres.
galleryName	path	True	string	Nombre del Shared Image Gallery en el que se va a crear la definición de imagen.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación de los recursos
properties.identifier	True	GalleryImageIdentifier	Se trata del identificador de definición de imagen de la galería.
properties.osState	True	OperatingSystemStateTypes	Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".
properties.osType	True	OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco al crear una máquina virtual a partir de una imagen administrada. Los valores posibles son: Windows,Linux.
properties.architecture		Architecture	Arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.
properties.description		string	Descripción de este recurso de definición de imagen de la galería. Esta propiedad es actualizable.
properties.disallowed		Disallowed	Describe los tipos de disco no permitidos.
properties.endOfLifeDate		string	Fecha de finalización del ciclo de vida de la definición de la imagen de la galería. Esta propiedad se puede usar con fines de retirada. Esta propiedad es actualizable.
properties.eula		string	Contrato eula para la definición de imagen de la galería.
properties.features		GalleryImageFeature[]	Lista de características de imagen de la galería.
properties.hyperVGeneration		HyperVGeneration	Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.
properties.privacyStatementUri		string	El URI de la declaración de privacidad.
properties.purchasePlan		ImagePurchasePlan	Describe el plan de compra de la definición de imagen de la galería. Esto lo usan las imágenes de Marketplace.
properties.recommended		RecommendedMachineConfiguration	Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.
properties.releaseNoteUri		string	El URI de la nota de versión.
tags		object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	GalleryImage	Aceptar
201 Created	GalleryImage	Creado
202 Accepted	GalleryImage	Aceptado
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Compute;
using Azure.ResourceManager.Compute.Models;

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

Definiciones

Nombre	Description
ApiError	Error de api.
ApiErrorBase	Base de errores de api.
Architecture	Arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.
CloudError	Respuesta de error del servicio Compute.
Disallowed	Describe los tipos de disco no permitidos.
GalleryImage	Especifica información sobre la definición de imagen de la galería que desea crear o actualizar.
GalleryImageFeature	Característica de la imagen de la galería.
GalleryImageIdentifier	Se trata del identificador de definición de imagen de la galería.
GalleryProvisioningState	Estado actual de la galería o del artefacto de la galería.
HyperVGeneration	Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.
ImagePurchasePlan	Describe el plan de compra de la definición de imagen de la galería. Esto lo usan las imágenes de Marketplace.
InnerError	Detalles del error interno.
OperatingSystemStateTypes	Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".
OperatingSystemTypes	Esta propiedad permite especificar el tipo admitido del sistema operativo para el que se compila la aplicación. Los valores posibles son: Windows,Linux.
RecommendedMachineConfiguration	Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.
ResourceRange	Describe el intervalo de recursos.

ApiError

Error de api.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	El mensaje de error.
target	string	Destino del error determinado.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error determinado.

Architecture

Arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.

Nombre	Tipo	Description
Arm64	string
x64	string

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de api.

Disallowed

Describe los tipos de disco no permitidos.

Nombre	Tipo	Description
diskTypes	string[]	Lista de tipos de disco.

GalleryImage

Especifica información sobre la definición de imagen de la galería que desea crear o actualizar.

Nombre	Tipo	Description
id	string	Id. de recurso
location	string	Ubicación de los recursos
name	string	Nombre del recurso
properties.architecture	Architecture	Arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.
properties.description	string	Descripción de este recurso de definición de imagen de la galería. Esta propiedad es actualizable.
properties.disallowed	Disallowed	Describe los tipos de disco no permitidos.
properties.endOfLifeDate	string	Fecha de finalización del ciclo de vida de la definición de la imagen de la galería. Esta propiedad se puede usar con fines de retirada. Esta propiedad es actualizable.
properties.eula	string	Contrato eula para la definición de imagen de la galería.
properties.features	GalleryImageFeature[]	Lista de características de imagen de la galería.
properties.hyperVGeneration	HyperVGeneration	Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.
properties.identifier	GalleryImageIdentifier	Se trata del identificador de definición de imagen de la galería.
properties.osState	OperatingSystemStateTypes	Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".
properties.osType	OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco al crear una máquina virtual a partir de una imagen administrada. Los valores posibles son: Windows,Linux.
properties.privacyStatementUri	string	El URI de la declaración de privacidad.
properties.provisioningState	GalleryProvisioningState	Estado actual de la galería o del artefacto de la galería. Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.purchasePlan	ImagePurchasePlan	Describe el plan de compra de la definición de imagen de la galería. Esto lo usan las imágenes de Marketplace.
properties.recommended	RecommendedMachineConfiguration	Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.
properties.releaseNoteUri	string	El URI de la nota de versión.
tags	object	Etiquetas del recurso
type	string	Tipo de recurso

GalleryImageFeature

Característica de la imagen de la galería.

Nombre	Tipo	Description
name	string	Nombre de la característica de imagen de la galería.
value	string	Valor de la característica de imagen de la galería.

GalleryImageIdentifier

Se trata del identificador de definición de imagen de la galería.

Nombre	Tipo	Description
offer	string	Nombre de la oferta de definición de imagen de la galería.
publisher	string	Nombre del publicador de definición de imágenes de la galería.
sku	string	Nombre de la SKU de definición de imagen de la galería.

GalleryProvisioningState

Estado actual de la galería o del artefacto de la galería.

Nombre	Tipo	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.

Nombre	Tipo	Description
V1	string
V2	string

ImagePurchasePlan

Describe el plan de compra de la definición de imagen de la galería. Esto lo usan las imágenes de Marketplace.

Nombre	Tipo	Description
name	string	Identificador del plan.
product	string	Id. de producto.
publisher	string	Identificador del publicador.

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de la excepción.

OperatingSystemStateTypes

Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".

Nombre	Tipo	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Esta propiedad permite especificar el tipo admitido del sistema operativo para el que se compila la aplicación. Los valores posibles son: Windows,Linux.

Nombre	Tipo	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.

Nombre	Tipo	Description
memory	ResourceRange	Describe el intervalo de recursos.
vCPUs	ResourceRange	Describe el intervalo de recursos.

ResourceRange

Describe el intervalo de recursos.

Nombre	Tipo	Description
max	integer	Número máximo del recurso.
min	integer	Número mínimo del recurso.