Gallery Images - Create Or Update

リファレンス

Service:: Compute

API Version:: 2023-07-03

ギャラリーイメージ定義を作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
galleryImageName	path	True	string	作成または更新するギャラリーイメージ定義の名前。使用できる文字は、アルファベットと数字で、中央にドット、ダッシュ、ピリオドを使用できます。最大長は 80 文字です。
galleryName	path	True	string	イメージ定義を作成するShared Image Galleryの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースの場所
properties.identifier	True	GalleryImageIdentifier	これはギャラリーイメージ定義識別子です。
properties.osState	True	OperatingSystemStateTypes	このプロパティを使用すると、ユーザーは、このイメージの下に作成された仮想マシンが "一般化" か "特殊化" かを指定できます。
properties.osType	True	OperatingSystemTypes	このプロパティを使用すると、マネージドイメージから VM を作成するときにディスクに含まれる OS の種類を指定できます。使用できる値は、 Windows、Linux です。
properties.architecture		Architecture	イメージのアーキテクチャ。 OS ディスクにのみ適用されます。
properties.description		string	このギャラリーイメージ定義リソースの説明。このプロパティは更新可能です。
properties.disallowed		Disallowed	許可されていないディスクの種類について説明します。
properties.endOfLifeDate		string	ギャラリーイメージ定義の有効期間の終了日。このプロパティは、使用停止の目的で使用できます。このプロパティは更新可能です。
properties.eula		string	ギャラリーイメージ定義の Eula 契約。
properties.features		GalleryImageFeature[]	ギャラリーイメージ機能の一覧。
properties.hyperVGeneration		HyperVGeneration	仮想マシンのハイパーバイザーの生成。 OS ディスクにのみ適用されます。
properties.privacyStatementUri		string	プライバシーに関する声明 URI。
properties.purchasePlan		ImagePurchasePlan	ギャラリーイメージ定義の購入プランについて説明します。これはマーケットプレースイメージで使用されます。
properties.recommended		RecommendedMachineConfiguration	プロパティでは、このイメージ定義に推奨されるマシン構成について説明します。これらのプロパティは更新可能です。
properties.releaseNoteUri		string	リリースノート URI。
tags		object	リソースタグ

応答

名前	型	説明
200 OK	GalleryImage	OK
201 Created	GalleryImage	作成済み
202 Accepted	GalleryImage	同意
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
Architecture	イメージのアーキテクチャ。 OS ディスクにのみ適用されます。
CloudError	コンピューティングサービスからのエラー応答。
Disallowed	許可されていないディスクの種類について説明します。
GalleryImage	作成または更新するギャラリーイメージ定義に関する情報を指定します。
GalleryImageFeature	ギャラリーイメージの機能。
GalleryImageIdentifier	これはギャラリーイメージ定義識別子です。
GalleryProvisioningState	ギャラリーまたはギャラリー成果物の現在の状態。
HyperVGeneration	仮想マシンのハイパーバイザーの生成。 OS ディスクにのみ適用されます。
ImagePurchasePlan	ギャラリーイメージ定義の購入プランについて説明します。これはマーケットプレースイメージで使用されます。
InnerError	内部エラーの詳細。
OperatingSystemStateTypes	このプロパティを使用すると、ユーザーは、このイメージの下に作成された仮想マシンが "一般化" か "特殊化" かを指定できます。
OperatingSystemTypes	このプロパティを使用すると、アプリケーションがビルドされる OS のサポートされている種類を指定できます。使用できる値は、 Windows、Linux です。
RecommendedMachineConfiguration	プロパティでは、このイメージ定義に推奨されるマシン構成について説明します。これらのプロパティは更新可能です。
ResourceRange	リソース範囲について説明します。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

Architecture

イメージのアーキテクチャ。 OS ディスクにのみ適用されます。

名前	型	説明
Arm64	string
x64	string

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

Disallowed

許可されていないディスクの種類について説明します。

名前	型	説明
diskTypes	string[]	ディスクの種類の一覧。

GalleryImage

作成または更新するギャラリーイメージ定義に関する情報を指定します。

名前	型	説明
id	string	リソース ID
location	string	リソースの場所
name	string	リソース名
properties.architecture	Architecture	イメージのアーキテクチャ。 OS ディスクにのみ適用されます。
properties.description	string	このギャラリーイメージ定義リソースの説明。このプロパティは更新可能です。
properties.disallowed	Disallowed	許可されていないディスクの種類について説明します。
properties.endOfLifeDate	string	ギャラリーイメージ定義の有効期間の終了日。このプロパティは、使用停止の目的で使用できます。このプロパティは更新可能です。
properties.eula	string	ギャラリーイメージ定義の Eula 契約。
properties.features	GalleryImageFeature[]	ギャラリーイメージ機能の一覧。
properties.hyperVGeneration	HyperVGeneration	仮想マシンのハイパーバイザーの生成。 OS ディスクにのみ適用されます。
properties.identifier	GalleryImageIdentifier	これはギャラリーイメージ定義識別子です。
properties.osState	OperatingSystemStateTypes	このプロパティを使用すると、ユーザーは、このイメージの下に作成された仮想マシンが "一般化" か "特殊化" かを指定できます。
properties.osType	OperatingSystemTypes	このプロパティを使用すると、マネージドイメージから VM を作成するときにディスクに含まれる OS の種類を指定できます。使用できる値は、 Windows、Linux です。
properties.privacyStatementUri	string	プライバシーに関する声明 URI。
properties.provisioningState	GalleryProvisioningState	ギャラリーまたはギャラリー成果物の現在の状態。プロビジョニング状態。これは応答にのみ表示されます。
properties.purchasePlan	ImagePurchasePlan	ギャラリーイメージ定義の購入プランについて説明します。これはマーケットプレースイメージで使用されます。
properties.recommended	RecommendedMachineConfiguration	プロパティでは、このイメージ定義に推奨されるマシン構成について説明します。これらのプロパティは更新可能です。
properties.releaseNoteUri	string	リリースノート URI。
tags	object	リソースタグ
type	string	リソースの種類

GalleryImageFeature

ギャラリーイメージの機能。

名前	型	説明
name	string	ギャラリーイメージ機能の名前。
value	string	ギャラリーイメージ機能の値。

GalleryImageIdentifier

これはギャラリーイメージ定義識別子です。

名前	型	説明
offer	string	ギャラリーイメージ定義オファーの名前。
publisher	string	ギャラリーイメージ定義パブリッシャーの名前。
sku	string	ギャラリーイメージ定義 SKU の名前。

GalleryProvisioningState

ギャラリーまたはギャラリー成果物の現在の状態。

名前	型	説明
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

仮想マシンのハイパーバイザーの生成。 OS ディスクにのみ適用されます。

名前	型	説明
V1	string
V2	string

ImagePurchasePlan

ギャラリーイメージ定義の購入プランについて説明します。これはマーケットプレースイメージで使用されます。

名前	型	説明
name	string	プラン ID。
product	string	製品 ID。
publisher	string	発行元 ID。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

OperatingSystemStateTypes

このプロパティを使用すると、ユーザーは、このイメージの下に作成された仮想マシンが "一般化" か "特殊化" かを指定できます。

名前	型	説明
Generalized	string
Specialized	string

OperatingSystemTypes

このプロパティを使用すると、アプリケーションがビルドされる OS のサポートされている種類を指定できます。使用できる値は、 Windows、Linux です。

名前	型	説明
Linux	string
Windows	string

RecommendedMachineConfiguration

プロパティでは、このイメージ定義に推奨されるマシン構成について説明します。これらのプロパティは更新可能です。

名前	型	説明
memory	ResourceRange	リソース範囲について説明します。
vCPUs	ResourceRange	リソース範囲について説明します。

ResourceRange

リソース範囲について説明します。

名前	型	説明
max	integer	リソースの最大数。
min	integer	リソースの最小数。

Gallery Images - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

Create or update a simple gallery image.

Sample Request

Sample Response

定義

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

その他のリソース