Gallery Images - Create Or Update

Service:

Compute

API-versie:

2024-03-03

Een definitie van een galerie-installatiekopieën maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
galleryImageName	path	True	string	De naam van de definitie van de galerie-installatiekopieën die moeten worden gemaakt of bijgewerkt. De toegestane tekens zijn alfabetten en getallen met puntjes, streepjes en punten die in het midden zijn toegestaan. De maximale lengte is 80 tekens.
galleryName	path	True	string	De naam van de galerie met gedeelde installatiekopieën waarin de definitie van de installatiekopieën moet worden gemaakt.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	Resourcelocatie
properties.identifier	True	GalleryImageIdentifier	Dit is de definitie-id van de galerieafbeelding.
properties.osState	True	OperatingSystemStateTypes	Met deze eigenschap kan de gebruiker opgeven of de virtuele machines die zijn gemaakt onder deze installatiekopieën 'Gegeneraliseerd' of 'Gespecialiseerd' zijn.
properties.osType	True	OperatingSystemTypes	Met deze eigenschap kunt u het type besturingssysteem opgeven dat op de schijf is opgenomen bij het maken van een virtuele machine op basis van een beheerde installatiekopie. Mogelijke waarden zijn: Windows,Linux.
properties.allowUpdateImage		boolean	Facultatief. Moet zijn ingesteld op waar als de installatiekopieën van de galerie worden bijgewerkt.
properties.architecture		Architecture	De architectuur van de afbeelding. Alleen van toepassing op besturingssysteemschijven.
properties.description		string	De beschrijving van deze afbeeldingsdefinitieresource van de galerie. Deze eigenschap kan worden bijgewerkt.
properties.disallowed		Disallowed	Beschrijft de niet-toegestane schijftypen.
properties.endOfLifeDate		string	De einddatum van de definitie van de galerieafbeelding. Deze eigenschap kan worden gebruikt voor buitengebruikstelling. Deze eigenschap kan worden bijgewerkt.
properties.eula		string	De Eula-overeenkomst voor de definitie van de galerieafbeelding.
properties.features		GalleryImageFeature[]	Een lijst met afbeeldingsfuncties in de galerie.
properties.hyperVGeneration		HyperVGeneration	De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven.
properties.privacyStatementUri		string	De privacyverklaring-URI.
properties.purchasePlan		ImagePurchasePlan	Hierin wordt het aankoopplan voor de installatiekopieën van de galerie-installatiekopieën beschreven. Dit wordt gebruikt door Marketplace-installatiekopieën.
properties.recommended		RecommendedMachineConfiguration	De eigenschappen beschrijven de aanbevolen computerconfiguratie voor deze definitie van de installatiekopieën. Deze eigenschappen kunnen worden bijgewerkt.
properties.releaseNoteUri		string	De releasenotitie-URI.
tags		object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	GalleryImage	OK
201 Created	GalleryImage	Geschapen
202 Accepted	GalleryImage	Geaccepteerd
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create or update a simple gallery image.

Voorbeeldaanvraag

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/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");

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Statuscode:

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

Definities

Name	Description
ApiError	Api-fout.
ApiErrorBase	Api-foutbasis.
Architecture	De architectuur van de afbeelding. Alleen van toepassing op besturingssysteemschijven.
CloudError	Een foutreactie van de Compute-service.
Disallowed	Beschrijft de niet-toegestane schijftypen.
GalleryImage	Hiermee geeft u informatie op over de definitie van de galerie-installatiekopieën die u wilt maken of bijwerken.
GalleryImageFeature	Een functie voor galerieafbeelding.
GalleryImageIdentifier	Dit is de definitie-id van de galerieafbeelding.
GalleryProvisioningState	De huidige status van de galerie of galerieartefact.
HyperVGeneration	De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven.
ImagePurchasePlan	Hierin wordt het aankoopplan voor de installatiekopieën van de galerie-installatiekopieën beschreven. Dit wordt gebruikt door Marketplace-installatiekopieën.
InnerError	Interne foutdetails.
OperatingSystemStateTypes	Met deze eigenschap kan de gebruiker opgeven of de virtuele machines die zijn gemaakt onder deze installatiekopieën 'Gegeneraliseerd' of 'Gespecialiseerd' zijn.
OperatingSystemTypes	Met deze eigenschap kunt u het ondersteunde type van het besturingssysteem opgeven waarvoor de toepassing is gebouwd. Mogelijke waarden zijn: Windows,Linux.
RecommendedMachineConfiguration	De eigenschappen beschrijven de aanbevolen computerconfiguratie voor deze definitie van de installatiekopieën. Deze eigenschappen kunnen worden bijgewerkt.
ResourceRange	Beschrijft het resourcebereik.

ApiError

Api-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	Details van de API-fout
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

Architecture

De architectuur van de afbeelding. Alleen van toepassing op besturingssysteemschijven.

Name	Type	Description
Arm64	string
x64	string

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	Api-fout.

Disallowed

Beschrijft de niet-toegestane schijftypen.

Name	Type	Description
diskTypes	string[]	Een lijst met schijftypen.

GalleryImage

Hiermee geeft u informatie op over de definitie van de galerie-installatiekopieën die u wilt maken of bijwerken.

Name	Type	Description
id	string	Resource-id
location	string	Resourcelocatie
name	string	Resourcenaam
properties.allowUpdateImage	boolean	Facultatief. Moet zijn ingesteld op waar als de installatiekopieën van de galerie worden bijgewerkt.
properties.architecture	Architecture	De architectuur van de afbeelding. Alleen van toepassing op besturingssysteemschijven.
properties.description	string	De beschrijving van deze afbeeldingsdefinitieresource van de galerie. Deze eigenschap kan worden bijgewerkt.
properties.disallowed	Disallowed	Beschrijft de niet-toegestane schijftypen.
properties.endOfLifeDate	string	De einddatum van de definitie van de galerieafbeelding. Deze eigenschap kan worden gebruikt voor buitengebruikstelling. Deze eigenschap kan worden bijgewerkt.
properties.eula	string	De Eula-overeenkomst voor de definitie van de galerieafbeelding.
properties.features	GalleryImageFeature[]	Een lijst met afbeeldingsfuncties in de galerie.
properties.hyperVGeneration	HyperVGeneration	De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven.
properties.identifier	GalleryImageIdentifier	Dit is de definitie-id van de galerieafbeelding.
properties.osState	OperatingSystemStateTypes	Met deze eigenschap kan de gebruiker opgeven of de virtuele machines die zijn gemaakt onder deze installatiekopieën 'Gegeneraliseerd' of 'Gespecialiseerd' zijn.
properties.osType	OperatingSystemTypes	Met deze eigenschap kunt u het type besturingssysteem opgeven dat op de schijf is opgenomen bij het maken van een virtuele machine op basis van een beheerde installatiekopie. Mogelijke waarden zijn: Windows,Linux.
properties.privacyStatementUri	string	De privacyverklaring-URI.
properties.provisioningState	GalleryProvisioningState	De huidige status van de galerie of galerieartefact. De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.
properties.purchasePlan	ImagePurchasePlan	Hierin wordt het aankoopplan voor de installatiekopieën van de galerie-installatiekopieën beschreven. Dit wordt gebruikt door Marketplace-installatiekopieën.
properties.recommended	RecommendedMachineConfiguration	De eigenschappen beschrijven de aanbevolen computerconfiguratie voor deze definitie van de installatiekopieën. Deze eigenschappen kunnen worden bijgewerkt.
properties.releaseNoteUri	string	De releasenotitie-URI.
tags	object	Resourcetags
type	string	Resourcetype

GalleryImageFeature

Een functie voor galerieafbeelding.

Name	Type	Description
name	string	De naam van de afbeeldingsfunctie van de galerie.
startsAtVersion	string	De minimale versie van de galerie-installatiekopieën die deze functie ondersteunt.
value	string	De waarde van de afbeeldingsfunctie van de galerie.

GalleryImageIdentifier

Dit is de definitie-id van de galerieafbeelding.

Name	Type	Description
offer	string	De naam van de afbeeldingsdefinitieaanbieding van de galerie.
publisher	string	De naam van de uitgever van de definitie van de galerieinstallatiekopieën.
sku	string	De naam van de definitie-SKU van de galerie-installatiekopieën.

GalleryProvisioningState

De huidige status van de galerie of galerieartefact.

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

HyperVGeneration

De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven.

Name	Type	Description
V1	string
V2	string

ImagePurchasePlan

Hierin wordt het aankoopplan voor de installatiekopieën van de galerie-installatiekopieën beschreven. Dit wordt gebruikt door Marketplace-installatiekopieën.

Name	Type	Description
name	string	De plan-id.
product	string	De product-id.
publisher	string	De uitgever-id.

InnerError

Interne foutdetails.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

OperatingSystemStateTypes

Met deze eigenschap kan de gebruiker opgeven of de virtuele machines die zijn gemaakt onder deze installatiekopieën 'Gegeneraliseerd' of 'Gespecialiseerd' zijn.

Name	Type	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Met deze eigenschap kunt u het ondersteunde type van het besturingssysteem opgeven waarvoor de toepassing is gebouwd. Mogelijke waarden zijn: Windows,Linux.

Name	Type	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

De eigenschappen beschrijven de aanbevolen computerconfiguratie voor deze definitie van de installatiekopieën. Deze eigenschappen kunnen worden bijgewerkt.

Name	Type	Description
memory	ResourceRange	Beschrijft het resourcebereik.
vCPUs	ResourceRange	Beschrijft het resourcebereik.

ResourceRange

Beschrijft het resourcebereik.

Name	Type	Description
max	integer	Het maximum aantal resources.
min	integer	Het minimumaantal van de resource.