forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Batch] Rollback the support for TokenCredential (Azure#16870)
* [Batch] Rollback the support for TokenCredential * address feedback * edit docstring * Update sdk/batch/batch/src/batchServiceClientContext.ts Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com> Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
- Loading branch information
Showing
5 changed files
with
94 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,121 +1,111 @@ | ||
| ## Azure BatchServiceClient SDK for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK (runs both in Node.js and in browsers) for BatchServiceClient. | ||
| This package contains an isomorphic SDK for BatchServiceClient. | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - [LTS versions of Node.js](https://nodejs.org/about/releases/) | ||
| - Latest versions of Safari, Chrome, Edge and Firefox. | ||
| - Latest versions of Safari, Chrome, Edge, and Firefox. | ||
|
|
||
| ### Prerequisites | ||
| See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. | ||
|
|
||
| You must have an [Azure subscription](https://azure.microsoft.com/free/). | ||
| ### How to Install | ||
|
|
||
| ### How to install | ||
| ```bash | ||
| npm install @azure/batch | ||
| ``` | ||
|
|
||
| To use this SDK in your project, you will need to install two packages. | ||
| ### How to use | ||
|
|
||
| - `@azure/batch` that contains the client. | ||
| - `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory. | ||
| #### nodejs - Authentication, client creation and list application as an example written in TypeScript. | ||
|
|
||
| Install both packages using the below command: | ||
| ##### Install @azure/ms-rest-nodeauth | ||
|
|
||
| ```bash | ||
| npm install --save @azure/batch @azure/identity | ||
| npm install @azure/ms-rest-nodeauth | ||
| ``` | ||
|
|
||
| > **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. | ||
| ### How to use | ||
| ##### Authentication | ||
|
|
||
| - 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. | ||
| 1. 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 | ||
|
|
||
| ```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); | ||
| }); | ||
| async function main(): Promise<void> { | ||
| try { | ||
| const creds = new BatchSharedKeyCredentials(batchAccountName, batchAccountKey); | ||
| const client = new BatchServiceClient(creds, batchEndpoint); | ||
| } catch (err) { | ||
| console.log(err); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### browser - Authentication, client creation, and list application as an example written in JavaScript. | ||
| 2. Use the `MSIVmTokenCredentials` exported from `@azure/ms-rest-nodeauth`. | ||
|
|
||
| In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser. | ||
| ```typescript | ||
| import { BatchServiceClient } from "@azure/batch"; | ||
| import { loginWithVmMSI } from "@azure/ms-rest-nodeauth"; | ||
|
|
||
| - 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. | ||
| 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); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| - 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> | ||
| ```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)); | ||
| ``` | ||
|
|
||
| ## Related projects | ||
|
|
||
| - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) | ||
|
|
||
|  | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters