Gallery Images - Create Or Update

Service:

Compute

API Version:

2023-07-03

Criar ou atualizar uma definição de imagem de galeria.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
galleryImageName	path	True	string	O nome da definição de imagem da galeria a criar ou atualizar. Os carateres permitidos são alfabetos e números com pontos, traços e períodos permitidos no meio. O comprimento máximo é de 80 carateres.
galleryName	path	True	string	O nome do Shared Image Gallery no qual a Definição de Imagem deve ser criada.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	Localização do recurso
properties.identifier	True	GalleryImageIdentifier	Este é o identificador de definição de imagem da galeria.
properties.osState	True	OperatingSystemStateTypes	Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".
properties.osType	True	OperatingSystemTypes	Esta propriedade permite-lhe especificar o tipo de SO incluído no disco ao criar uma VM a partir de uma imagem gerida. Os valores possíveis são: Windows,Linux.
properties.architecture		Architecture	A arquitetura da imagem. Aplicável apenas a discos do SO.
properties.description		string	A descrição deste recurso de definição de imagem da galeria. Esta propriedade é atualizável.
properties.disallowed		Disallowed	Descreve os tipos de disco não permitidos.
properties.endOfLifeDate		string	A data de fim de vida da definição da imagem da galeria. Esta propriedade pode ser utilizada para fins de desativação. Esta propriedade é atualizável.
properties.eula		string	O contrato Eula para a definição de imagem da galeria.
properties.features		GalleryImageFeature[]	Uma lista de funcionalidades de imagens da galeria.
properties.hyperVGeneration		HyperVGeneration	A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO.
properties.privacyStatementUri		string	O URI da declaração de privacidade.
properties.purchasePlan		ImagePurchasePlan	Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.
properties.recommended		RecommendedMachineConfiguration	As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.
properties.releaseNoteUri		string	O URI da nota de versão.
tags		object	Etiquetas de recursos

Respostas

Name	Tipo	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Criado
202 Accepted	GalleryImage	Aceite
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
Architecture	A arquitetura da imagem. Aplicável apenas a discos do SO.
CloudError	Uma resposta de erro do serviço de Computação.
Disallowed	Descreve os tipos de disco não permitidos.
GalleryImage	Especifica informações sobre a definição de imagem da galeria que pretende criar ou atualizar.
GalleryImageFeature	Uma funcionalidade para a imagem da galeria.
GalleryImageIdentifier	Este é o identificador de definição de imagem da galeria.
GalleryProvisioningState	O estado atual da galeria ou artefacto da galeria.
HyperVGeneration	A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO.
ImagePurchasePlan	Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.
InnerError	Detalhes do erro interno.
OperatingSystemStateTypes	Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".
OperatingSystemTypes	Esta propriedade permite-lhe especificar o tipo suportado do SO para o qual a aplicação foi criada. Os valores possíveis são: Windows,Linux.
RecommendedMachineConfiguration	As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.
ResourceRange	Descreve o intervalo de recursos.

ApiError

Erro de API.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

Architecture

A arquitetura da imagem. Aplicável apenas a discos do SO.

Name	Tipo	Description
Arm64	string
x64	string

CloudError

Uma resposta de erro do serviço de Computação.

Name	Tipo	Description
error	ApiError	Erro de API.

Disallowed

Descreve os tipos de disco não permitidos.

Name	Tipo	Description
diskTypes	string[]	Uma lista de tipos de disco.

GalleryImage

Especifica informações sobre a definição de imagem da galeria que pretende criar ou atualizar.

Name	Tipo	Description
id	string	ID do Recurso
location	string	Localização do recurso
name	string	Nome do recurso
properties.architecture	Architecture	A arquitetura da imagem. Aplicável apenas a discos do SO.
properties.description	string	A descrição deste recurso de definição de imagem da galeria. Esta propriedade é atualizável.
properties.disallowed	Disallowed	Descreve os tipos de disco não permitidos.
properties.endOfLifeDate	string	A data de fim de vida da definição da imagem da galeria. Esta propriedade pode ser utilizada para fins de desativação. Esta propriedade é atualizável.
properties.eula	string	O contrato Eula para a definição de imagem da galeria.
properties.features	GalleryImageFeature[]	Uma lista de funcionalidades de imagens da galeria.
properties.hyperVGeneration	HyperVGeneration	A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO.
properties.identifier	GalleryImageIdentifier	Este é o identificador de definição de imagem da galeria.
properties.osState	OperatingSystemStateTypes	Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".
properties.osType	OperatingSystemTypes	Esta propriedade permite-lhe especificar o tipo de SO incluído no disco ao criar uma VM a partir de uma imagem gerida. Os valores possíveis são: Windows,Linux.
properties.privacyStatementUri	string	O URI da declaração de privacidade.
properties.provisioningState	GalleryProvisioningState	O estado atual da galeria ou artefacto da galeria. O estado de aprovisionamento, que só aparece na resposta.
properties.purchasePlan	ImagePurchasePlan	Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.
properties.recommended	RecommendedMachineConfiguration	As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.
properties.releaseNoteUri	string	O URI da nota de versão.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

GalleryImageFeature

Uma funcionalidade para a imagem da galeria.

Name	Tipo	Description
name	string	O nome da funcionalidade de imagem da galeria.
value	string	O valor da funcionalidade de imagem da galeria.

GalleryImageIdentifier

Este é o identificador de definição de imagem da galeria.

Name	Tipo	Description
offer	string	O nome da oferta de definição de imagem da galeria.
publisher	string	O nome do publicador de definições de imagem da galeria.
sku	string	O nome do SKU de definição de imagem da galeria.

GalleryProvisioningState

O estado atual da galeria ou artefacto da galeria.

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

HyperVGeneration

A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO.

Name	Tipo	Description
V1	string
V2	string

ImagePurchasePlan

Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.

Name	Tipo	Description
name	string	O ID do plano.
product	string	O ID do produto.
publisher	string	O ID do editor.

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou a informação de falha de sistema da exceção.
exceptiontype	string	O tipo de exceção.

OperatingSystemStateTypes

Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".

Name	Tipo	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Esta propriedade permite-lhe especificar o tipo suportado do SO para o qual a aplicação foi criada. Os valores possíveis são: Windows,Linux.

Name	Tipo	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.

Name	Tipo	Description
memory	ResourceRange	Descreve o intervalo de recursos.
vCPUs	ResourceRange	Descreve o intervalo de recursos.

ResourceRange

Descreve o intervalo de recursos.

Name	Tipo	Description
max	integer	O número máximo do recurso.
min	integer	O número mínimo do recurso.