Application - Update

サービス:

Batch Management

API バージョン:

2025-06-01

指定したアプリケーションの設定を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}?api-version=2025-06-01

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	バッチアカウントの名前で、地域内で一意でなければならない。 バッチアカウント名は3文字から24文字の範囲で、数字と小文字のみを使用してください。 この名前は、アカウント作成地域のバッチサービスにアクセスするためのDNS名の一部として使われます。 たとえば、 http://accountname.region.batch.azure.com/と指定します。
applicationName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	アプリケーションの名前。 これはアカウント内で一意である必要があります。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.allowUpdates	boolean	アプリケーション内のパッケージが同じバージョン文字列を使用して上書きされるかどうかを示す値。
properties.defaultVersion	string	クライアントがアプリケーションを要求したがバージョンを指定していない場合に使用するパッケージ。 このプロパティは、既存のパッケージの名前にのみ設定できます。
properties.displayName	string	アプリケーションの表示名。
tags	object	リソースのタグ。

応答

名前	型	説明
200 OK	Application	Azure 操作は正常に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ApplicationUpdate

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1?api-version=2025-06-01

{
  "properties": {
    "allowUpdates": true,
    "defaultVersion": "2",
    "displayName": "myAppName"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python application_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.application.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        application_name="app1",
        parameters={"properties": {"allowUpdates": True, "defaultVersion": "2", "displayName": "myAppName"}},
    )
    print(response)


# x-ms-original-file: 2025-06-01/ApplicationUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_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/batch/armbatch/v4"
)

// Generated from example definition: 2025-06-01/ApplicationUpdate.json
func ExampleApplicationClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewApplicationClient().Update(ctx, "default-azurebatch-japaneast", "sampleacct", "app1", armbatch.Application{
		Properties: &armbatch.ApplicationProperties{
			AllowUpdates:   to.Ptr(true),
			DefaultVersion: to.Ptr("2"),
			DisplayName:    to.Ptr("myAppName"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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 = armbatch.ApplicationClientUpdateResponse{
	// 	Application: &armbatch.Application{
	// 		Name: to.Ptr("app1"),
	// 		Type: to.Ptr("Microsoft.Batch/batchAccounts/applications"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1"),
	// 		Properties: &armbatch.ApplicationProperties{
	// 			AllowUpdates: to.Ptr(true),
	// 			DefaultVersion: to.Ptr("2"),
	// 			DisplayName: to.Ptr("myAppName"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates settings for the specified application.
 *
 * @summary updates settings for the specified application.
 * x-ms-original-file: 2025-06-01/ApplicationUpdate.json
 */
async function applicationUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.application.update(
    "default-azurebatch-japaneast",
    "sampleacct",
    "app1",
    { allowUpdates: true, defaultVersion: "2", displayName: "myAppName" },
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationUpdate.json
// this example is just showing the usage of "Application_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 BatchApplicationResource created on azure
// for more information of creating BatchApplicationResource, please refer to the document of BatchApplicationResource
string subscriptionId = "12345678-1234-1234-1234-123456789012";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string applicationName = "app1";
ResourceIdentifier batchApplicationResourceId = BatchApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, applicationName);
BatchApplicationResource batchApplication = client.GetBatchApplicationResource(batchApplicationResourceId);

// invoke the operation
BatchApplicationData data = new BatchApplicationData
{
    DisplayName = "myAppName",
    AllowUpdates = true,
    DefaultVersion = "2",
};
BatchApplicationResource result = await batchApplication.UpdateAsync(data);

// 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
BatchApplicationData 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

ETag: W/"0x8D64F915BDF7F00"

{
  "name": "app1",
  "type": "Microsoft.Batch/batchAccounts/applications",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
  "properties": {
    "allowUpdates": true,
    "defaultVersion": "2",
    "displayName": "myAppName"
  }
}

定義

名前	説明
Application	Batch アカウント内のアプリケーションに関する情報が含まれています。
CloudError	Batch サービスからのエラー応答。
CloudErrorBody	Batch サービスからのエラー応答。
createdByType	リソースを作成した ID の種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。

Application

Object

Batch アカウント内のアプリケーションに関する情報が含まれています。

名前	型	説明
etag	string	コンカレンシー ステートメントに使用されるリソースの ETag。
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.allowUpdates	boolean	アプリケーション内のパッケージが同じバージョン文字列を使用して上書きされるかどうかを示す値。
properties.defaultVersion	string	クライアントがアプリケーションを要求したがバージョンを指定していない場合に使用するパッケージ。 このプロパティは、既存のパッケージの名前にのみ設定できます。
properties.displayName	string	アプリケーションの表示名。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースのタグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

CloudError

Object

Batch サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラー応答の本文。

CloudErrorBody

Object

Batch サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。