Gallery Images - Create Or Update

Service:

Compute

API Version:

2023-07-03

Katalógus képdefiníciójának létrehozása vagy frissítése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
galleryImageName	path	True	string	A létrehozandó vagy frissítendő katalóguskép-definíció neve. Az engedélyezett karakterek betűrendek és számok, amelyek közepén pontok, kötőjelek és pontok szerepelnek. A maximális hossz 80 karakter.
galleryName	path	True	string	Annak a Shared Image Gallery a neve, amelyben létre kívánja hozni a képdefiníciót.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Erőforrás helye
properties.identifier	True	GalleryImageIdentifier	Ez a katalógus képdefiníció-azonosítója.
properties.osState	True	OperatingSystemStateTypes	Ez a tulajdonság lehetővé teszi a felhasználó számára annak megadását, hogy a rendszerkép alatt létrehozott virtuális gépek "Generalized" vagy "Special".
properties.osType	True	OperatingSystemTypes	Ez a tulajdonság lehetővé teszi a lemezen található operációs rendszer típusának megadását, amikor felügyelt rendszerképből hoz létre virtuális gépet. Lehetséges értékek: Windows,Linux.
properties.architecture		Architecture	A kép architektúrája. Csak operációsrendszer-lemezekre alkalmazható.
properties.description		string	A katalógus képdefiníciós erőforrásának leírása. Ez a tulajdonság frissíthető.
properties.disallowed		Disallowed	A nem engedélyezett lemeztípusokat ismerteti.
properties.endOfLifeDate		string	A katalógus képdefiníciójának lejárati dátuma. Ez a tulajdonság leszerelési célokra használható. Ez a tulajdonság frissíthető.
properties.eula		string	A katalógus képdefiníciójára vonatkozó Eula-szerződés.
properties.features		GalleryImageFeature[]	A katalógus képfunkcióinak listája.
properties.hyperVGeneration		HyperVGeneration	A virtuális gép hipervizor-generációja. Csak operációsrendszer-lemezekre alkalmazható.
properties.privacyStatementUri		string	Az adatvédelmi nyilatkozat URI-ja.
properties.purchasePlan		ImagePurchasePlan	A katalógus képdefiníciós vásárlási csomagját ismerteti. Ezt a marketplace-rendszerképek használják.
properties.recommended		RecommendedMachineConfiguration	A tulajdonságok a képdefiníció javasolt gépkonfigurációját írják le. Ezek a tulajdonságok frissíthetők.
properties.releaseNoteUri		string	A kibocsátási megjegyzés URI-ja.
tags		object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Létrehozva
202 Accepted	GalleryImage	Elfogadva
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
ApiError	Api-hiba.
ApiErrorBase	Api-hibabázis.
Architecture	A kép architektúrája. Csak operációsrendszer-lemezekre alkalmazható.
CloudError	Hibaválasz a Számítási szolgáltatástól.
Disallowed	A nem engedélyezett lemeztípusokat ismerteti.
GalleryImage	Megadja a létrehozni vagy frissíteni kívánt katalógus képdefinícióját.
GalleryImageFeature	A katalógus képének egyik funkciója.
GalleryImageIdentifier	Ez a katalógus képdefiníció-azonosítója.
GalleryProvisioningState	A katalógus vagy katalógus összetevőjének aktuális állapota.
HyperVGeneration	A virtuális gép hipervizor-generációja. Csak operációsrendszer-lemezekre alkalmazható.
ImagePurchasePlan	A katalógus képdefiníciós vásárlási csomagját ismerteti. Ezt a marketplace-rendszerképek használják.
InnerError	Belső hiba részletei.
OperatingSystemStateTypes	Ez a tulajdonság lehetővé teszi a felhasználó számára annak megadását, hogy a rendszerkép alatt létrehozott virtuális gépek "Generalized" vagy "Special".
OperatingSystemTypes	Ez a tulajdonság lehetővé teszi az alkalmazás által létrehozott operációs rendszer támogatott típusának megadását. Lehetséges értékek: Windows,Linux.
RecommendedMachineConfiguration	A tulajdonságok a képdefiníció javasolt gépkonfigurációját írják le. Ezek a tulajdonságok frissíthetők.
ResourceRange	Az erőforrástartományt ismerteti.

ApiError

Api-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az API belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

Api-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

Architecture

A kép architektúrája. Csak operációsrendszer-lemezekre alkalmazható.

Name	Típus	Description
Arm64	string
x64	string

CloudError

Hibaválasz a Számítási szolgáltatástól.

Name	Típus	Description
error	ApiError	Api-hiba.

Disallowed

A nem engedélyezett lemeztípusokat ismerteti.

Name	Típus	Description
diskTypes	string[]	Lemeztípusok listája.

GalleryImage

Megadja a létrehozni vagy frissíteni kívánt katalógus képdefinícióját.

Name	Típus	Description
id	string	Erőforrás-azonosító
location	string	Erőforrás helye
name	string	Erőforrás neve
properties.architecture	Architecture	A kép architektúrája. Csak operációsrendszer-lemezekre alkalmazható.
properties.description	string	A katalógus képdefiníciós erőforrásának leírása. Ez a tulajdonság frissíthető.
properties.disallowed	Disallowed	A nem engedélyezett lemeztípusokat ismerteti.
properties.endOfLifeDate	string	A katalógus képdefiníciójának lejárati dátuma. Ez a tulajdonság leszerelési célokra használható. Ez a tulajdonság frissíthető.
properties.eula	string	A katalógus képdefiníciójára vonatkozó Eula-szerződés.
properties.features	GalleryImageFeature[]	A katalógus képfunkcióinak listája.
properties.hyperVGeneration	HyperVGeneration	A virtuális gép hipervizor-generációja. Csak operációsrendszer-lemezekre alkalmazható.
properties.identifier	GalleryImageIdentifier	Ez a katalógus képdefiníció-azonosítója.
properties.osState	OperatingSystemStateTypes	Ez a tulajdonság lehetővé teszi a felhasználó számára annak megadását, hogy a rendszerkép alatt létrehozott virtuális gépek "Generalized" vagy "Special".
properties.osType	OperatingSystemTypes	Ez a tulajdonság lehetővé teszi a lemezen található operációs rendszer típusának megadását, amikor felügyelt rendszerképből hoz létre virtuális gépet. Lehetséges értékek: Windows,Linux.
properties.privacyStatementUri	string	Az adatvédelmi nyilatkozat URI-ja.
properties.provisioningState	GalleryProvisioningState	A katalógus vagy katalógus összetevőjének aktuális állapota. A kiépítési állapot, amely csak a válaszban jelenik meg.
properties.purchasePlan	ImagePurchasePlan	A katalógus képdefiníciós vásárlási csomagját ismerteti. Ezt a marketplace-rendszerképek használják.
properties.recommended	RecommendedMachineConfiguration	A tulajdonságok a képdefiníció javasolt gépkonfigurációját írják le. Ezek a tulajdonságok frissíthetők.
properties.releaseNoteUri	string	A kibocsátási megjegyzés URI-ja.
tags	object	Erőforráscímkék
type	string	Erőforrás típusa

GalleryImageFeature

A katalógus képének egyik funkciója.

Name	Típus	Description
name	string	A katalógus képfunkciójának neve.
value	string	A katalógus képfunkciójának értéke.

GalleryImageIdentifier

Ez a katalógus képdefiníció-azonosítója.

Name	Típus	Description
offer	string	A katalógus képdefiníciós ajánlatának neve.
publisher	string	A katalógus képdefiníció-közzétevőjének neve.
sku	string	A katalógus képdefiníciós termékváltozatának neve.

GalleryProvisioningState

A katalógus vagy katalógus összetevőjének aktuális állapota.

Name	Típus	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

A virtuális gép hipervizor-generációja. Csak operációsrendszer-lemezekre alkalmazható.

Name	Típus	Description
V1	string
V2	string

ImagePurchasePlan

A katalógus képdefiníciós vásárlási csomagját ismerteti. Ezt a marketplace-rendszerképek használják.

Name	Típus	Description
name	string	A terv azonosítója.
product	string	A termékazonosító.
publisher	string	A közzétevő azonosítója.

InnerError

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

OperatingSystemStateTypes

Ez a tulajdonság lehetővé teszi a felhasználó számára annak megadását, hogy a rendszerkép alatt létrehozott virtuális gépek "Generalized" vagy "Special".

Name	Típus	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Ez a tulajdonság lehetővé teszi az alkalmazás által létrehozott operációs rendszer támogatott típusának megadását. Lehetséges értékek: Windows,Linux.

Name	Típus	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

A tulajdonságok a képdefiníció javasolt gépkonfigurációját írják le. Ezek a tulajdonságok frissíthetők.

Name	Típus	Description
memory	ResourceRange	Az erőforrástartományt ismerteti.
vCPUs	ResourceRange	Az erőforrástartományt ismerteti.

ResourceRange

Az erőforrástartományt ismerteti.

Name	Típus	Description
max	integer	Az erőforrás maximális száma.
min	integer	Az erőforrás minimális száma.