Azure · gingi · Aug 3, 2021 · Jul 29, 2021 · Jul 30, 2021 · Jul 30, 2021
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Microsoft
+Copyright (c) 2021 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

@@ -1,127 +1,121 @@
 ## Azure BatchServiceClient SDK for JavaScript
 
-This package contains an isomorphic SDK for BatchServiceClient.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for BatchServiceClient.
 
 ### Currently supported environments
 
-- Node.js version 6.x.x or higher
-- Browser JavaScript
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge and Firefox.
 
-### How to Install
+### Prerequisites
 
-```bash
-npm install @azure/batch
-```
+You must have an [Azure subscription](https://azure.microsoft.com/free/).
 
-### How to use
+### How to install
 
-#### nodejs - Authentication, client creation and list application as an example written in TypeScript.
+To use this SDK in your project, you will need to install two packages.
 
-##### Install @azure/ms-rest-nodeauth
+- `@azure/batch` that contains the client.
+- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
+
+Install both packages using the below command:
 
 ```bash
-npm install @azure/ms-rest-nodeauth
+npm install --save @azure/batch @azure/identity
 ```
 
-##### Authentication
-
-1. Use `AzureCliCredentials` exported from `@azure/ms-rest-nodeauth`.
-   **Please make sure to install Azure CLI and login using `az login`.**
+> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
+> If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.
 
-```typescript
-import { BatchServiceClient } from "@azure/batch";
-import { AzureCliCredentials } from "@azure/ms-rest-nodeauth";
+### How to use
 
-const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || "";
-async function main(): Promise<void> {
-  try {
-    const creds = await AzureCliCredentials.create({ resource: "https://batch.core.windows.net/" });
-    const client = new BatchServiceClient(creds, batchEndpoint);
-  } catch (err) {
-    console.log(err);
-  }
-}
-```
+- If you are writing a client side browser application,
+  - Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
+  - Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
+- If you are writing a server side application,
+  - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
+  - Complete the set up steps required by the credential if any.
+  - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
 
-2. Use the `BatchSharedKeyCredentials` exported from `@azure/batch`.
+In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
+Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
 
-```typescript
-import { BatchServiceClient, BatchSharedKeyCredentials } from "@azure/batch";
+#### nodejs - Authentication, client creation, and list application as an example written in JavaScript.
 
-const batchAccountName = process.env["AZURE_BATCH_ACCOUNT_NAME"] || "";
-const batchAccountKey = process.env["AZURE_BATCH_ACCOUNT_KEY"] || "";
-const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || "";
+##### Sample code
 
-async function main(): Promise<void> {
-  try {
-    const creds = new BatchSharedKeyCredentials(batchAccountName, batchAccountKey);
-    const client = new BatchServiceClient(creds, batchEndpoint);
-  } catch (err) {
-    console.log(err);
-  }
-}
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { BatchServiceClient } = require("@azure/batch");
+const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
+
+// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
+// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
+const creds = new DefaultAzureCredential();
+const client = new BatchServiceClient(creds, subscriptionId);
+const maxResults = 1;
+const timeout = 1;
+const clientRequestId = ec7b1657-199d-4d8a-bbb2-89a11a42e02a;
+const returnClientRequestId = true;
+const ocpDate = new Date().toUTCString();
+client.application.list(maxResults, timeout, clientRequestId, returnClientRequestId, ocpDate).then((result) => {
+  console.log("The result is:");
+  console.log(result);
+}).catch((err) => {
+  console.log("An error occurred:");
+  console.error(err);
+});
 ```
 
-3. Use the `MSIVmTokenCredentials` exported from `@azure/ms-rest-nodeauth`.
+#### browser - Authentication, client creation, and list application as an example written in JavaScript.
 
-```typescript
-import { BatchServiceClient } from "@azure/batch";
-import { loginWithVmMSI } from "@azure/ms-rest-nodeauth";
+In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
 
-const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || "";
-
-async function main(): Promise<void> {
-  try {
-    const creds = await loginWithVmMSI({
-      resource: "https://batch.core.windows.net/"
-    });
-    const client = new BatchServiceClient(creds, batchEndpoint);
-  } catch (err) {
-    console.log(err);
-  }
-}
-```
+- See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
+- Note down the client Id from the previous step and use it in the browser sample below.
 
 ##### Sample code
 
-```typescript
-import { BatchServiceClient, BatchServiceModels, BatchSharedKeyCredentials } from "@azure/batch";
-
-const batchAccountName = process.env["AZURE_BATCH_ACCOUNT_NAME"] || "";
-const batchAccountKey = process.env["AZURE_BATCH_ACCOUNT_KEY"] || "";
-const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || "";
-
-const creds = new BatchSharedKeyCredentials(batchAccountName, batchAccountKey);
-const client = new BatchServiceClient(creds, batchEndpoint);
-
-const options: BatchServiceModels.JobListOptionalParams = {
-  jobListOptions: { maxResults: 10 }
-};
-
-async function loop(res: BatchServiceModels.JobListResponse, nextLink?: string): Promise<void> {
-  if (nextLink !== undefined) {
-    const res1 = await client.job.listNext(nextLink);
-    if (res1.length) {
-      for (const item of res1) {
-        res.push(item);
-      }
-    }
-    return loop(res, res1.odatanextLink);
-  }
-  return Promise.resolve();
-}
-
-async function main(): Promise<void> {
-  const result = await client.job.list(options);
-  await loop(result, result.odatanextLink);
-  console.dir(result, { depth: null, colors: true });
-}
-
-main().catch((err) => console.log("An error occurred: ", err));
+- index.html
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>@azure/batch sample</title>
+    <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
+    <script src="node_modules/@azure/identity/dist/index.js"></script>
+    <script src="node_modules/@azure/batch/dist/batch.js"></script>
+    <script type="text/javascript">
+      const subscriptionId = "<Subscription_Id>";
+      // Create credentials using the `@azure/identity` package.
+      // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
+      const credential = new InteractiveBrowserCredential(
+      {
+        clientId: "<client id for your Azure AD app>",
+        tenant: "<optional tenant for your organization>"
+      });
+      const client = new Azure.Batch.BatchServiceClient(creds, subscriptionId);
+      const maxResults = 1;
+      const timeout = 1;
+      const clientRequestId = ec7b1657-199d-4d8a-bbb2-89a11a42e02a;
+      const returnClientRequestId = true;
+      const ocpDate = new Date().toUTCString();
+      client.application.list(maxResults, timeout, clientRequestId, returnClientRequestId, ocpDate).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
+      });
+    </script>
+  </head>
+  <body></body>
+</html>
 ```
 
 ## Related projects
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fbatch%2Fbatch%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/batch/batch/README.png)
@@ -0,0 +1,137 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// https://github.com/karma-runner/karma-chrome-launcher
+process.env.CHROME_BIN = require("puppeteer").executablePath();
+require("dotenv").config();
+const {
+  jsonRecordingFilterFunction,
+  isPlaybackMode,
+  isSoftRecordMode,
+  isRecordMode
+} = require("@azure/test-utils-recorder");
+
+module.exports = function(config) {
+  config.set({
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: "./",
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ["mocha"],
+
+    plugins: [
+      "karma-mocha",
+      "karma-mocha-reporter",
+      "karma-chrome-launcher",
+      "karma-edge-launcher",
+      "karma-firefox-launcher",
+      "karma-ie-launcher",
+      "karma-env-preprocessor",
+      "karma-coverage",
+      "karma-junit-reporter",
+      "karma-json-to-file-reporter",
+      "karma-json-preprocessor"
+    ],
+
+    // list of files / patterns to load in the browser
+    files: [
+      "dist-test/index.browser.js",
+      { pattern: "dist-test/index.browser.js.map", type: "html", included: false, served: true }
+    ].concat(isPlaybackMode() || isSoftRecordMode() ? ["recordings/browsers/**/*.json"] : []),
+
+    // list of files / patterns to exclude
+    exclude: [],
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      "**/*.js": ["env"],
+      "recordings/browsers/**/*.json": ["json"]
+      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!
+      // Preprocess source file to calculate code coverage, however this will make source file unreadable
+      //"dist-test/index.browser.js": ["coverage"]
+    },
+
+    envPreprocessor: [
+      "TEST_MODE",
+      "AZURE_BATCH_ENDPOINT",
+      "AZURE_BATCH_ACCOUNT",
+      "AZURE_BATCH_ACCESS_KEY",
+      "AZURE_CLIENT_ID",
+      "AZURE_CLIENT_SECRET"
+    ],
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ["mocha", "coverage", "junit", "json-to-file"],
+
+    coverageReporter: {
+      // specify a common output directory
+      dir: "coverage-browser/",
+      reporters: [{ type: "json", subdir: ".", file: "coverage.json" }]
+    },
+
+    junitReporter: {
+      outputDir: "", // results will be saved as $outputDir/$browserName.xml
+      outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile
+      suite: "", // suite will become the package name attribute in xml testsuite element
+      useBrowserName: false, // add browser name to report and classes names
+      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
+      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
+      properties: {} // key value pair of properties to add to the <properties> section of the report
+    },
+
+    jsonToFileReporter: {
+      filter: jsonRecordingFilterFunction,
+      outputPath: "."
+    },
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+    // --no-sandbox allows our tests to run in Linux without having to change the system.
+    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.
+    browsers: ["ChromeHeadlessNoSandbox"],
+    customLaunchers: {
+      ChromeHeadlessNoSandbox: {
+        base: "ChromeHeadless",
+        flags: ["--no-sandbox", "--disable-web-security"]
+      }
+    },
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: true,
+
+    // Concurrency level
+    // how many browser should be started simultaneous
+    concurrency: 1,
+
+    browserNoActivityTimeout: 600000,
+    browserDisconnectTimeout: 10000,
+    browserDisconnectTolerance: 3,
+    browserConsoleLogOptions: {
+      terminal: !isRecordMode()
+    },
+
+    client: {
+      mocha: {
+        // change Karma's debug.html to the mocha web reporter
+        reporter: "html",
+        timeout: "600000"
+      }
+    }
+  });
+};