Application Package - Activate

Servicio:

Batch Management

Versión de la API:

2025-06-01

Activa el paquete de aplicación especificado. Esto debe hacerse después de crear y cargar el ApplicationPackage. Esto debe hacerse antes de que se pueda usar una ApplicationPackage en grupos o tareas.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Un nombre para la cuenta de lote que debe ser único dentro de la región. Los nombres de las cuentas de lote deben tener entre 3 y 24 caracteres de longitud y deben usar solo números y letras minúsculas. Este nombre se utiliza como parte del nombre DNS que se utiliza para acceder al servicio por lotes en la región donde se crea la cuenta. Por ejemplo: http://accountname.region.batch.azure.com/.
applicationName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	Nombre de la aplicación. Debe ser único dentro de la cuenta.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
versionName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$	Versión de la aplicación.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
format	True	string	Formato del archivo binario del paquete de aplicación.

Respuestas

Nombre	Tipo	Description
200 OK	ApplicationPackage	La operación de Azure se completó correctamente.
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApplicationPackageActivate

Solicitud de ejemplo

HTTP

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

{
  "format": "zip"
}

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_package_activate.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_package.activate(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        application_name="app1",
        version_name="1",
        parameters={"format": "zip"},
    )
    print(response)


# x-ms-original-file: 2025-06-01/ApplicationPackageActivate.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/ApplicationPackageActivate.json
func ExampleApplicationPackageClient_Activate() {
	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.NewApplicationPackageClient().Activate(ctx, "default-azurebatch-japaneast", "sampleacct", "app1", "1", armbatch.ActivateApplicationPackageParameters{
		Format: to.Ptr("zip"),
	}, 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.ApplicationPackageClientActivateResponse{
	// 	ApplicationPackage: &armbatch.ApplicationPackage{
	// 		Name: to.Ptr("1"),
	// 		Type: to.Ptr("Microsoft.Batch/batchAccounts/applications/versions"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1"),
	// 		Properties: &armbatch.ApplicationPackageProperties{
	// 			Format: to.Ptr("zip"),
	// 			LastActivationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-27T18:48:09.9330991Z"); return t}()),
	// 			State: to.Ptr(armbatch.PackageStateActive),
	// 		},
	// 	},
	// }
}

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 activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.
 *
 * @summary activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.
 * x-ms-original-file: 2025-06-01/ApplicationPackageActivate.json
 */
async function applicationPackageActivate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.applicationPackage.activate(
    "default-azurebatch-japaneast",
    "sampleacct",
    "app1",
    "1",
    { format: "zip" },
  );
  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.Models;
using Azure.ResourceManager.Batch;

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

// invoke the operation
BatchApplicationPackageActivateContent content = new BatchApplicationPackageActivateContent("zip");
BatchApplicationPackageResource result = await batchApplicationPackage.ActivateAsync(content);

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

Respuesta de muestra

status code:

200

ETag: W/"0x8D64FEC83A3B436"

{
  "name": "1",
  "type": "Microsoft.Batch/batchAccounts/applications/versions",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1",
  "properties": {
    "format": "zip",
    "lastActivationTime": "2017-06-27T18:48:09.9330991Z",
    "state": "Active"
  }
}

Definiciones

Nombre	Description
ActivateApplicationPackageParameters	Parámetros para activar un paquete de aplicación.
ApplicationPackage	Un paquete de aplicación que representa una versión determinada de una aplicación.
CloudError	Respuesta de error del servicio Batch.
CloudErrorBody	Respuesta de error del servicio Batch.
createdByType	Tipo de identidad que creó el recurso.
PackageState	Estado actual del paquete de aplicación.
systemData	Metadatos relativos a la creación y última modificación del recurso.

ActivateApplicationPackageParameters

Objeto

Parámetros para activar un paquete de aplicación.

Nombre	Tipo	Description
format	string	Formato del archivo binario del paquete de aplicación.

ApplicationPackage

Objeto

Un paquete de aplicación que representa una versión determinada de una aplicación.

Nombre	Tipo	Description
etag	string	ETag del recurso, que se usa para las instrucciones de simultaneidad.
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.format	string	El formato del paquete de aplicación, si el paquete está activo.
properties.lastActivationTime	string (date-time)	Hora a la que se activó por última vez el paquete, si el paquete está activo.
properties.state	PackageState	Estado actual del paquete de aplicación.
properties.storageUrl	string	Dirección URL del paquete de aplicación en Azure Storage.
properties.storageUrlExpiry	string (date-time)	Hora UTC a la que expirará la dirección URL de Azure Storage.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

CloudError

Objeto

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo de la respuesta de error.

CloudErrorBody

Objeto

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

PackageState

Enumeración

Estado actual del paquete de aplicación.

Valor	Description
Pending	Se ha creado el paquete de aplicación, pero aún no se ha activado.
Active	El paquete de aplicación está listo para su uso.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.