Gallery Images - Create Or Update

Referensi

Service:: Compute

API Version:: 2022-01-03

Membuat atau memperbarui definisi gambar galeri.

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

Parameter URI

Name	In	Required	Type	Description
galleryImageName	path	True	string	Nama definisi gambar galeri yang akan dibuat atau diperbarui. Karakter yang diizinkan adalah alfabet dan angka dengan titik, tanda hubung, dan titik yang diizinkan di tengah. Panjang maksimum adalah 80 karakter.
galleryName	path	True	string	Nama Shared Image Gallery tempat Definisi Gambar akan dibuat.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Name	Required	Type	Description
location	True	string	Lokasi sumber daya
properties.identifier	True	GalleryImageIdentifier	Ini adalah pengidentifikasi definisi gambar galeri.
properties.osState	True	OperatingSystemStateTypes	Properti ini memungkinkan pengguna untuk menentukan apakah komputer virtual yang dibuat di bawah gambar ini adalah 'Generalized' atau 'Specialized'.
properties.osType	True	OperatingSystemTypes	Properti ini memungkinkan Anda menentukan jenis OS yang disertakan dalam disk saat membuat VM dari gambar terkelola. Potensi nilai: Windows Linux
properties.architecture		Architecture	Arsitektur gambar. Hanya berlaku untuk disk OS.
properties.description		string	Deskripsi sumber daya definisi gambar galeri ini. Properti ini dapat diperbarui.
properties.disallowed		Disallowed	Menjelaskan jenis disk yang tidak diizinkan.
properties.endOfLifeDate		string	Tanggal akhir masa pakai definisi gambar galeri. Properti ini dapat digunakan untuk tujuan penonaktifan. Properti ini dapat diperbarui.
properties.eula		string	Perjanjian Eula untuk definisi gambar galeri.
properties.features		GalleryImageFeature[]	Daftar fitur gambar galeri.
properties.hyperVGeneration		HyperVGeneration	Generasi hypervisor Komputer Virtual. Hanya berlaku untuk disk OS.
properties.privacyStatementUri		string	Pernyataan privasi uri.
properties.purchasePlan		ImagePurchasePlan	Menjelaskan paket pembelian definisi gambar galeri. Ini digunakan oleh gambar marketplace.
properties.recommended		RecommendedMachineConfiguration	Properti menjelaskan konfigurasi komputer yang direkomendasikan untuk Definisi Gambar ini. Properti ini dapat diperbarui.
properties.releaseNoteUri		string	Catatan rilis uri.
tags		object	Tag sumber daya

Respons

Name	Type	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Dibuat
202 Accepted	GalleryImage	Diterima
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Create or update a simple gallery image.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName?api-version=2022-01-03

{
  "location": "West US",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    }
  }
}

import com.azure.core.util.Context;
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/stable/2022-01-03/GalleryRP/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")),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2022-01-03/GalleryRP/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()
	client, err := armcompute.NewGalleryImagesClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/stable/2022-01-03/GalleryRP/examples/galleryExamples/GalleryImage_Create.json
 */
async function createOrUpdateASimpleGalleryImage() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "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);
}

createOrUpdateASimpleGalleryImage().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

Status code:: 201

{
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

Status code:: 202

{
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

Definisi

ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
Architecture	Arsitektur gambar. Hanya berlaku untuk disk OS.
CloudError	Respons kesalahan dari layanan Komputasi.
Disallowed	Menjelaskan jenis disk yang tidak diizinkan.
GalleryImage	Menentukan informasi tentang definisi gambar galeri yang ingin Anda buat atau perbarui.
GalleryImageFeature	Fitur untuk gambar galeri.
GalleryImageIdentifier	Ini adalah pengidentifikasi definisi gambar galeri.
GalleryProvisioningState	Status galeri atau artefak galeri saat ini.
HyperVGeneration	Generasi hypervisor Komputer Virtual. Hanya berlaku untuk disk OS.
ImagePurchasePlan	Menjelaskan paket pembelian definisi gambar galeri. Ini digunakan oleh gambar marketplace.
InnerError	Detail kesalahan dalam.
OperatingSystemStateTypes	Properti ini memungkinkan pengguna untuk menentukan apakah komputer virtual yang dibuat di bawah gambar ini adalah 'Generalized' atau 'Specialized'.
OperatingSystemTypes	Properti ini memungkinkan Anda menentukan jenis OS yang didukung yang dibangun aplikasinya. Potensi nilai: Windows Linux
RecommendedMachineConfiguration	Properti menjelaskan konfigurasi komputer yang direkomendasikan untuk Definisi Gambar ini. Properti ini dapat diperbarui.
ResourceRange	Menjelaskan rentang sumber daya.

ApiError

Kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

Architecture

Arsitektur gambar. Hanya berlaku untuk disk OS.

Name	Type	Description
Arm64	string
x64	string

CloudError

Respons kesalahan dari layanan Komputasi.

Name	Type	Description
error	ApiError	Kesalahan api.

Disallowed

Menjelaskan jenis disk yang tidak diizinkan.

Name	Type	Description
diskTypes	string[]	Daftar jenis disk.

GalleryImage

Menentukan informasi tentang definisi gambar galeri yang ingin Anda buat atau perbarui.

Name	Type	Description
id	string	ID sumber daya
location	string	Lokasi sumber daya
name	string	Nama sumber daya
properties.architecture	Architecture	Arsitektur gambar. Hanya berlaku untuk disk OS.
properties.description	string	Deskripsi sumber daya definisi gambar galeri ini. Properti ini dapat diperbarui.
properties.disallowed	Disallowed	Menjelaskan jenis disk yang tidak diizinkan.
properties.endOfLifeDate	string	Tanggal akhir masa pakai definisi gambar galeri. Properti ini dapat digunakan untuk tujuan penonaktifan. Properti ini dapat diperbarui.
properties.eula	string	Perjanjian Eula untuk definisi gambar galeri.
properties.features	GalleryImageFeature[]	Daftar fitur gambar galeri.
properties.hyperVGeneration	HyperVGeneration	Generasi hypervisor Komputer Virtual. Hanya berlaku untuk disk OS.
properties.identifier	GalleryImageIdentifier	Ini adalah pengidentifikasi definisi gambar galeri.
properties.osState	OperatingSystemStateTypes	Properti ini memungkinkan pengguna untuk menentukan apakah komputer virtual yang dibuat di bawah gambar ini adalah 'Generalized' atau 'Specialized'.
properties.osType	OperatingSystemTypes	Properti ini memungkinkan Anda menentukan jenis OS yang disertakan dalam disk saat membuat VM dari gambar terkelola. Potensi nilai: Windows Linux
properties.privacyStatementUri	string	Pernyataan privasi uri.
properties.provisioningState	GalleryProvisioningState	Status galeri atau artefak galeri saat ini. Status penyediaan, yang hanya muncul dalam respons.
properties.purchasePlan	ImagePurchasePlan	Menjelaskan paket pembelian definisi gambar galeri. Ini digunakan oleh gambar marketplace.
properties.recommended	RecommendedMachineConfiguration	Properti menjelaskan konfigurasi komputer yang direkomendasikan untuk Definisi Gambar ini. Properti ini dapat diperbarui.
properties.releaseNoteUri	string	Catatan rilis uri.
tags	object	Tag sumber daya
type	string	Jenis Sumber Daya

GalleryImageFeature

Fitur untuk gambar galeri.

Name	Type	Description
name	string	Nama fitur gambar galeri.
value	string	Nilai fitur gambar galeri.

GalleryImageIdentifier

Ini adalah pengidentifikasi definisi gambar galeri.

Name	Type	Description
offer	string	Nama penawaran definisi gambar galeri.
publisher	string	Nama penerbit definisi gambar galeri.
sku	string	Nama SKU definisi gambar galeri.

GalleryProvisioningState

Status galeri atau artefak galeri saat ini.

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

HyperVGeneration

Generasi hypervisor Komputer Virtual. Hanya berlaku untuk disk OS.

Name	Type	Description
V1	string
V2	string

ImagePurchasePlan

Menjelaskan paket pembelian definisi gambar galeri. Ini digunakan oleh gambar marketplace.

Name	Type	Description
name	string	ID paket.
product	string	ID produk.
publisher	string	ID penerbit.

InnerError

Detail kesalahan dalam.

Name	Type	Description
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

OperatingSystemStateTypes

Properti ini memungkinkan pengguna untuk menentukan apakah komputer virtual yang dibuat di bawah gambar ini adalah 'Generalized' atau 'Specialized'.

Name	Type	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Properti ini memungkinkan Anda menentukan jenis OS yang didukung yang dibangun aplikasinya.

Potensi nilai:

Windows

Linux

Name	Type	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Properti menjelaskan konfigurasi komputer yang direkomendasikan untuk Definisi Gambar ini. Properti ini dapat diperbarui.

Name	Type	Description
memory	ResourceRange	Menjelaskan rentang sumber daya.
vCPUs	ResourceRange	Menjelaskan rentang sumber daya.

ResourceRange

Menjelaskan rentang sumber daya.

Name	Type	Description
max	integer	Jumlah maksimum sumber daya.
min	integer	Jumlah minimum sumber daya.