Application - Update

Service:

Batch Management

API-versie:

2025-06-01

Hiermee worden de instellingen voor de opgegeven toepassing bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Een naam voor het batchaccount die uniek moet zijn binnen de regio. Batch-accountnamen moeten tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters bevatten. Deze naam wordt gebruikt als onderdeel van de DNS-naam die wordt gebruikt om toegang te krijgen tot de Batch-service in de regio waarin het account is aangemaakt. Voorbeeld: http://accountname.region.batch.azure.com/.
applicationName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	De naam van de toepassing. Dit moet uniek zijn binnen het account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.allowUpdates	boolean	Een waarde die aangeeft of pakketten in de toepassing kunnen worden overschreven met dezelfde versietekenreeks.
properties.defaultVersion	string	Het pakket dat moet worden gebruikt als een client de toepassing aanvraagt, maar geen versie opgeeft. Deze eigenschap kan alleen worden ingesteld op de naam van een bestaand pakket.
properties.displayName	string	De weergavenaam voor de toepassing.
tags	object	De tags van de resource.

Antwoorden

Name	Type	Description
200 OK	Application	Azure-bewerking is voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApplicationUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Application	Bevat informatie over een toepassing in een Batch-account.
CloudError	Een foutreactie van de Batch-service.
CloudErrorBody	Een foutreactie van de Batch-service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Application

Object

Bevat informatie over een toepassing in een Batch-account.

Name	Type	Description
etag	string	De ETag van de resource die wordt gebruikt voor gelijktijdigheidsinstructies.
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.allowUpdates	boolean	Een waarde die aangeeft of pakketten in de toepassing kunnen worden overschreven met dezelfde versietekenreeks.
properties.defaultVersion	string	Het pakket dat moet worden gebruikt als een client de toepassing aanvraagt, maar geen versie opgeeft. Deze eigenschap kan alleen worden ingesteld op de naam van een bestaand pakket.
properties.displayName	string	De weergavenaam voor de toepassing.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	De tags van de resource.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CloudError

Object

Een foutreactie van de Batch-service.

Name	Type	Description
error	CloudErrorBody	De hoofdtekst van het foutbericht.

CloudErrorBody

Object

Een foutreactie van de Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.