Application - List

Service:

Batch Management

API Version:

2024-02-01

Lists all of the applications in the specified account.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the Batch account. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	The name of the resource group that contains the Batch account.
subscriptionId	path	True	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
api-version	query	True	string	The API version to be used with the HTTP request.
maxresults	query		integer int32	The maximum number of items to return in the response.

Responses

Name	Type	Description
200 OK	ListApplicationsResult	The operation was successful. The response contains a list of the application entities associated with the specified account.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApplicationList

Sample Request

HTTP

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

Java

/**
 * Samples for Application List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationList.json
     */
    /**
     * Sample code: ApplicationList.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void applicationList(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.applications().list("default-azurebatch-japaneast", "sampleacct", null,
            com.azure.core.util.Context.NONE);
    }
}

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_list.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.list(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationList.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/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/ApplicationList.json
func ExampleApplicationClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewApplicationClient().NewListPager("default-azurebatch-japaneast", "sampleacct", &armbatch.ApplicationClientListOptions{Maxresults: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListApplicationsResult = armbatch.ListApplicationsResult{
		// 	Value: []*armbatch.Application{
		// 		{
		// 			Name: to.Ptr("app1"),
		// 			Type: to.Ptr("Microsoft.Batch/batchAccounts/applications"),
		// 			Etag: to.Ptr("W/\"0x8D64F91A9089879\""),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1"),
		// 			Properties: &armbatch.ApplicationProperties{
		// 				AllowUpdates: to.Ptr(false),
		// 				DefaultVersion: to.Ptr("1"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("app1"),
		// 			Type: to.Ptr("Microsoft.Batch/batchAccounts/applications"),
		// 			Etag: to.Ptr("W/\"0x8D64F91A9089879\""),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2"),
		// 			Properties: &armbatch.ApplicationProperties{
		// 				AllowUpdates: to.Ptr(false),
		// 				DefaultVersion: to.Ptr("2.0"),
		// 				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 Lists all of the applications in the specified account.
 *
 * @summary Lists all of the applications in the specified account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationList.json
 */
async function applicationList() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.applicationOperations.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/ApplicationList.json
// this example is just showing the usage of "Application_List" 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 BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// get the collection of this BatchApplicationResource
BatchApplicationCollection collection = batchAccount.GetBatchApplications();

// invoke the operation and iterate over the result
await foreach (BatchApplicationResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "type": "Microsoft.Batch/batchAccounts/applications",
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1",
      "name": "app1",
      "etag": "W/\"0x8D64F91A9089879\"",
      "properties": {
        "allowUpdates": false,
        "defaultVersion": "1"
      }
    },
    {
      "type": "Microsoft.Batch/batchAccounts/applications",
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2",
      "name": "app1",
      "etag": "W/\"0x8D64F91A9089879\"",
      "properties": {
        "allowUpdates": false,
        "defaultVersion": "2.0",
        "displayName": "myAppName"
      }
    }
  ]
}

Definitions

Name	Description
Application	Contains information about an application in a Batch account.
CloudError	An error response from the Batch service.
CloudErrorBody	An error response from the Batch service.
ListApplicationsResult	The result of performing list applications.

Application

Contains information about an application in a Batch account.

Name	Type	Description
etag	string	The ETag of the resource, used for concurrency statements.
id	string	The ID of the resource.
name	string	The name of the resource.
properties.allowUpdates	boolean	A value indicating whether packages within the application may be overwritten using the same version string.
properties.defaultVersion	string	The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
properties.displayName	string	The display name for the application.
type	string	The type of the resource.

CloudError

An error response from the Batch service.

Name	Type	Description
error	CloudErrorBody	The body of the error response.

CloudErrorBody

An error response from the Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ListApplicationsResult

The result of performing list applications.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	Application[]	The list of applications.