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

Gallery Applications - Update

参考

服务:: Compute

API 版本:: 2023-07-03

更新库应用程序定义。

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

URI 参数

名称	在	必需	类型	说明
galleryApplicationName	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 版本。

请求正文

名称	必需	类型	说明
properties.supportedOSType	True	OperatingSystemTypes	此属性允许指定应用程序为其构建的 OS 支持的类型。可能的值包括：Windows、Linux。
properties.customActions		GalleryApplicationCustomAction[]	可以使用此库应用程序中的所有库应用程序版本执行的自定义作列表。
properties.description		string	此库应用程序定义资源的说明。此属性可更新。
properties.endOfLifeDate		string (date-time)	库应用程序定义的生命周期结束日期。此属性可用于解除授权目的。此属性可更新。
properties.eula		string	库应用程序定义的 Eula 协议。
properties.privacyStatementUri		string	隐私声明 URI。
properties.releaseNoteUri		string	发行说明 URI。
tags		object	资源标记

响应

名称	类型	说明
200 OK	GalleryApplication	还行
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Update a simple gallery Application.

示例请求

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName?api-version=2023-07-03

{
  "properties": {
    "description": "This is the gallery application description.",
    "eula": "This is the gallery application EULA.",
    "privacyStatementUri": "myPrivacyStatementUri}",
    "releaseNoteUri": "myReleaseNoteUri",
    "supportedOSType": "Windows",
    "customActions": [
      {
        "name": "myCustomAction",
        "script": "myCustomActionScript",
        "description": "This is the custom action description.",
        "parameters": [
          {
            "name": "myCustomActionParameter",
            "required": false,
            "type": "String",
            "defaultValue": "default value of parameter.",
            "description": "This is the description of the parameter"
          }
        ]
      }
    ]
  }
}


import com.azure.resourcemanager.compute.models.GalleryApplicationCustomAction;
import com.azure.resourcemanager.compute.models.GalleryApplicationCustomActionParameter;
import com.azure.resourcemanager.compute.models.GalleryApplicationCustomActionParameterType;
import com.azure.resourcemanager.compute.models.GalleryApplicationUpdate;
import com.azure.resourcemanager.compute.models.OperatingSystemTypes;
import java.util.Arrays;

/**
 * Samples for GalleryApplications Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/
     * GalleryApplication_Update.json
     */
    /**
     * Sample code: Update a simple gallery Application.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASimpleGalleryApplication(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getGalleryApplications()
            .update("myResourceGroup", "myGalleryName", "myGalleryApplicationName",
                new GalleryApplicationUpdate().withDescription("This is the gallery application description.")
                    .withEula("This is the gallery application EULA.").withPrivacyStatementUri("myPrivacyStatementUri}")
                    .withReleaseNoteUri("myReleaseNoteUri").withSupportedOSType(OperatingSystemTypes.WINDOWS)
                    .withCustomActions(Arrays.asList(new GalleryApplicationCustomAction().withName("myCustomAction")
                        .withScript("myCustomActionScript").withDescription("This is the custom action description.")
                        .withParameters(Arrays
                            .asList(new GalleryApplicationCustomActionParameter().withName("myCustomActionParameter")
                                .withRequired(false).withType(GalleryApplicationCustomActionParameterType.STRING)
                                .withDefaultValue("default value of parameter.")
                                .withDescription("This is the description of the parameter"))))),
                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/c7b98b36e4023331545051284d8500adf98f02fe/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json
func ExampleGalleryApplicationsClient_BeginUpdate() {
	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.NewGalleryApplicationsClient().BeginUpdate(ctx, "myResourceGroup", "myGalleryName", "myGalleryApplicationName", armcompute.GalleryApplicationUpdate{
		Properties: &armcompute.GalleryApplicationProperties{
			Description: to.Ptr("This is the gallery application description."),
			CustomActions: []*armcompute.GalleryApplicationCustomAction{
				{
					Name:        to.Ptr("myCustomAction"),
					Description: to.Ptr("This is the custom action description."),
					Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
						{
							Name:         to.Ptr("myCustomActionParameter"),
							Type:         to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
							Description:  to.Ptr("This is the description of the parameter"),
							DefaultValue: to.Ptr("default value of parameter."),
							Required:     to.Ptr(false),
						}},
					Script: to.Ptr("myCustomActionScript"),
				}},
			Eula:                to.Ptr("This is the gallery application EULA."),
			PrivacyStatementURI: to.Ptr("myPrivacyStatementUri}"),
			ReleaseNoteURI:      to.Ptr("myReleaseNoteUri"),
			SupportedOSType:     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.GalleryApplication = armcompute.GalleryApplication{
	// 	Name: to.Ptr("myGalleryApplicationName"),
	// 	Type: to.Ptr("Microsoft.Compute/galleries"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcompute.GalleryApplicationProperties{
	// 		Description: to.Ptr("This is the gallery application description."),
	// 		CustomActions: []*armcompute.GalleryApplicationCustomAction{
	// 			{
	// 				Name: to.Ptr("myCustomAction"),
	// 				Description: to.Ptr("This is the custom action description."),
	// 				Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
	// 					{
	// 						Name: to.Ptr("myCustomActionParameter"),
	// 						Type: to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
	// 						Description: to.Ptr("This is the description of the parameter"),
	// 						DefaultValue: to.Ptr("default value of parameter."),
	// 						Required: to.Ptr(false),
	// 				}},
	// 				Script: to.Ptr("myCustomActionScript"),
	// 		}},
	// 		Eula: to.Ptr("This is the gallery application EULA."),
	// 		PrivacyStatementURI: to.Ptr("myPrivacyStatementUri}"),
	// 		ReleaseNoteURI: to.Ptr("myReleaseNoteUri"),
	// 		SupportedOSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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 Update a gallery Application Definition.
 *
 * @summary Update a gallery Application Definition.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json
 */
async function updateASimpleGalleryApplication() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const galleryApplicationName = "myGalleryApplicationName";
  const galleryApplication = {
    description: "This is the gallery application description.",
    customActions: [
      {
        name: "myCustomAction",
        description: "This is the custom action description.",
        parameters: [
          {
            name: "myCustomActionParameter",
            type: "String",
            description: "This is the description of the parameter",
            defaultValue: "default value of parameter.",
            required: false,
          },
        ],
        script: "myCustomActionScript",
      },
    ],
    eula: "This is the gallery application EULA.",
    privacyStatementUri: "myPrivacyStatementUri}",
    releaseNoteUri: "myReleaseNoteUri",
    supportedOSType: "Windows",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryApplications.beginUpdateAndWait(
    resourceGroupName,
    galleryName,
    galleryApplicationName,
    galleryApplication,
  );
  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/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json
// this example is just showing the usage of "GalleryApplications_Update" 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 GalleryApplicationResource created on azure
// for more information of creating GalleryApplicationResource, please refer to the document of GalleryApplicationResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string galleryName = "myGalleryName";
string galleryApplicationName = "myGalleryApplicationName";
ResourceIdentifier galleryApplicationResourceId = GalleryApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName, galleryApplicationName);
GalleryApplicationResource galleryApplication = client.GetGalleryApplicationResource(galleryApplicationResourceId);

// invoke the operation
GalleryApplicationPatch patch = new GalleryApplicationPatch
{
    Description = "This is the gallery application description.",
    Eula = "This is the gallery application EULA.",
    PrivacyStatementUri = new Uri("myPrivacyStatementUri}"),
    ReleaseNoteUri = new Uri("myReleaseNoteUri"),
    SupportedOSType = SupportedOperatingSystemType.Windows,
    CustomActions = {new GalleryApplicationCustomAction("myCustomAction", "myCustomActionScript")
    {
    Description = "This is the custom action description.",
    Parameters = {new GalleryApplicationCustomActionParameter("myCustomActionParameter")
    {
    IsRequired = false,
    ParameterType = GalleryApplicationCustomActionParameterType.String,
    DefaultValue = "default value of parameter.",
    Description = "This is the description of the parameter",
    }},
    }},
};
ArmOperation<GalleryApplicationResource> lro = await galleryApplication.UpdateAsync(WaitUntil.Completed, patch);
GalleryApplicationResource 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
GalleryApplicationData 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

{
  "properties": {
    "description": "This is the gallery application description.",
    "eula": "This is the gallery application EULA.",
    "privacyStatementUri": "myPrivacyStatementUri}",
    "releaseNoteUri": "myReleaseNoteUri",
    "supportedOSType": "Windows",
    "customActions": [
      {
        "name": "myCustomAction",
        "script": "myCustomActionScript",
        "description": "This is the custom action description.",
        "parameters": [
          {
            "name": "myCustomActionParameter",
            "required": false,
            "type": "String",
            "defaultValue": "default value of parameter.",
            "description": "This is the description of the parameter"
          }
        ]
      }
    ]
  },
  "location": "West US",
  "name": "myGalleryApplicationName",
  "type": "Microsoft.Compute/galleries",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName"
}

定义

名称	说明
ApiError	Api 错误。
ApiErrorBase	Api 错误基数。
CloudError	来自计算服务的错误响应。
GalleryApplication	指定要创建或更新的库应用程序定义的信息。
GalleryApplicationCustomAction	可以使用库应用程序版本执行的自定义作。
GalleryApplicationCustomActionParameter	可传递给库应用程序版本的自定义作的参数的定义。
GalleryApplicationCustomActionParameterType	指定自定义作参数的类型。可能的值包括：String、ConfigurationDataBlob 或 LogOutputBlob
GalleryApplicationUpdate	指定要更新的库应用程序定义的信息。
InnerError	内部错误详细信息。
OperatingSystemTypes	此属性允许指定应用程序为其构建的 OS 支持的类型。可能的值包括：Windows、Linux。

ApiError

Object

Api 错误。

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

ApiErrorBase

Object

Api 错误基数。

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

CloudError

Object

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

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