Application - Update

Service:

Batch Management

API Version:

2024-02-01

Aggiornamenti impostazioni per l'applicazione specificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account Batch. Regex pattern: ^[a-zA-Z0-9]+$
applicationName	path	True	string	Nome dell'applicazione. Questo deve essere univoco all'interno dell'account. Regex pattern: ^[a-zA-Z0-9_-]+$
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'account Batch.
subscriptionId	path	True	string	ID sottoscrizione di Azure. Si tratta di una stringa con formato GUID (ad esempio 00000000000-0000-0000-0000-000000000000000)
api-version	query	True	string	Versione dell'API da usare con la richiesta HTTP.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.allowUpdates	boolean	Valore che indica se i pacchetti all'interno dell'applicazione possono essere sovrascritti usando la stessa stringa di versione.
properties.defaultVersion	string	Il pacchetto da usare se un client richiede l'applicazione ma non specifica una versione. Questa proprietà può essere impostata solo sul nome di un pacchetto esistente.
properties.displayName	string	Nome visualizzato dell'applicazione.

Risposte

Nome	Tipo	Descrizione
200 OK	Application	L'operazione è stata completata. La risposta contiene l'entità dell'applicazione.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApplicationUpdate

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1?api-version=2024-02-01

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

Java

import com.azure.resourcemanager.batch.models.Application;

/**
 * Samples for Application Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationUpdate.json
     */
    /**
     * Sample code: ApplicationUpdate.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void applicationUpdate(com.azure.resourcemanager.batch.BatchManager manager) {
        Application resource = manager.applications()
            .getWithResponse("default-azurebatch-japaneast", "sampleacct", "app1", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withDisplayName("myAppName").withAllowUpdates(true).withDefaultVersion("2").apply();
    }
}

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

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="subid",
    )

    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: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/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("<subscription-id>", 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.Application = armbatch.Application{
	// 	Name: to.Ptr("app1"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/applications"),
	// 	Etag: to.Ptr("W/\"0x8D64F915BDF7F00\""),
	// 	ID: to.Ptr("/subscriptions/subid/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: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationUpdate.json
 */
async function applicationUpdate() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const applicationName = "app1";
  const parameters = {
    allowUpdates: true,
    defaultVersion: "2",
    displayName: "myAppName",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.applicationOperations.update(
    resourceGroupName,
    accountName,
    applicationName,
    parameters,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-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 = "subid";
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

Sample Response

Status code:

200

ETag: W/"0x8D64F915BDF7F00"

Response Body

{
  "type": "Microsoft.Batch/batchAccounts/applications",
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
  "name": "app1",
  "etag": "W/\"0x8D64F915BDF7F00\"",
  "properties": {
    "allowUpdates": true,
    "displayName": "myAppName",
    "defaultVersion": "2"
  }
}

Definizioni

Nome	Descrizione
Application	Contiene informazioni su un'applicazione in un account Batch.
CloudError	Risposta di errore dal servizio Batch.
CloudErrorBody	Risposta di errore dal servizio Batch.

Application

Contiene informazioni su un'applicazione in un account Batch.

Nome	Tipo	Descrizione
etag	string	ETag della risorsa usata per le istruzioni di concorrenza.
id	string	ID della risorsa.
name	string	Nome della risorsa.
properties.allowUpdates	boolean	Valore che indica se i pacchetti all'interno dell'applicazione possono essere sovrascritti usando la stessa stringa di versione.
properties.defaultVersion	string	Il pacchetto da usare se un client richiede l'applicazione ma non specifica una versione. Questa proprietà può essere impostata solo sul nome di un pacchetto esistente.
properties.displayName	string	Nome visualizzato dell'applicazione.
type	string	Tipo di risorsa.

CloudError

Risposta di errore dal servizio Batch.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo della risposta all'errore.

CloudErrorBody

Risposta di errore dal servizio Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in caso di errore.