@azure-rest/batch 1.0.0-beta.1

package/README.md

@@ -0,0 +1,75 @@
+# Azure Batch REST client library for JavaScript
+
+Azure Batch provides Cloud-scale job scheduling and compute management.
+
+**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+Key links:
+
+TODO: Add links back when the package is published
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+
+### Install the `@azure-rest/batch` package
+
+Install the Azure Batch REST client library for JavaScript with `npm`:
+
+```bash
+npm install @azure-rest/batch
+```
+
+### Create and authenticate a `BatchClient`
+
+Azure batch supports authentication either via Microsoft Entra ID or Shared Key.
+
+- [Microsoft Entra ID](#microsoft-entra-id)
+- [Shared Key](#shared-key)
+
+#### Microsoft Entra ID
+
+To use an [Microsoft Entra ID token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with Microsoft Entra ID, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+Set the values of the client ID, tenant ID, and client secret of the Microsoft Entra ID application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+#### Shared Key
+
+To use shared key to authenticate, you must first `npm` install [`@azure/core-auth`](https://www.npmjs.com/package/@azure/core-auth), then provide the account name and account key to construct the an `AzureNamedKeyCredential` credential from `@azure/core-auth`
+
+```typescript
+import { AzureNamedKeyCredential } from "@azure/core-auth";
+import createClient from "@azure-rest/batch";
+
+const credential = new AzureNamedKeyCredential("<account name>", "<account key>");
+const batchClient = createClient("<account endpoint>", credential);
+```
+
+## 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`:
+
+```javascript
+const { setLogLevel } = require("@azure/logger");
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/dist/browser/batchClient.d.ts

@@ -0,0 +1,16 @@
+import { ClientOptions } from "@azure-rest/core-client";
+import { TokenCredential, AzureNamedKeyCredential } from "@azure/core-auth";
+import { BatchClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface BatchClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `BatchClient`
+ * @param endpointParam - Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(endpointParam: string, credentials: TokenCredential | AzureNamedKeyCredential, { apiVersion, ...options }?: BatchClientOptions): BatchClient;
+//# sourceMappingURL=batchClient.d.ts.map

package/dist/browser/batchClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchClient.d.ts","sourceRoot":"","sources":["../../src/batchClient.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAqB,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,6CAA6C;AAC7C,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,GAAG,uBAAuB,EACtD,EAAE,UAA8B,EAAE,GAAG,OAAO,EAAE,GAAE,kBAAuB,GACtE,WAAW,CA8Db"}

package/dist/browser/batchClient.js

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { __rest } from "tslib";
+import { getClient } from "@azure-rest/core-client";
+import { logger } from "./logger.js";
+import { isTokenCredential } from "@azure/core-auth";
+import { createBatchSharedKeyCredentialsPolicy } from "./credentials/batchSharedKeyCredentials.js";
+import { createReplacePoolPropertiesPolicy } from "./replacePoolPropertiesPolicy.js";
+/**
+ * Initialize a new instance of `BatchClient`
+ * @param endpointParam - Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(endpointParam, credentials, _a = {}) {
+    var _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    var { apiVersion = "2024-02-01.19.0" } = _a, options = __rest(_a, ["apiVersion"]);
+    const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `${endpointParam}`;
+    const userAgentInfo = `azsdk-js-batch-rest/1.0.0-beta.1`;
+    const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+        : `${userAgentInfo}`;
+    options = Object.assign(Object.assign({}, options), { userAgentOptions: {
+            userAgentPrefix,
+        }, loggingOptions: {
+            logger: (_e = (_d = options.loggingOptions) === null || _d === void 0 ? void 0 : _d.logger) !== null && _e !== void 0 ? _e : logger.info,
+        }, telemetryOptions: {
+            clientRequestIdHeaderName: (_g = (_f = options.telemetryOptions) === null || _f === void 0 ? void 0 : _f.clientRequestIdHeaderName) !== null && _g !== void 0 ? _g : "client-request-id",
+        }, credentials: {
+            scopes: (_j = (_h = options.credentials) === null || _h === void 0 ? void 0 : _h.scopes) !== null && _j !== void 0 ? _j : ["https://batch.core.windows.net//.default"],
+        }, additionalPolicies: [
+            ...((_k = options === null || options === void 0 ? void 0 : options.additionalPolicies) !== null && _k !== void 0 ? _k : []),
+            // TODO: remove after service remove certificate feature completely
+            {
+                policy: createReplacePoolPropertiesPolicy(),
+                position: "perCall",
+            },
+        ] });
+    const addClientApiVersionPolicy = (client) => {
+        client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
+        client.pipeline.addPolicy({
+            name: "ClientApiVersionPolicy",
+            sendRequest: (req, next) => {
+                // Use the apiVersion defined in request url directly
+                // Append one if there is no apiVersion and we have one at client options
+                const url = new URL(req.url);
+                if (!url.searchParams.get("api-version") && apiVersion) {
+                    req.url = `${req.url}${Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
+                }
+                return next(req);
+            },
+        });
+        return client;
+    };
+    // Customization for BatchClient, shouldn't be overwritten by codegen
+    if (isTokenCredential(credentials)) {
+        const client = getClient(endpointUrl, credentials, options);
+        return addClientApiVersionPolicy(client);
+    }
+    // If the credentials are not a TokenCredential, we need to add a policy to handle the shared key auth.
+    const client = getClient(endpointUrl, options);
+    const authPolicy = createBatchSharedKeyCredentialsPolicy(credentials);
+    client.pipeline.addPolicy(authPolicy);
+    return addClientApiVersionPolicy(client);
+}
+//# sourceMappingURL=batchClient.js.map

package/dist/browser/batchClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchClient.js","sourceRoot":"","sources":["../../src/batchClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAE,SAAS,EAAiB,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAA4C,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/F,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAAE,iCAAiC,EAAE,MAAM,kCAAkC,CAAC;AAQrF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAAsD,EACtD,KAAqE,EAAE;;QAAvE,EAAE,UAAU,GAAG,iBAAiB,OAAuC,EAAlC,OAAO,cAA5C,cAA8C,CAAF;IAE5C,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,EAAE,CAAC;IAC9E,MAAM,aAAa,GAAG,kCAAkC,CAAC;IACzD,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,gBAAgB,EAAE;YAChB,yBAAyB,EACvB,MAAA,MAAA,OAAO,CAAC,gBAAgB,0CAAE,yBAAyB,mCAAI,mBAAmB;SAC7E,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,0CAA0C,CAAC;SACpF,EACD,kBAAkB,EAAE;YAClB,GAAG,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,mCAAI,EAAE,CAAC;YACtC,mEAAmE;YACnE;gBACE,MAAM,EAAE,iCAAiC,EAAE;gBAC3C,QAAQ,EAAE,SAAS;aACpB;SACF,GACF,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,MAAmB,EAAe,EAAE;QACrE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxB,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBACzB,qDAAqD;gBACrD,yEAAyE;gBACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;oBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;gBAC9B,CAAC;gBAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,qEAAqE;IACrE,IAAI,iBAAiB,CAAC,WAAW,CAAC,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAgB,CAAC;QAC3E,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,uGAAuG;IACvG,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,OAAO,CAAgB,CAAC;IAC9D,MAAM,UAAU,GAAG,qCAAqC,CAAC,WAAW,CAAC,CAAC;IACtE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtC,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { getClient, ClientOptions } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport { TokenCredential, AzureNamedKeyCredential, isTokenCredential } from \"@azure/core-auth\";\nimport { BatchClient } from \"./clientDefinitions.js\";\nimport { createBatchSharedKeyCredentialsPolicy } from \"./credentials/batchSharedKeyCredentials.js\";\nimport { createReplacePoolPropertiesPolicy } from \"./replacePoolPropertiesPolicy.js\";\n\n/** The optional parameters for the client */\nexport interface BatchClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `BatchClient`\n * @param endpointParam - Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential | AzureNamedKeyCredential,\n  { apiVersion = \"2024-02-01.19.0\", ...options }: BatchClientOptions = {},\n): BatchClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;\n  const userAgentInfo = `azsdk-js-batch-rest/1.0.0-beta.1`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    telemetryOptions: {\n      clientRequestIdHeaderName:\n        options.telemetryOptions?.clientRequestIdHeaderName ?? \"client-request-id\",\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://batch.core.windows.net//.default\"],\n    },\n    additionalPolicies: [\n      ...(options?.additionalPolicies ?? []),\n      // TODO: remove after service remove certificate feature completely\n      {\n        policy: createReplacePoolPropertiesPolicy(),\n        position: \"perCall\",\n      },\n    ],\n  };\n\n  const addClientApiVersionPolicy = (client: BatchClient): BatchClient => {\n    client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n    client.pipeline.addPolicy({\n      name: \"ClientApiVersionPolicy\",\n      sendRequest: (req, next) => {\n        // Use the apiVersion defined in request url directly\n        // Append one if there is no apiVersion and we have one at client options\n        const url = new URL(req.url);\n        if (!url.searchParams.get(\"api-version\") && apiVersion) {\n          req.url = `${req.url}${\n            Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n          }api-version=${apiVersion}`;\n        }\n\n        return next(req);\n      },\n    });\n    return client;\n  };\n\n  // Customization for BatchClient, shouldn't be overwritten by codegen\n  if (isTokenCredential(credentials)) {\n    const client = getClient(endpointUrl, credentials, options) as BatchClient;\n    return addClientApiVersionPolicy(client);\n  }\n  // If the credentials are not a TokenCredential, we need to add a policy to handle the shared key auth.\n  const client = getClient(endpointUrl, options) as BatchClient;\n  const authPolicy = createBatchSharedKeyCredentialsPolicy(credentials);\n  client.pipeline.addPolicy(authPolicy);\n  return addClientApiVersionPolicy(client);\n}\n"]}