Gallery Images - Create Or Update

Başvuru

Hizmet:: Compute

API Sürümü:: 2023-07-03

Galeri görüntüsü tanımı oluşturun veya güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
galleryImageName	path	True	string	Oluşturulacak veya güncelleştirilecek galeri görüntüsü tanımının adı. İzin verilen karakterler, ortada nokta, tire ve nokta izin verilen alfabeler ve sayılardır. Uzunluk üst sınırı 80 karakterdir.
galleryName	path	True	string	Görüntü Tanımının oluşturulacağı Paylaşılan Görüntü Galerisi'nin adı.
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynak konumu
properties.identifier	True	GalleryImageIdentifier	Bu, galeri görüntüsü tanımı tanımlayıcısıdır.
properties.osState	True	OperatingSystemStateTypes	Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.
properties.osType	True	OperatingSystemTypes	Bu özellik, yönetilen bir görüntüden VM oluştururken diske dahil edilen işletim sisteminin türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.
properties.architecture		Architecture	Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.description		string	Bu galeri resim tanımı kaynağının açıklaması. Bu özellik güncelleştirilebilir.
properties.disallowed		Disallowed	İzin verilmeyen disk türlerini açıklar.
properties.endOfLifeDate		string	Galeri görüntüsü tanımının kullanım ömrü sonu tarihi. Bu özellik, yetkisini alma amacıyla kullanılabilir. Bu özellik güncelleştirilebilir.
properties.eula		string	Galeri görüntüsü tanımı için Eula sözleşmesi.
properties.features		GalleryImageFeature[]	Galeri görüntüsü özelliklerinin listesi.
properties.hyperVGeneration		HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.privacyStatementUri		string	Gizlilik bildirimi uri'sini seçin.
properties.purchasePlan		ImagePurchasePlan	Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.
properties.recommended		RecommendedMachineConfiguration	Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.
properties.releaseNoteUri		string	Sürüm notu uri'si.
tags		object	Kaynak etiketleri

Yanıtlar

Name	Tür	Description
200 OK	GalleryImage	TAMAM
201 Created	GalleryImage	Oluşturulan
202 Accepted	GalleryImage	Kabul
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create or update a simple gallery image.

Örnek isteği

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


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

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

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

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

Örnek yanıt

Durum kodu:: 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"
}

Durum kodu:: 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"
}

Durum kodu:: 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"
}

Tanımlar

Name	Description
ApiError	API hatası.
ApiErrorBase	Api hata tabanı.
Architecture	Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.
CloudError	İşlem hizmetinden bir hata yanıtı.
Disallowed	İzin verilmeyen disk türlerini açıklar.
GalleryImage	Oluşturmak veya güncelleştirmek istediğiniz galeri görüntüsü tanımı hakkındaki bilgileri belirtir.
GalleryImageFeature	Galeri görüntüsü için bir özellik.
GalleryImageIdentifier	Bu, galeri görüntüsü tanımı tanımlayıcısıdır.
GalleryProvisioningState	Galerinin veya galeri yapıtının geçerli durumu.
HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.
ImagePurchasePlan	Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.
InnerError	İç hata ayrıntıları.
OperatingSystemStateTypes	Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.
OperatingSystemTypes	Bu özellik, uygulamanın oluşturulduğu işletim sisteminin desteklenen türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.
RecommendedMachineConfiguration	Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.
ResourceRange	Kaynak aralığını açıklar.

ApiError

API hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

Architecture

Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.

Name	Tür	Description
Arm64	string
x64	string

CloudError

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	API hatası.

Disallowed

İzin verilmeyen disk türlerini açıklar.

Name	Tür	Description
diskTypes	string[]	Disk türlerinin listesi.

GalleryImage

Oluşturmak veya güncelleştirmek istediğiniz galeri görüntüsü tanımı hakkındaki bilgileri belirtir.

Name	Tür	Description
id	string	Kaynak Kimliği
location	string	Kaynak konumu
name	string	Kaynak adı
properties.architecture	Architecture	Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.description	string	Bu galeri resim tanımı kaynağının açıklaması. Bu özellik güncelleştirilebilir.
properties.disallowed	Disallowed	İzin verilmeyen disk türlerini açıklar.
properties.endOfLifeDate	string	Galeri görüntüsü tanımının kullanım ömrü sonu tarihi. Bu özellik, yetkisini alma amacıyla kullanılabilir. Bu özellik güncelleştirilebilir.
properties.eula	string	Galeri görüntüsü tanımı için Eula sözleşmesi.
properties.features	GalleryImageFeature[]	Galeri görüntüsü özelliklerinin listesi.
properties.hyperVGeneration	HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.identifier	GalleryImageIdentifier	Bu, galeri görüntüsü tanımı tanımlayıcısıdır.
properties.osState	OperatingSystemStateTypes	Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.
properties.osType	OperatingSystemTypes	Bu özellik, yönetilen bir görüntüden VM oluştururken diske dahil edilen işletim sisteminin türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.
properties.privacyStatementUri	string	Gizlilik bildirimi uri'sini seçin.
properties.provisioningState	GalleryProvisioningState	Galerinin veya galeri yapıtının geçerli durumu. Yalnızca yanıtta görünen sağlama durumu.
properties.purchasePlan	ImagePurchasePlan	Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.
properties.recommended	RecommendedMachineConfiguration	Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.
properties.releaseNoteUri	string	Sürüm notu uri'si.
tags	object	Kaynak etiketleri
type	string	Kaynak türü

GalleryImageFeature

Galeri görüntüsü için bir özellik.

Name	Tür	Description
name	string	Galeri görüntüsü özelliğinin adı.
value	string	Galeri görüntüsü özelliğinin değeri.

GalleryImageIdentifier

Bu, galeri görüntüsü tanımı tanımlayıcısıdır.

Name	Tür	Description
offer	string	Galeri görüntüsü tanımı teklifinin adı.
publisher	string	Galeri görüntüsü tanımı yayımcısının adı.
sku	string	Galeri görüntüsü tanımı SKU'sunun adı.

GalleryProvisioningState

Galerinin veya galeri yapıtının geçerli durumu.

Name	Tür	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.

Name	Tür	Description
V1	string
V2	string

ImagePurchasePlan

Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.

Name	Tür	Description
name	string	Plan kimliği.
product	string	Ürün kimliği.
publisher	string	Yayımcı kimliği.

InnerError

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

OperatingSystemStateTypes

Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.

Name	Tür	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Bu özellik, uygulamanın oluşturulduğu işletim sisteminin desteklenen türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.

Name	Tür	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.

Name	Tür	Description
memory	ResourceRange	Kaynak aralığını açıklar.
vCPUs	ResourceRange	Kaynak aralığını açıklar.

ResourceRange

Kaynak aralığını açıklar.

Name	Tür	Description
max	integer	Kaynağın en fazla sayısı.
min	integer	Kaynağın en az sayısı.

Aracılığıyla paylaş

Gallery Images - Create Or Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

Create or update a simple gallery image.

Örnek isteği

Örnek yanıt

Tanımlar

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

Ek kaynaklar