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	Имя Общая коллекция образов, в которой будет создано определение образа.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение ресурса
properties.identifier	True	GalleryImageIdentifier	Это идентификатор определения образа коллекции.
properties.osState	True	OperatingSystemStateTypes	Это свойство позволяет пользователю указать, являются ли виртуальные машины, созданные в этом образе, универсальными или специализированными.
properties.osType	True	OperatingSystemTypes	Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, которая включена в диск при создании виртуальной машины из управляемого образа. Возможные значения: Windows,Linux.
properties.architecture		Architecture	Архитектура образа. Применимо только к дискам ОС.
properties.description		string	Описание ресурса определения образа коллекции. Это свойство является обновляемым.
properties.disallowed		Disallowed	Описывает запрещенные типы дисков.
properties.endOfLifeDate		string	Дата окончания жизненного срока действия определения образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым.
properties.eula		string	Соглашение лицензионного соглашения для определения образа коллекции.
properties.features		GalleryImageFeature[]	Список функций изображений из коллекции.
properties.hyperVGeneration		HyperVGeneration	Создание низкоуровневой оболочки виртуальной машины. Применимо только к дискам ОС.
properties.privacyStatementUri		string	URI заявления о конфиденциальности.
properties.purchasePlan		ImagePurchasePlan	Описывает план приобретения определения образа коллекции. Используется образами Marketplace.
properties.recommended		RecommendedMachineConfiguration	Свойства описывают рекомендуемую конфигурацию компьютера для этого определения образа. Эти свойства являются обновляемыми.
properties.releaseNoteUri		string	URI заметки о выпуске.
tags		object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	GalleryImage	ОК
201 Created	GalleryImage	Создание
202 Accepted	GalleryImage	Принято
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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	Архитектура образа. Применимо только к дискам ОС.
CloudError	Ответ об ошибке от службы вычислений.
Disallowed	Описывает запрещенные типы дисков.
GalleryImage	Указывает сведения об определении образа коллекции, которое требуется создать или обновить.
GalleryImageFeature	Функция для образа из коллекции.
GalleryImageIdentifier	Это идентификатор определения образа коллекции.
GalleryProvisioningState	Текущее состояние коллекции или артефакта коллекции.
HyperVGeneration	Создание низкоуровневой оболочки виртуальной машины. Применимо только к дискам ОС.
ImagePurchasePlan	Описывает план приобретения определения образа коллекции. Используется образами Marketplace.
InnerError	Сведения о внутренней ошибке.
OperatingSystemStateTypes	Это свойство позволяет пользователю указать, являются ли виртуальные машины, созданные в этом образе, универсальными или специализированными.
OperatingSystemTypes	Это свойство позволяет указать поддерживаемый тип ОС, для которой создано приложение. Возможные значения: 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

Архитектура образа. Применимо только к дискам ОС.

Имя	Тип	Описание
Arm64	string
x64	string

CloudError

Ответ об ошибке от службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

Disallowed

Описывает запрещенные типы дисков.

Имя	Тип	Описание
diskTypes	string[]	Список типов дисков.

GalleryImage

Указывает сведения об определении образа коллекции, которое требуется создать или обновить.

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение ресурса
name	string	Имя ресурса
properties.architecture	Architecture	Архитектура образа. Применимо только к дискам ОС.
properties.description	string	Описание ресурса определения образа коллекции. Это свойство является обновляемым.
properties.disallowed	Disallowed	Описывает запрещенные типы дисков.
properties.endOfLifeDate	string	Дата окончания жизненного срока действия определения образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым.
properties.eula	string	Соглашение лицензионного соглашения для определения образа коллекции.
properties.features	GalleryImageFeature[]	Список функций изображений из коллекции.
properties.hyperVGeneration	HyperVGeneration	Создание низкоуровневой оболочки виртуальной машины. Применимо только к дискам ОС.
properties.identifier	GalleryImageIdentifier	Это идентификатор определения образа коллекции.
properties.osState	OperatingSystemStateTypes	Это свойство позволяет пользователю указать, являются ли виртуальные машины, созданные в этом образе, универсальными или специализированными.
properties.osType	OperatingSystemTypes	Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, которая включена в диск при создании виртуальной машины из управляемого образа. Возможные значения: Windows,Linux.
properties.privacyStatementUri	string	URI заявления о конфиденциальности.
properties.provisioningState	GalleryProvisioningState	Текущее состояние коллекции или артефакта коллекции. Состояние подготовки, которое отображается только в ответе.
properties.purchasePlan	ImagePurchasePlan	Описывает план приобретения определения образа коллекции. Используется образами Marketplace.
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

Создание низкоуровневой оболочки виртуальной машины. Применимо только к дискам ОС.

Имя	Тип	Описание
V1	string
V2	string

ImagePurchasePlan

Описывает план приобретения определения образа коллекции. Используется образами Marketplace.

Имя	Тип	Описание
name	string	Идентификатор плана.
product	string	Идентификатор продукта.
publisher	string	Идентификатор издателя.

InnerError

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

OperatingSystemStateTypes

Это свойство позволяет пользователю указать, являются ли виртуальные машины, созданные в этом образе, универсальными или специализированными.

Имя	Тип	Описание
Generalized	string
Specialized	string

OperatingSystemTypes

Это свойство позволяет указать поддерживаемый тип ОС, для которой создано приложение. Возможные значения: 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

Дополнительные ресурсы