Gallery Images - Create Or Update

Referens

Service:: Compute

API Version:: 2023-07-03

Skapa eller uppdatera en galleribilddefinition.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
galleryImageName	path	True	string	Namnet på den galleribilddefinition som ska skapas eller uppdateras. De tillåtna tecknen är alfabet och siffror med punkter, bindestreck och punkter som tillåts i mitten. Den maximala längden är 80 tecken.
galleryName	path	True	string	Namnet på Shared Image Gallery där bilddefinitionen ska skapas.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Resursplats
properties.identifier	True	GalleryImageIdentifier	Det här är galleribildens definitionsidentifierare.
properties.osState	True	OperatingSystemStateTypes	Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.
properties.osType	True	OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken när du skapar en virtuell dator från en hanterad avbildning. Möjliga värden är: Windows,Linux.
properties.architecture		Architecture	Bildens arkitektur. Gäller endast os-diskar.
properties.description		string	Beskrivningen av den här galleribilddefinitionsresursen. Den här egenskapen kan uppdateras.
properties.disallowed		Disallowed	Beskriver de otillåtna disktyperna.
properties.endOfLifeDate		string	Slutdatumet för galleribilddefinitionen. Den här egenskapen kan användas för avställning. Den här egenskapen kan uppdateras.
properties.eula		string	Eula-avtalet för galleribilddefinitionen.
properties.features		GalleryImageFeature[]	En lista över galleribildfunktioner.
properties.hyperVGeneration		HyperVGeneration	Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.
properties.privacyStatementUri		string	Sekretesspolicyns URI.
properties.purchasePlan		ImagePurchasePlan	Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.
properties.recommended		RecommendedMachineConfiguration	Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.
properties.releaseNoteUri		string	Versionsanteckningens URI.
tags		object	Resurstaggar

Svar

Name	Typ	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Skapad
202 Accepted	GalleryImage	Har godkänts
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
Architecture	Bildens arkitektur. Gäller endast os-diskar.
CloudError	Ett felsvar från Beräkningstjänsten.
Disallowed	Beskriver de otillåtna disktyperna.
GalleryImage	Anger information om den galleribilddefinition som du vill skapa eller uppdatera.
GalleryImageFeature	En funktion för galleribild.
GalleryImageIdentifier	Det här är galleribildens definitionsidentifierare.
GalleryProvisioningState	Det aktuella tillståndet för galleriet eller galleriartefakten.
HyperVGeneration	Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.
ImagePurchasePlan	Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.
InnerError	Inre felinformation.
OperatingSystemStateTypes	Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.
OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som stöds som programmet har skapats för. Möjliga värden är: Windows,Linux.
RecommendedMachineConfiguration	Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.
ResourceRange	Beskriver resursintervallet.

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

Architecture

Bildens arkitektur. Gäller endast os-diskar.

Name	Typ	Description
Arm64	string
x64	string

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

Disallowed

Beskriver de otillåtna disktyperna.

Name	Typ	Description
diskTypes	string[]	En lista över disktyper.

GalleryImage

Anger information om den galleribilddefinition som du vill skapa eller uppdatera.

Name	Typ	Description
id	string	Resurs-ID
location	string	Resursplats
name	string	Resursnamn
properties.architecture	Architecture	Bildens arkitektur. Gäller endast os-diskar.
properties.description	string	Beskrivningen av den här galleribilddefinitionsresursen. Den här egenskapen kan uppdateras.
properties.disallowed	Disallowed	Beskriver de otillåtna disktyperna.
properties.endOfLifeDate	string	Slutdatumet för galleribilddefinitionen. Den här egenskapen kan användas för avställning. Den här egenskapen kan uppdateras.
properties.eula	string	Eula-avtalet för galleribilddefinitionen.
properties.features	GalleryImageFeature[]	En lista över galleribildfunktioner.
properties.hyperVGeneration	HyperVGeneration	Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.
properties.identifier	GalleryImageIdentifier	Det här är galleribildens definitionsidentifierare.
properties.osState	OperatingSystemStateTypes	Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.
properties.osType	OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken när du skapar en virtuell dator från en hanterad avbildning. Möjliga värden är: Windows,Linux.
properties.privacyStatementUri	string	Sekretesspolicyns URI.
properties.provisioningState	GalleryProvisioningState	Det aktuella tillståndet för galleriet eller galleriartefakten. Etableringstillståndet, som bara visas i svaret.
properties.purchasePlan	ImagePurchasePlan	Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.
properties.recommended	RecommendedMachineConfiguration	Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.
properties.releaseNoteUri	string	Versionsanteckningens URI.
tags	object	Resurstaggar
type	string	Resurstyp

GalleryImageFeature

En funktion för galleribild.

Name	Typ	Description
name	string	Namnet på galleribildfunktionen.
value	string	Värdet för galleribildfunktionen.

GalleryImageIdentifier

Det här är galleribildens definitionsidentifierare.

Name	Typ	Description
offer	string	Namnet på galleriets bilddefinitionserbjudande.
publisher	string	Namnet på galleriets bilddefinitionsutgivare.
sku	string	Namnet på galleribilddefinitionens SKU.

GalleryProvisioningState

Det aktuella tillståndet för galleriet eller galleriartefakten.

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

HyperVGeneration

Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.

Name	Typ	Description
V1	string
V2	string

ImagePurchasePlan

Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.

Name	Typ	Description
name	string	Plan-ID:t.
product	string	Produkt-ID: t.
publisher	string	Utgivarens ID.

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

OperatingSystemStateTypes

Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.

Name	Typ	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Med den här egenskapen kan du ange vilken typ av operativsystem som stöds som programmet har skapats för. Möjliga värden är: Windows,Linux.

Name	Typ	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.

Name	Typ	Description
memory	ResourceRange	Beskriver resursintervallet.
vCPUs	ResourceRange	Beskriver resursintervallet.

ResourceRange

Beskriver resursintervallet.

Name	Typ	Description
max	integer	Det maximala antalet för resursen.
min	integer	Minsta antal för resursen.

Share via

Gallery Images - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

Create or update a simple gallery image.

Sample Request

Sample Response

Definitioner

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

Ytterligare resurser