Azure Batch client library for JavaScript - version 13.0.0

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Batch client.

Azure Batch provides Cloud-scale job scheduling and compute management.

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

Install the @azure/batch package

Install the Azure Batch client library for JavaScript with npm:

npm install @azure/batch

Create and authenticate a BatchClient

To create a client object to access the Azure Batch API, you will need the endpoint of your Azure Batch resource and a credential. The Azure Batch client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure Batch resource in the Azure Portal.

Azure batch supports authentication either via Microsoft Entra ID or Shared Key.

Microsoft Entra ID

You can authenticate with Azure Entra ID using a credential from the @azure/identity library or an existing AAD Token.

To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity package:

npm install @azure/identity

You will also need to register a new AAD application and grant access to Azure Batch by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out this guide.

Using Node.js and Node-like environments, you can use the DefaultAzureCredential class to authenticate the client.

import { BatchClient } from "@azure/batch";
import { DefaultAzureCredential } from "@azure/identity";

const client = new BatchClient("<endpoint>", new DefaultAzureCredential());

For browser environments, use the InteractiveBrowserCredential from the @azure/identity package to authenticate.

import { InteractiveBrowserCredential } from "@azure/identity";
import { BatchClient } from "@azure/batch";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new BatchClient("<endpoint>", credential);

Shared Key

To use shared key to authenticate, you must first npm install @azure/core-auth, then provide the account name and account key to construct the an AzureNamedKeyCredential credential from @azure/core-auth.

Noted that Share Key authentication is only supported in Node.js and Node-like environments.

import { AzureNamedKeyCredential } from "@azure/core-auth";
import { BatchClient } from "@azure/batch";

const credential = new AzureNamedKeyCredential("<account name>", "<account key>");
const client = new BatchClient("<endpoint>", credential);

JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.

Key concepts

BatchClient

BatchClient is the primary interface for developers using the Azure Batch client library. Explore the methods on this client object to understand the different features of the Azure Batch service that you can access.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

  • Last updated on