Gallery Images - Create Or Update

Service:

Compute

API Version:

2023-07-03

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
galleryImageName	path	True	string	O nome da definição de imagem da galeria a ser criada ou atualizada. Os caracteres permitidos são alfabetos e números com pontos, traços e períodos permitidos no meio. O comprimento máximo é de 80 caracteres.
galleryName	path	True	string	O nome do Galeria de Imagens Compartilhadas 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 assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	Localização do recurso
properties.identifier	True	GalleryImageIdentifier	Esse é o identificador de definição de imagem da galeria.
properties.osState	True	OperatingSystemStateTypes	Essa propriedade permite que o usuário especifique se as máquinas virtuais criadas nessa imagem são "Generalizadas" ou "Especializadas".
properties.osType	True	OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco ao criar uma VM de uma imagem gerenciada. Os valores possíveis são: Windows,Linux.
properties.architecture		Architecture	A arquitetura da imagem. Aplicável somente a discos do sistema operacional.
properties.description		string	A descrição deste recurso de definição de imagem da galeria. Essa propriedade é atualizável.
properties.disallowed		Disallowed	Descreve os tipos de disco não permitidos.
properties.endOfLifeDate		string	A data de fim da vida útil da definição de imagem da galeria. Essa propriedade pode ser usada para fins de descomissionamento. Essa propriedade é atualizável.
properties.eula		string	O contrato Eula para a definição de imagem da galeria.
properties.features		GalleryImageFeature[]	Uma lista de recursos de imagem da galeria.
properties.hyperVGeneration		HyperVGeneration	A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional.
properties.privacyStatementUri		string	O URI da política de privacidade.
properties.purchasePlan		ImagePurchasePlan	Descreve o plano de compra de definição de imagem da galeria. Isso é usado por imagens do marketplace.
properties.recommended		RecommendedMachineConfiguration	As propriedades descrevem a configuração de computador recomendada para esta Definição de Imagem. Essas propriedades são atualizáveis.
properties.releaseNoteUri		string	O URI da nota de versão.
tags		object	Marcações de recursos

Respostas

Nome	Tipo	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Criado
202 Accepted	GalleryImage	Aceito
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

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

Nome	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
Architecture	A arquitetura da imagem. Aplicável somente a discos do sistema operacional.
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 você deseja criar ou atualizar.
GalleryImageFeature	Um recurso para imagem da galeria.
GalleryImageIdentifier	Esse é o identificador de definição de imagem da galeria.
GalleryProvisioningState	O estado atual da galeria ou do artefato da galeria.
HyperVGeneration	A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional.
ImagePurchasePlan	Descreve o plano de compra de definição de imagem da galeria. Isso é usado por imagens do marketplace.
InnerError	Detalhes do erro interno.
OperatingSystemStateTypes	Essa propriedade permite que o usuário especifique se as máquinas virtuais criadas nessa imagem são "Generalizadas" ou "Especializadas".
OperatingSystemTypes	Essa propriedade permite que você especifique o tipo com suporte do sistema operacional para o qual o aplicativo foi criado. Os valores possíveis são: Windows,Linux.
RecommendedMachineConfiguration	As propriedades descrevem a configuração de computador recomendada para esta Definição de Imagem. Essas propriedades são atualizáveis.
ResourceRange	Descreve o intervalo de recursos.

ApiError

Erro de API.

Nome	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 de API.

Nome	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 somente a discos do sistema operacional.

Nome	Tipo	Description
Arm64	string
x64	string

CloudError

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

Nome	Tipo	Description
error	ApiError	Erro de API.

Disallowed

Descreve os tipos de disco não permitidos.

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

GalleryImage

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

Nome	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 somente a discos do sistema operacional.
properties.description	string	A descrição deste recurso de definição de imagem da galeria. Essa propriedade é atualizável.
properties.disallowed	Disallowed	Descreve os tipos de disco não permitidos.
properties.endOfLifeDate	string	A data de fim da vida útil da definição de imagem da galeria. Essa propriedade pode ser usada para fins de descomissionamento. Essa propriedade é atualizável.
properties.eula	string	O contrato Eula para a definição de imagem da galeria.
properties.features	GalleryImageFeature[]	Uma lista de recursos de imagem da galeria.
properties.hyperVGeneration	HyperVGeneration	A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional.
properties.identifier	GalleryImageIdentifier	Esse é o identificador de definição de imagem da galeria.
properties.osState	OperatingSystemStateTypes	Essa propriedade permite que o usuário especifique se as máquinas virtuais criadas nessa imagem são "Generalizadas" ou "Especializadas".
properties.osType	OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco ao criar uma VM de uma imagem gerenciada. Os valores possíveis são: Windows,Linux.
properties.privacyStatementUri	string	O URI da política de privacidade.
properties.provisioningState	GalleryProvisioningState	O estado atual da galeria ou do artefato da galeria. O estado de provisionamento, que aparece apenas na resposta.
properties.purchasePlan	ImagePurchasePlan	Descreve o plano de compra de definição de imagem da galeria. Isso é usado por imagens do marketplace.
properties.recommended	RecommendedMachineConfiguration	As propriedades descrevem a configuração de computador recomendada para esta Definição de Imagem. Essas propriedades são atualizáveis.
properties.releaseNoteUri	string	O URI da nota de versão.
tags	object	Marcações de recursos
type	string	Tipo de recurso

GalleryImageFeature

Um recurso para imagem da galeria.

Nome	Tipo	Description
name	string	O nome do recurso de imagem da galeria.
value	string	O valor do recurso de imagem da galeria.

GalleryImageIdentifier

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

Nome	Tipo	Description
offer	string	O nome da oferta de definição de imagem da galeria.
publisher	string	O nome do editor de definição de imagem da galeria.
sku	string	O nome da SKU de definição de imagem da galeria.

GalleryProvisioningState

O estado atual da galeria ou do artefato da galeria.

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

HyperVGeneration

A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional.

Nome	Tipo	Description
V1	string
V2	string

ImagePurchasePlan

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

Nome	Tipo	Description
name	string	A ID do plano.
product	string	A identificação do produto.
publisher	string	A ID do editor.

InnerError

Detalhes do erro interno.

Nome	Tipo	Description
errordetail	string	A mensagem de erro interna ou o despejo de exceção.
exceptiontype	string	O tipo de exceção.

OperatingSystemStateTypes

Essa propriedade permite que o usuário especifique se as máquinas virtuais criadas nessa imagem são "Generalizadas" ou "Especializadas".

Nome	Tipo	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo com suporte do sistema operacional para o qual o aplicativo foi criado. Os valores possíveis são: Windows,Linux.

Nome	Tipo	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

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

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

ResourceRange

Descreve o intervalo de recursos.

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