Gallery Images - Create Or Update

참조

서비스:: Compute

API 버전:: 2024-03-03

갤러리 이미지 정의를 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
galleryImageName	path	True	string	만들거나 업데이트할 갤러리 이미지 정의의 이름입니다. 허용되는 문자는 중간에서 점, 대시 및 마침표가 허용되는 알파벳 및 숫자입니다. 최대 길이는 80자입니다.
galleryName	path	True	string	이미지 정의를 만들 공유 이미지 갤러리의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스 위치
properties.identifier	True	GalleryImageIdentifier	갤러리 이미지 정의 식별자입니다.
properties.osState	True	OperatingSystemStateTypes	이 속성을 사용하면 사용자가 이 이미지에서 만든 가상 머신이 '일반화됨' 또는 '특수화'인지 여부를 지정할 수 있습니다.
properties.osType	True	OperatingSystemTypes	이 속성을 사용하면 관리되는 이미지에서 VM을 만들 때 디스크에 포함된 OS 유형을 지정할 수 있습니다. 가능한 값은 Windows,Linux입니다.
properties.allowUpdateImage		boolean	선택적. 갤러리 이미지 기능이 업데이트되는 경우 true로 설정해야 합니다.
properties.architecture		Architecture	이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.
properties.description		string	이 갤러리 이미지 정의 리소스에 대한 설명입니다. 이 속성은 업데이트할 수 있습니다.
properties.disallowed		Disallowed	허용되지 않는 디스크 유형에 대해 설명합니다.
properties.endOfLifeDate		string	갤러리 이미지 정의의 수명 종료 날짜입니다. 이 속성은 서비스 해제 목적으로 사용할 수 있습니다. 이 속성은 업데이트할 수 있습니다.
properties.eula		string	갤러리 이미지 정의에 대한 Eula 계약입니다.
properties.features		GalleryImageFeature[]	갤러리 이미지 기능 목록입니다.
properties.hyperVGeneration		HyperVGeneration	Virtual Machine의 하이퍼바이저 생성입니다. OS 디스크에만 적용됩니다.
properties.privacyStatementUri		string	개인정보처리방침 URI입니다.
properties.purchasePlan		ImagePurchasePlan	갤러리 이미지 정의 구매 계획을 설명합니다. 이는 마켓플레이스 이미지에서 사용됩니다.
properties.recommended		RecommendedMachineConfiguration	속성은 이 이미지 정의에 권장되는 컴퓨터 구성을 설명합니다. 이러한 속성은 업다이블할 수 있습니다.
properties.releaseNoteUri		string	릴리스 정보 URI입니다.
tags		object	리소스 태그

응답

Name	형식	Description
200 OK	GalleryImage	그래
201 Created	GalleryImage	만든
202 Accepted	GalleryImage	허용
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Create or update a simple gallery image.

샘플 요청

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


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

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

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

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

샘플 응답

상태 코드:: 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"
}

상태 코드:: 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"
}

상태 코드:: 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"
}

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
Architecture	이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.
CloudError	Compute 서비스의 오류 응답입니다.
Disallowed	허용되지 않는 디스크 유형에 대해 설명합니다.
GalleryImage	만들거나 업데이트하려는 갤러리 이미지 정의에 대한 정보를 지정합니다.
GalleryImageFeature	갤러리 이미지의 기능입니다.
GalleryImageIdentifier	갤러리 이미지 정의 식별자입니다.
GalleryProvisioningState	갤러리 또는 갤러리 아티팩트 현재 상태입니다.
HyperVGeneration	Virtual Machine의 하이퍼바이저 생성입니다. OS 디스크에만 적용됩니다.
ImagePurchasePlan	갤러리 이미지 정의 구매 계획을 설명합니다. 이는 마켓플레이스 이미지에서 사용됩니다.
InnerError	내부 오류 세부 정보입니다.
OperatingSystemStateTypes	이 속성을 사용하면 사용자가 이 이미지에서 만든 가상 머신이 '일반화됨' 또는 '특수화'인지 여부를 지정할 수 있습니다.
OperatingSystemTypes	이 속성을 사용하면 애플리케이션이 빌드되는 지원되는 OS 유형을 지정할 수 있습니다. 가능한 값은 Windows,Linux입니다.
RecommendedMachineConfiguration	속성은 이 이미지 정의에 권장되는 컴퓨터 구성을 설명합니다. 이러한 속성은 업다이블할 수 있습니다.
ResourceRange	리소스 범위를 설명합니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

Architecture

이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.

Name	형식	Description
Arm64	string
x64	string

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

Disallowed

허용되지 않는 디스크 유형에 대해 설명합니다.

Name	형식	Description
diskTypes	string[]	디스크 유형 목록입니다.

GalleryImage

만들거나 업데이트하려는 갤러리 이미지 정의에 대한 정보를 지정합니다.

Name	형식	Description
id	string	리소스 ID
location	string	리소스 위치
name	string	리소스 이름
properties.allowUpdateImage	boolean	선택적. 갤러리 이미지 기능이 업데이트되는 경우 true로 설정해야 합니다.
properties.architecture	Architecture	이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.
properties.description	string	이 갤러리 이미지 정의 리소스에 대한 설명입니다. 이 속성은 업데이트할 수 있습니다.
properties.disallowed	Disallowed	허용되지 않는 디스크 유형에 대해 설명합니다.
properties.endOfLifeDate	string	갤러리 이미지 정의의 수명 종료 날짜입니다. 이 속성은 서비스 해제 목적으로 사용할 수 있습니다. 이 속성은 업데이트할 수 있습니다.
properties.eula	string	갤러리 이미지 정의에 대한 Eula 계약입니다.
properties.features	GalleryImageFeature[]	갤러리 이미지 기능 목록입니다.
properties.hyperVGeneration	HyperVGeneration	Virtual Machine의 하이퍼바이저 생성입니다. 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	형식	Description
name	string	갤러리 이미지 기능의 이름입니다.
startsAtVersion	string	이 기능을 지원하는 최소 갤러리 이미지 버전입니다.
value	string	갤러리 이미지 기능의 값입니다.

GalleryImageIdentifier

갤러리 이미지 정의 식별자입니다.

Name	형식	Description
offer	string	갤러리 이미지 정의 제품의 이름입니다.
publisher	string	갤러리 이미지 정의 게시자의 이름입니다.
sku	string	갤러리 이미지 정의 SKU의 이름입니다.

GalleryProvisioningState

갤러리 또는 갤러리 아티팩트 현재 상태입니다.

Name	형식	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

HyperVGeneration

Virtual Machine의 하이퍼바이저 생성입니다. OS 디스크에만 적용됩니다.

Name	형식	Description
V1	string
V2	string

ImagePurchasePlan

갤러리 이미지 정의 구매 계획을 설명합니다. 이는 마켓플레이스 이미지에서 사용됩니다.

Name	형식	Description
name	string	계획 ID입니다.
product	string	제품 ID입니다.
publisher	string	게시자 ID입니다.

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

OperatingSystemStateTypes

이 속성을 사용하면 사용자가 이 이미지에서 만든 가상 머신이 '일반화됨' 또는 '특수화'인지 여부를 지정할 수 있습니다.

Name	형식	Description
Generalized	string
Specialized	string

OperatingSystemTypes

이 속성을 사용하면 애플리케이션이 빌드되는 지원되는 OS 유형을 지정할 수 있습니다. 가능한 값은 Windows,Linux입니다.

Name	형식	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

속성은 이 이미지 정의에 권장되는 컴퓨터 구성을 설명합니다. 이러한 속성은 업다이블할 수 있습니다.

Name	형식	Description
memory	ResourceRange	리소스 범위를 설명합니다.
vCPUs	ResourceRange	리소스 범위를 설명합니다.

ResourceRange

리소스 범위를 설명합니다.

Name	형식	Description
max	integer	리소스의 최대 수입니다.
min	integer	리소스의 최소 수입니다.

다음을 통해 공유

Gallery Images - Create Or Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Create or update a simple gallery image.

샘플 요청

샘플 응답

정의

ApiError

ApiErrorBase

Architecture

CloudError

Disallowed

GalleryImage

GalleryImageFeature

GalleryImageIdentifier

GalleryProvisioningState

HyperVGeneration

ImagePurchasePlan

InnerError

OperatingSystemStateTypes

OperatingSystemTypes

RecommendedMachineConfiguration

ResourceRange

추가 리소스