你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
galleryImageName	path	True	string	要创建或更新的库映像定义的名称。允许的字符是字母和数字，中间允许点、短划线和句点。最大长度为 80 个字符。
galleryName	path	True	string	要在其中创建映像定义的共享映像库的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。订阅 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.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	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。
properties.privacyStatementUri		string	隐私声明 URI。
properties.purchasePlan		ImagePurchasePlan	描述库映像定义购买计划。市场映像使用此映像。
properties.recommended		RecommendedMachineConfiguration	这些属性描述此映像定义的推荐计算机配置。这些属性是可更新的。
properties.releaseNoteUri		string	发行说明 URI。
tags		object	资源标记

响应

名称	类型	说明
200 OK	GalleryImage	还行
201 Created	GalleryImage	创建
202 Accepted	GalleryImage	接受
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/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");
require("dotenv/config");

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

定义

名称	说明
ApiError	Api 错误。
ApiErrorBase	Api 错误基数。
Architecture	映像的体系结构。仅适用于 OS 磁盘。
CloudError	来自计算服务的错误响应。
Disallowed	描述不允许的磁盘类型。
GalleryImage	指定要创建或更新的库映像定义的信息。
GalleryImageFeature	库映像的功能。
GalleryImageIdentifier	这是库映像定义标识符。
GalleryProvisioningState	库或库项目的当前状态。
HyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。
ImagePurchasePlan	描述库映像定义购买计划。市场映像使用此映像。
InnerError	内部错误详细信息。
OperatingSystemStateTypes	此属性允许用户指定在此映像下创建的虚拟机是“通用化”还是“专用”。
OperatingSystemTypes	此属性允许指定应用程序为其构建的 OS 支持的类型。可能的值包括：Windows、Linux。
RecommendedMachineConfiguration	这些属性描述此映像定义的推荐计算机配置。这些属性是可更新的。
ResourceRange	描述资源范围。

ApiError

Object

Api 错误。

名称	类型	说明
code	string	错误代码。
details	ApiErrorBase[]	API 错误详细信息
innererror	InnerError	Api 内部错误
message	string	错误消息。
target	string	特定错误的目标。

ApiErrorBase

Object

Api 错误基数。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。
target	string	特定错误的目标。

Architecture

Enumeration

映像的体系结构。仅适用于 OS 磁盘。

值	说明
Arm64
x64

CloudError

Object

来自计算服务的错误响应。

名称	类型	说明
error	ApiError	Api 错误。

Disallowed

Object

描述不允许的磁盘类型。

名称	类型	说明
diskTypes	string[]	磁盘类型的列表。

GalleryImage

Object

指定要创建或更新的库映像定义的信息。

名称	类型	说明
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	虚拟机的虚拟机监控程序生成。仅适用于 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

Object

库映像的功能。

名称	类型	说明
name	string	库映像功能的名称。
startsAtVersion	string	支持此功能的最低库映像版本。
value	string	库映像功能的值。

GalleryImageIdentifier

Object

这是库映像定义标识符。

名称	类型	说明
offer	string	库映像定义产品/服务的名称。
publisher	string	库映像定义发布者的名称。
sku	string	库映像定义 SKU 的名称。

GalleryProvisioningState

Enumeration

库或库项目的当前状态。

值	说明
Creating
Deleting
Failed
Migrating
Succeeded
Updating

HyperVGeneration

Enumeration

虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。

值	说明
V1
V2

ImagePurchasePlan

Object

描述库映像定义购买计划。市场映像使用此映像。

名称	类型	说明
name	string	计划 ID。
product	string	产品 ID。
publisher	string	发布者 ID。

InnerError

Object

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

OperatingSystemStateTypes

Enumeration

此属性允许用户指定在此映像下创建的虚拟机是“通用化”还是“专用”。

值	说明
Generalized
Specialized

OperatingSystemTypes

Enumeration

此属性允许指定应用程序为其构建的 OS 支持的类型。可能的值包括：Windows、Linux。

值	说明
Linux
Windows

RecommendedMachineConfiguration

Object

这些属性描述此映像定义的推荐计算机配置。这些属性是可更新的。

名称	类型	说明
memory	ResourceRange	描述资源范围。
vCPUs	ResourceRange	描述资源范围。

ResourceRange

Object

描述资源范围。

名称	类型	说明
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

其他资源