Gallery Images - Create Or Update

Odwołanie

Service:: Compute

API Version:: 2023-07-03

Tworzenie lub aktualizowanie definicji obrazu galerii.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
galleryImageName	path	True	string	Nazwa definicji obrazu galerii, która ma zostać utworzona lub zaktualizowana. Dozwolone znaki to alfabety i liczby z kropkami, kreskami i kropkami dozwolonymi w środku. Maksymalna długość to 80 znaków.
galleryName	path	True	string	Nazwa Shared Image Gallery, w której ma zostać utworzona definicja obrazu.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu
properties.identifier	True	GalleryImageIdentifier	Jest to identyfikator definicji obrazu galerii.
properties.osState	True	OperatingSystemStateTypes	Ta właściwość umożliwia użytkownikowi określenie, czy maszyny wirtualne utworzone na tym obrazie są "Uogólnione" lub "Wyspecjalizowane".
properties.osType	True	OperatingSystemTypes	Ta właściwość umożliwia określenie typu systemu operacyjnego dołączonego do dysku podczas tworzenia maszyny wirtualnej na podstawie obrazu zarządzanego. Możliwe wartości to: Windows,Linux.
properties.architecture		Architecture	Architektura obrazu. Dotyczy tylko dysków systemu operacyjnego.
properties.description		string	Opis tego zasobu definicji obrazu galerii. Ta właściwość jest aktualizowalna.
properties.disallowed		Disallowed	Opisuje niedozwolone typy dysków.
properties.endOfLifeDate		string	Data zakończenia życia definicji obrazu galerii. Tej właściwości można używać do celów likwidowania. Ta właściwość jest aktualizowalna.
properties.eula		string	Umowa Licencyjna dotycząca definicji obrazu galerii.
properties.features		GalleryImageFeature[]	Lista funkcji obrazów galerii.
properties.hyperVGeneration		HyperVGeneration	Generacja funkcji hypervisor maszyny wirtualnej. Dotyczy tylko dysków systemu operacyjnego.
properties.privacyStatementUri		string	Identyfikator URI oświadczenia o ochronie prywatności.
properties.purchasePlan		ImagePurchasePlan	Opisuje plan zakupu definicji obrazu galerii. Jest to używane przez obrazy z witryny Marketplace.
properties.recommended		RecommendedMachineConfiguration	Właściwości opisują zalecaną konfigurację maszyny dla tej definicji obrazu. Te właściwości można aktualizować.
properties.releaseNoteUri		string	Identyfikator URI notatki o wersji.
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GalleryImage	OK
201 Created	GalleryImage	Utworzone
202 Accepted	GalleryImage	Zaakceptowano
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
Architecture	Architektura obrazu. Dotyczy tylko dysków systemu operacyjnego.
CloudError	Odpowiedź na błąd z usługi Compute.
Disallowed	Opisuje niedozwolone typy dysków.
GalleryImage	Określa informacje o definicji obrazu galerii, które chcesz utworzyć lub zaktualizować.
GalleryImageFeature	Funkcja obrazu galerii.
GalleryImageIdentifier	Jest to identyfikator definicji obrazu galerii.
GalleryProvisioningState	Bieżący stan galerii lub artefaktu galerii.
HyperVGeneration	Generacja funkcji hypervisor maszyny wirtualnej. Dotyczy tylko dysków systemu operacyjnego.
ImagePurchasePlan	Opisuje plan zakupu definicji obrazu galerii. Jest to używane przez obrazy z witryny Marketplace.
InnerError	Szczegóły błędu wewnętrznego.
OperatingSystemStateTypes	Ta właściwość umożliwia użytkownikowi określenie, czy maszyny wirtualne utworzone na tym obrazie są "Uogólnione" lub "Wyspecjalizowane".
OperatingSystemTypes	Ta właściwość umożliwia określenie obsługiwanego typu systemu operacyjnego, dla którego utworzono aplikację. Możliwe wartości to: Windows,Linux.
RecommendedMachineConfiguration	Właściwości opisują zalecaną konfigurację maszyny dla tej definicji obrazu. Te właściwości można aktualizować.
ResourceRange	Opisuje zakres zasobów.

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

Architecture

Architektura obrazu. Dotyczy tylko dysków systemu operacyjnego.

Nazwa	Typ	Opis
Arm64	string
x64	string

CloudError

Odpowiedź na błąd z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

Disallowed

Opisuje niedozwolone typy dysków.

Nazwa	Typ	Opis
diskTypes	string[]	Lista typów dysków.

GalleryImage

Określa informacje o definicji obrazu galerii, które chcesz utworzyć lub zaktualizować.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu
properties.architecture	Architecture	Architektura obrazu. Dotyczy tylko dysków systemu operacyjnego.
properties.description	string	Opis tego zasobu definicji obrazu galerii. Ta właściwość jest aktualizowalna.
properties.disallowed	Disallowed	Opisuje niedozwolone typy dysków.
properties.endOfLifeDate	string	Data zakończenia życia definicji obrazu galerii. Tej właściwości można używać do celów likwidowania. Ta właściwość jest aktualizowalna.
properties.eula	string	Umowa Licencyjna dotycząca definicji obrazu galerii.
properties.features	GalleryImageFeature[]	Lista funkcji obrazów galerii.
properties.hyperVGeneration	HyperVGeneration	Generacja funkcji hypervisor maszyny wirtualnej. Dotyczy tylko dysków systemu operacyjnego.
properties.identifier	GalleryImageIdentifier	Jest to identyfikator definicji obrazu galerii.
properties.osState	OperatingSystemStateTypes	Ta właściwość umożliwia użytkownikowi określenie, czy maszyny wirtualne utworzone na tym obrazie są "Uogólnione" lub "Wyspecjalizowane".
properties.osType	OperatingSystemTypes	Ta właściwość umożliwia określenie typu systemu operacyjnego dołączonego do dysku podczas tworzenia maszyny wirtualnej na podstawie obrazu zarządzanego. Możliwe wartości to: Windows,Linux.
properties.privacyStatementUri	string	Identyfikator URI oświadczenia o ochronie prywatności.
properties.provisioningState	GalleryProvisioningState	Bieżący stan galerii lub artefaktu galerii. Stan aprowizacji, który pojawia się tylko w odpowiedzi.
properties.purchasePlan	ImagePurchasePlan	Opisuje plan zakupu definicji obrazu galerii. Jest to używane przez obrazy z witryny Marketplace.
properties.recommended	RecommendedMachineConfiguration	Właściwości opisują zalecaną konfigurację maszyny dla tej definicji obrazu. Te właściwości można aktualizować.
properties.releaseNoteUri	string	Identyfikator URI notatki o wersji.
tags	object	Tagi zasobów
type	string	Typ zasobu

GalleryImageFeature

Funkcja obrazu galerii.

Nazwa	Typ	Opis
name	string	Nazwa funkcji obrazu galerii.
value	string	Wartość funkcji obrazu galerii.

GalleryImageIdentifier

Jest to identyfikator definicji obrazu galerii.

Nazwa	Typ	Opis
offer	string	Nazwa oferty definicji obrazu galerii.
publisher	string	Nazwa wydawcy definicji obrazu galerii.
sku	string	Nazwa jednostki SKU definicji obrazu galerii.

GalleryProvisioningState

Bieżący stan galerii lub artefaktu galerii.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Generacja funkcji hypervisor maszyny wirtualnej. Dotyczy tylko dysków systemu operacyjnego.

Nazwa	Typ	Opis
V1	string
V2	string

ImagePurchasePlan

Opisuje plan zakupu definicji obrazu galerii. Jest to używane przez obrazy z witryny Marketplace.

Nazwa	Typ	Opis
name	string	Identyfikator planu.
product	string	Identyfikator produktu.
publisher	string	Identyfikator wydawcy.

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

OperatingSystemStateTypes

Ta właściwość umożliwia użytkownikowi określenie, czy maszyny wirtualne utworzone na tym obrazie są "Uogólnione" lub "Wyspecjalizowane".

Nazwa	Typ	Opis
Generalized	string
Specialized	string

OperatingSystemTypes

Ta właściwość umożliwia określenie obsługiwanego typu systemu operacyjnego, dla którego utworzono aplikację. Możliwe wartości to: Windows,Linux.

Nazwa	Typ	Opis
Linux	string
Windows	string

RecommendedMachineConfiguration

Właściwości opisują zalecaną konfigurację maszyny dla tej definicji obrazu. Te właściwości można aktualizować.

Nazwa	Typ	Opis
memory	ResourceRange	Opisuje zakres zasobów.
vCPUs	ResourceRange	Opisuje zakres zasobów.

ResourceRange

Opisuje zakres zasobów.

Nazwa	Typ	Opis
max	integer	Maksymalna liczba zasobów.
min	integer	Minimalna liczba zasobów.

Gallery Images - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Create or update a simple gallery image.

Sample Request

Sample Response

Definicje

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

Dodatkowe zasoby