Application Package - Activate

Usługa:

Batch Management

Wersja interfejsu API:

2025-06-01

Aktywuje określony pakiet aplikacji. Należy to zrobić po utworzeniu i przekazaniu ApplicationPackage. Należy to zrobić, zanim będzie można użyć ApplicationPackage w pulach lub zadaniach.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Nazwa konta wsadowego, która musi być unikalna w danym regionie. Nazwy kont wsadowych muszą mieć długość od 3 do 24 znaków i zawierać jedynie cyfry oraz małe litery. Ta nazwa jest używana jako część nazwy DNS, która służy do dostępu do usługi Batch w regionie, w którym konto zostało utworzone. Na przykład: http://accountname.region.batch.azure.com/.
applicationName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	Nazwa aplikacji. Musi to być unikatowe w ramach konta.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
versionName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$	Wersja aplikacji.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
format	True	string	Format pliku binarnego pakietu aplikacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApplicationPackage	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApplicationPackageActivate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
ActivateApplicationPackageParameters	Parametry aktywowania pakietu aplikacji.
ApplicationPackage	Pakiet aplikacji reprezentujący określoną wersję aplikacji.
CloudError	Odpowiedź na błąd z usługi Batch.
CloudErrorBody	Odpowiedź na błąd z usługi Batch.
createdByType	Typ tożsamości, która utworzyła zasób.
PackageState	Bieżący stan pakietu aplikacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ActivateApplicationPackageParameters

Objekt

Parametry aktywowania pakietu aplikacji.

Nazwa	Typ	Opis
format	string	Format pliku binarnego pakietu aplikacji.

ApplicationPackage

Objekt

Pakiet aplikacji reprezentujący określoną wersję aplikacji.

Nazwa	Typ	Opis
etag	string	Element ETag zasobu używany na potrzeby instrukcji współbieżności.
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.format	string	Format pakietu aplikacji, jeśli pakiet jest aktywny.
properties.lastActivationTime	string (date-time)	Czas ostatniego aktywowania pakietu, jeśli pakiet jest aktywny.
properties.state	PackageState	Bieżący stan pakietu aplikacji.
properties.storageUrl	string	Adres URL pakietu aplikacji w usłudze Azure Storage.
properties.storageUrlExpiry	string (date-time)	Godzina UTC, o której wygaśnie adres URL usługi Azure Storage.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobu.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

CloudError

Objekt

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść odpowiedzi o błędzie.

CloudErrorBody

Objekt

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

PackageState

Wyliczenie

Bieżący stan pakietu aplikacji.

Wartość	Opis
Pending	Pakiet aplikacji został utworzony, ale nie został jeszcze aktywowany.
Active	Pakiet aplikacji jest gotowy do użycia.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.