Gallery Images - Create Or Update

Služba:

Compute

Verze rozhraní API:

2024-03-03

Vytvořte nebo aktualizujte definici obrázku galerie.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
galleryImageName	path	True	string	Název definice obrázku galerie, která se má vytvořit nebo aktualizovat. Povolené znaky jsou abecedy a čísla s tečkami, pomlčkami a tečkami povolenými uprostřed. Maximální délka je 80 znaků.
galleryName	path	True	string	Název galerie sdílených imagí, ve které se má vytvořit definice obrázku.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění prostředku
properties.identifier	True	GalleryImageIdentifier	Toto je identifikátor definice obrázku galerie.
properties.osState	True	OperatingSystemStateTypes	Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v této imagi generalizované nebo specializované.
properties.osType	True	OperatingSystemTypes	Tato vlastnost umožňuje určit typ operačního systému, který je součástí disku při vytváření virtuálního počítače ze spravované image. Možné hodnoty jsou: Windows,Linux.
properties.allowUpdateImage		boolean	Volitelný. Pokud se aktualizují funkce imagí galerie, musí být nastavená na hodnotu True.
properties.architecture		Architecture	Architektura image. Platí jenom pro disky s operačním systémem.
properties.description		string	Popis tohoto prostředku definice obrázku galerie. Tato vlastnost je aktualizovatelná.
properties.disallowed		Disallowed	Popisuje nepovolené typy disků.
properties.endOfLifeDate		string	Datum konce životnosti definice obrázku galerie. Tuto vlastnost lze použít pro účely vyřazení z provozu. Tato vlastnost je aktualizovatelná.
properties.eula		string	Smlouva Eula pro definici obrázku galerie.
properties.features		GalleryImageFeature[]	Seznam funkcí obrázků galerie
properties.hyperVGeneration		HyperVGeneration	Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.
properties.privacyStatementUri		string	Identifikátor URI prohlášení o zásadách ochrany osobních údajů.
properties.purchasePlan		ImagePurchasePlan	Popisuje plán nákupu definic obrázků galerie. Používá se v imagích marketplace.
properties.recommended		RecommendedMachineConfiguration	Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti jsou aktualizovatelné.
properties.releaseNoteUri		string	Identifikátor URI poznámky k verzi.
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Vytvořil
202 Accepted	GalleryImage	Přijal
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create or update a simple gallery image.

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName?api-version=2024-03-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/2024-03-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-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");
require("dotenv/config");

/**
 * 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/2024-03-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 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/2024-03-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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
Architecture	Architektura image. Platí jenom pro disky s operačním systémem.
CloudError	Odpověď na chybu z výpočetní služby
Disallowed	Popisuje nepovolené typy disků.
GalleryImage	Určuje informace o definici obrázku galerie, kterou chcete vytvořit nebo aktualizovat.
GalleryImageFeature	Funkce pro obrázek galerie
GalleryImageIdentifier	Toto je identifikátor definice obrázku galerie.
GalleryProvisioningState	Aktuální stav artefaktu galerie nebo galerie.
HyperVGeneration	Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.
ImagePurchasePlan	Popisuje plán nákupu definic obrázků galerie. Používá se v imagích marketplace.
InnerError	Podrobnosti vnitřní chyby.
OperatingSystemStateTypes	Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v této imagi generalizované nebo specializované.
OperatingSystemTypes	Tato vlastnost umožňuje určit podporovaný typ operačního systému, pro který je aplikace vytvořená. Možné hodnoty jsou: Windows,Linux.
RecommendedMachineConfiguration	Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti jsou aktualizovatelné.
ResourceRange	Popisuje rozsah prostředků.

ApiError

Object

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Object

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

Architecture

Enumeration

Architektura image. Platí jenom pro disky s operačním systémem.

Hodnota	Description
Arm64
x64

CloudError

Object

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

Disallowed

Object

Popisuje nepovolené typy disků.

Name	Typ	Description
diskTypes	string[]	Seznam typůdiskůch

GalleryImage

Object

Určuje informace o definici obrázku galerie, kterou chcete vytvořit nebo aktualizovat.

Name	Typ	Description
id	string	ID prostředku
location	string	Umístění prostředku
name	string	Název prostředku
properties.allowUpdateImage	boolean	Volitelný. Pokud se aktualizují funkce imagí galerie, musí být nastavená na hodnotu True.
properties.architecture	Architecture	Architektura image. Platí jenom pro disky s operačním systémem.
properties.description	string	Popis tohoto prostředku definice obrázku galerie. Tato vlastnost je aktualizovatelná.
properties.disallowed	Disallowed	Popisuje nepovolené typy disků.
properties.endOfLifeDate	string	Datum konce životnosti definice obrázku galerie. Tuto vlastnost lze použít pro účely vyřazení z provozu. Tato vlastnost je aktualizovatelná.
properties.eula	string	Smlouva Eula pro definici obrázku galerie.
properties.features	GalleryImageFeature[]	Seznam funkcí obrázků galerie
properties.hyperVGeneration	HyperVGeneration	Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.
properties.identifier	GalleryImageIdentifier	Toto je identifikátor definice obrázku galerie.
properties.osState	OperatingSystemStateTypes	Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v této imagi generalizované nebo specializované.
properties.osType	OperatingSystemTypes	Tato vlastnost umožňuje určit typ operačního systému, který je součástí disku při vytváření virtuálního počítače ze spravované image. Možné hodnoty jsou: Windows,Linux.
properties.privacyStatementUri	string	Identifikátor URI prohlášení o zásadách ochrany osobních údajů.
properties.provisioningState	GalleryProvisioningState	Aktuální stav artefaktu galerie nebo galerie. Stav zřizování, který se zobrazí pouze v odpovědi.
properties.purchasePlan	ImagePurchasePlan	Popisuje plán nákupu definic obrázků galerie. Používá se v imagích marketplace.
properties.recommended	RecommendedMachineConfiguration	Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti jsou aktualizovatelné.
properties.releaseNoteUri	string	Identifikátor URI poznámky k verzi.
tags	object	Značky prostředků
type	string	Typ prostředku

GalleryImageFeature

Object

Funkce pro obrázek galerie

Name	Typ	Description
name	string	Název funkce obrázku galerie.
startsAtVersion	string	Minimální verze image galerie, která tuto funkci podporuje.
value	string	Hodnota funkce obrázku galerie.

GalleryImageIdentifier

Object

Toto je identifikátor definice obrázku galerie.

Name	Typ	Description
offer	string	Název nabídky definice obrázku galerie.
publisher	string	Název vydavatele definice obrázku galerie.
sku	string	Název skladové položky definice obrázku galerie

GalleryProvisioningState

Enumeration

Aktuální stav artefaktu galerie nebo galerie.

Hodnota	Description
Creating
Deleting
Failed
Migrating
Succeeded
Updating

HyperVGeneration

Enumeration

Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.

Hodnota	Description
V1
V2

ImagePurchasePlan

Object

Popisuje plán nákupu definic obrázků galerie. Používá se v imagích marketplace.

Name	Typ	Description
name	string	ID plánu.
product	string	ID produktu.
publisher	string	ID vydavatele.

InnerError

Object

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

OperatingSystemStateTypes

Enumeration

Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v této imagi generalizované nebo specializované.

Hodnota	Description
Generalized
Specialized

OperatingSystemTypes

Enumeration

Tato vlastnost umožňuje určit podporovaný typ operačního systému, pro který je aplikace vytvořená. Možné hodnoty jsou: Windows,Linux.

Hodnota	Description
Linux
Windows

RecommendedMachineConfiguration

Object

Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti jsou aktualizovatelné.

Name	Typ	Description
memory	ResourceRange	Popisuje rozsah prostředků.
vCPUs	ResourceRange	Popisuje rozsah prostředků.

ResourceRange

Object

Popisuje rozsah prostředků.

Name	Typ	Description
max	integer	Maximální počet prostředků.
min	integer	Minimální počet prostředků.