Gallery Images - Create Or Update

Referenz

Service:: Compute

API Version:: 2023-07-03

Erstellen oder aktualisieren Sie eine Katalogimagedefinition.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
galleryImageName	path	True	string	Der Name der Katalogimagedefinition, die erstellt oder aktualisiert werden soll. Die zulässigen Zeichen sind Alphabete und Zahlen, deren Punkte, Bindestriche und Punkte in der Mitte zulässig sind. Die maximale Länge beträgt 80 Zeichen.
galleryName	path	True	string	Der Name des Shared Image Gallery, in dem die Imagedefinition erstellt werden soll.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Ressourcenspeicherort
properties.identifier	True	GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
properties.osState	True	OperatingSystemStateTypes	Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalized" oder "Specialized" sind.
properties.osType	True	OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn sie einen virtuellen Computer aus einem verwalteten Image erstellen. Mögliche Werte sind: Windows,Linux.
properties.architecture		Architecture	Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.
properties.description		string	Die Beschreibung dieser Katalogbilddefinitionsressource. Diese Eigenschaft ist aktualisierbar.
properties.disallowed		Disallowed	Beschreibt die nicht zulässigen Datenträgertypen.
properties.endOfLifeDate		string	Das Datum des Lebenszyklusendes der Katalogbilddefinition. Diese Eigenschaft kann für Außerbetriebnahmezwecke verwendet werden. Diese Eigenschaft ist aktualisierbar.
properties.eula		string	Die Eula-Vereinbarung für die Katalogbilddefinition.
properties.features		GalleryImageFeature[]	Eine Liste der Features des Katalogimages.
properties.hyperVGeneration		HyperVGeneration	Die Hypervisorgeneration des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.
properties.privacyStatementUri		string	Die Datenschutzerklärung uri.
properties.purchasePlan		ImagePurchasePlan	Beschreibt den Katalogabbildungsabbildungskaufplan. Dies wird von Marketplace-Images verwendet.
properties.recommended		RecommendedMachineConfiguration	Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.
properties.releaseNoteUri		string	Der Releasenoten-URI.
tags		object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	GalleryImage	OK
201 Created	GalleryImage	Erstellt
202 Accepted	GalleryImage	Akzeptiert
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
Architecture	Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.
CloudError	Eine Fehlerantwort des Computediensts.
Disallowed	Beschreibt die nicht zulässigen Datenträgertypen.
GalleryImage	Gibt Informationen zur Katalogimagedefinition an, die Sie erstellen oder aktualisieren möchten.
GalleryImageFeature	Ein Feature für das Katalogbild.
GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
GalleryProvisioningState	Der aktuelle Zustand des Katalog- oder Katalogartefakts.
HyperVGeneration	Die Hypervisorgeneration des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.
ImagePurchasePlan	Beschreibt den Katalogabbildungsabbildungskaufplan. Dies wird von Marketplace-Images verwendet.
InnerError	Innere Fehlerdetails.
OperatingSystemStateTypes	Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalized" oder "Specialized" sind.
OperatingSystemTypes	Mit dieser Eigenschaft können Sie den unterstützten Typ des Betriebssystems angeben, für das die Anwendung erstellt wird. Mögliche Werte sind: Windows,Linux.
RecommendedMachineConfiguration	Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.
ResourceRange	Beschreibt den Ressourcenbereich.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Api-Fehlerdetails
innererror	InnerError	Der innere Api-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des jeweiligen Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des jeweiligen Fehlers.

Architecture

Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.

Name	Typ	Beschreibung
Arm64	string
x64	string

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

Disallowed

Beschreibt die nicht zulässigen Datenträgertypen.

Name	Typ	Beschreibung
diskTypes	string[]	Eine Liste von Datenträgertypen.

GalleryImage

Gibt Informationen zur Katalogimagedefinition an, die Sie erstellen oder aktualisieren möchten.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.architecture	Architecture	Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.
properties.description	string	Die Beschreibung dieser Katalogbilddefinitionsressource. Diese Eigenschaft ist aktualisierbar.
properties.disallowed	Disallowed	Beschreibt die nicht zulässigen Datenträgertypen.
properties.endOfLifeDate	string	Das Datum des Lebenszyklusendes der Katalogbilddefinition. Diese Eigenschaft kann für Außerbetriebnahmezwecke verwendet werden. Diese Eigenschaft ist aktualisierbar.
properties.eula	string	Die Eula-Vereinbarung für die Katalogbilddefinition.
properties.features	GalleryImageFeature[]	Eine Liste der Features des Katalogimages.
properties.hyperVGeneration	HyperVGeneration	Die Hypervisorgeneration des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.
properties.identifier	GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
properties.osState	OperatingSystemStateTypes	Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalized" oder "Specialized" sind.
properties.osType	OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn sie einen virtuellen Computer aus einem verwalteten Image erstellen. Mögliche Werte sind: Windows,Linux.
properties.privacyStatementUri	string	Die Datenschutzerklärung uri.
properties.provisioningState	GalleryProvisioningState	Der aktuelle Zustand des Katalog- oder Katalogartefakts. Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.purchasePlan	ImagePurchasePlan	Beschreibt den Katalogabbildungsabbildungskaufplan. Dies wird von Marketplace-Images verwendet.
properties.recommended	RecommendedMachineConfiguration	Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.
properties.releaseNoteUri	string	Der Releasenoten-URI.
tags	object	Ressourcentags
type	string	Ressourcentyp

GalleryImageFeature

Ein Feature für das Katalogbild.

Name	Typ	Beschreibung
name	string	Der Name des Katalogimagefeatures.
value	string	Der Wert des Katalogimagefeatures.

GalleryImageIdentifier

Dies ist der Katalogbilddefinitionsbezeichner.

Name	Typ	Beschreibung
offer	string	Der Name des Katalogimagedefinitionsangebots.
publisher	string	Der Name des Katalogimagedefinitionsherausgebers.
sku	string	Der Name der Katalogimagedefinitions-SKU.

GalleryProvisioningState

Der aktuelle Zustand des Katalog- oder Katalogartefakts.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Die Hypervisorgeneration des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.

Name	Typ	Beschreibung
V1	string
V2	string

ImagePurchasePlan

Beschreibt den Katalogabbildungsabbildungskaufplan. Dies wird von Marketplace-Images verwendet.

Name	Typ	Beschreibung
name	string	Die Plan-ID.
product	string	Die Produkt-ID
publisher	string	Die Herausgeber-ID.

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Das interne Fehlermeldungs- oder Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

OperatingSystemStateTypes

Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalized" oder "Specialized" sind.

Name	Typ	Beschreibung
Generalized	string
Specialized	string

OperatingSystemTypes

Mit dieser Eigenschaft können Sie den unterstützten Typ des Betriebssystems angeben, für das die Anwendung erstellt wird. Mögliche Werte sind: Windows,Linux.

Name	Typ	Beschreibung
Linux	string
Windows	string

RecommendedMachineConfiguration

Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.

Name	Typ	Beschreibung
memory	ResourceRange	Beschreibt den Ressourcenbereich.
vCPUs	ResourceRange	Beschreibt den Ressourcenbereich.

ResourceRange

Beschreibt den Ressourcenbereich.

Name	Typ	Beschreibung
max	integer	Die maximale Anzahl der Ressource.
min	integer	Die Mindestanzahl der Ressource.

Gallery Images - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Create or update a simple gallery image.

Sample Request

Sample Response

Definitionen

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

Zusätzliche Ressourcen