From 8cacc127fe4dc1f23ab980a74774b65945e9cbdc Mon Sep 17 00:00:00 2001 From: Amar Zavery Date: Mon, 20 May 2019 17:47:22 -0700 Subject: [PATCH] Exposing BatchSharedKeyCredentials in @azure/batch (#2998) * initial commit * updating version to 7.0.0 * Resolved rollup issues and addressed review feedback --- sdk/batch/batch/LICENSE.txt | 2 +- sdk/batch/batch/README.md | 154 +- sdk/batch/batch/package.json | 24 +- sdk/batch/batch/rollup.config.js | 35 +- sdk/batch/batch/src/batchIndex.ts | 14 + sdk/batch/batch/src/batchServiceClient.ts | 6 +- .../batch/src/batchServiceClientContext.ts | 15 +- .../batch/src/batchSharedKeyCredentials.ts | 199 + sdk/batch/batch/src/hmacSha256.ts | 36 + sdk/batch/batch/src/models/accountMappers.ts | 21 +- .../batch/src/models/applicationMappers.ts | 13 +- .../models/certificateOperationsMappers.ts | 23 +- .../models/computeNodeOperationsMappers.ts | 69 +- sdk/batch/batch/src/models/fileMappers.ts | 23 +- sdk/batch/batch/src/models/index.ts | 10708 ++++++---------- sdk/batch/batch/src/models/jobMappers.ts | 122 +- .../batch/src/models/jobScheduleMappers.ts | 104 +- sdk/batch/batch/src/models/mappers.ts | 269 +- sdk/batch/batch/src/models/parameters.ts | 850 +- sdk/batch/batch/src/models/poolMappers.ts | 97 +- sdk/batch/batch/src/models/taskMappers.ts | 75 +- sdk/batch/batch/src/operations/account.ts | 38 +- sdk/batch/batch/src/operations/application.ts | 6 +- .../src/operations/certificateOperations.ts | 57 +- .../src/operations/computeNodeOperations.ts | 118 +- sdk/batch/batch/src/operations/file.ts | 104 +- sdk/batch/batch/src/operations/job.ts | 209 +- sdk/batch/batch/src/operations/jobSchedule.ts | 168 +- sdk/batch/batch/src/operations/pool.ts | 134 +- sdk/batch/batch/src/operations/task.ts | 139 +- 30 files changed, 5498 insertions(+), 8334 deletions(-) create mode 100644 sdk/batch/batch/src/batchIndex.ts create mode 100644 sdk/batch/batch/src/batchSharedKeyCredentials.ts create mode 100644 sdk/batch/batch/src/hmacSha256.ts diff --git a/sdk/batch/batch/LICENSE.txt b/sdk/batch/batch/LICENSE.txt index a70e8cf66038..b73b4a1293c3 100644 --- a/sdk/batch/batch/LICENSE.txt +++ b/sdk/batch/batch/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 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 diff --git a/sdk/batch/batch/README.md b/sdk/batch/batch/README.md index d8abab4b3627..ca032ded0ec3 100644 --- a/sdk/batch/batch/README.md +++ b/sdk/batch/batch/README.md @@ -9,7 +9,7 @@ This package contains an isomorphic SDK for BatchServiceClient. ### How to Install -``` +```bash npm install @azure/batch ``` @@ -19,91 +19,107 @@ npm install @azure/batch ##### Install @azure/ms-rest-nodeauth -``` +```bash npm install @azure/ms-rest-nodeauth ``` -##### Sample code +##### Authentication -```ts -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; -import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; -import { BatchServiceClient, BatchServiceModels, BatchServiceMappers } from "@azure/batch"; -const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; - -msRestNodeAuth.interactiveLogin().then((creds) => { - 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.error(err); -}); +1. Use `AzureCliCredentials` exported from `@azure/ms-rest-nodeauth`. + **Please make sure to install Azure CLI and login using `az login`.** + +```typescript +import { AzureCliCredentials } from "@azure/ms-rest-nodeauth"; + +const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || ""; +async function main(): Promise { + try { + const creds = await AzureCliCredentials.create({ resource: "https://batch.core.windows.net/" }); + 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 `BatchSharedKeyCredentials` exported from `@azure/batch`. + +```typescript +import { BatchServiceClient, BatchSharedKeyCredentials } from "@azure/batch"; -##### Install @azure/ms-rest-browserauth +const batchAccountName = process.env["AZURE_BATCH_ACCOUNT_NAME"] || ""; +const batchAccountKey = process.env["AZURE_BATCH_ACCOUNT_KEY"] || ""; +const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || ""; +async function main(): Promise { + try { + const creds = new BatchSharedKeyCredentials(batchAccountName, batchAccountKey); + const client = new BatchServiceClient(creds, batchEndpoint); + } catch (err) { + console.log(err); + } +} ``` -npm install @azure/ms-rest-browserauth + +3. Use the `MSIVmTokenCredentials` exported from `@azure/ms-rest-nodeauth`. + +```typescript +import { MSIVmTokenCredentials } from "@azure/ms-rest-nodeauth"; + +const batchEndpoint = process.env["AZURE_BATCH_ENDPOINT"] || ""; + +async function main(): Promise { + try { + const creds = await msRestNodeAuth.loginWithVmMSI({ + resource: "https://batch.core.windows.net/" + }); + const client = new BatchServiceClient(creds, batchEndpoint); + } catch (err) { + console.log(err); + } +} ``` ##### Sample code -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. - -- index.html -```html - - - - @azure/batch sample - - - - - - - - +```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 { + 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 { + 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) - ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/batch/batch/README.png) diff --git a/sdk/batch/batch/package.json b/sdk/batch/batch/package.json index 42fc6dc1d957..2f86413f6100 100644 --- a/sdk/batch/batch/package.json +++ b/sdk/batch/batch/package.json @@ -2,11 +2,14 @@ "name": "@azure/batch", "author": "Microsoft Corporation", "description": "BatchServiceClient Library with typescript type definitions for node.js and browser.", - "version": "6.0.0", + "version": "7.0.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.1.0", - "@azure/ms-rest-js": "^1.1.0", - "tslib": "^1.9.3" + "@azure/ms-rest-azure-js": "^1.3.4", + "@azure/ms-rest-js": "^1.8.7", + "buffer": "^5.2.1", + "jssha": "^2.3.1", + "tslib": "^1.9.3", + "url-parse": "^1.4.7" }, "keywords": [ "node", @@ -17,12 +20,18 @@ ], "license": "MIT", "main": "./dist/batch.js", - "module": "./esm/batchServiceClient.js", - "types": "./esm/batchServiceClient.d.ts", + "module": "./esm/batchIndex.js", + "types": "./esm/batchIndex.d.ts", "devDependencies": { + "@types/jssha": "^2.0.0", + "@types/url-parse": "^1.4.3", "typescript": "^3.1.1", "rollup": "^0.66.2", + "rollup-plugin-commonjs": "^9.2.0", + "rollup-plugin-inject": "^2.2.0", + "rollup-plugin-json": "^3.1.0", "rollup-plugin-node-resolve": "^3.4.0", + "rollup-plugin-sourcemaps": "^0.4.2", "uglify-js": "^3.4.9" }, "homepage": "https://github.com/azure/azure-sdk-for-js/tree/master/sdk/batch/batch", @@ -43,6 +52,7 @@ "esm/**/*.d.ts", "esm/**/*.d.ts.map", "src/**/*.ts", + "README.md", "rollup.config.js", "tsconfig.json" ], @@ -52,5 +62,5 @@ "prepack": "npm install && npm run build" }, "sideEffects": false, - "authPublish": true + "autoPublish": true } diff --git a/sdk/batch/batch/rollup.config.js b/sdk/batch/batch/rollup.config.js index e9508c720dd7..e05c2ae5a91f 100644 --- a/sdk/batch/batch/rollup.config.js +++ b/sdk/batch/batch/rollup.config.js @@ -1,9 +1,15 @@ +import rollup from "rollup"; import nodeResolve from "rollup-plugin-node-resolve"; +import sourcemaps from "rollup-plugin-sourcemaps"; +import cjs from "rollup-plugin-commonjs"; +import inject from "rollup-plugin-inject"; +import json from "rollup-plugin-json"; + /** - * @type {import('rollup').RollupFileOptions} + * @type {rollup.RollupFileOptions} */ const config = { - input: './esm/batchServiceClient.js', + input: "./esm/batchIndex.js", external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"], output: { file: "./dist/batch.js", @@ -16,16 +22,31 @@ const config = { }, banner: `/* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */` }, plugins: [ - nodeResolve({ module: true }) + nodeResolve({ module: true, preferBuiltins: false }), + sourcemaps(), + cjs({ + namedExports: { + "url-parse": ["url"], + jssha: ["jssha"] + } + }), + inject({ + modules: { + Buffer: ["buffer", "Buffer"], + process: "process" + }, + exclude: ["./**/package.json"] + }), + + json() ] }; + export default config; diff --git a/sdk/batch/batch/src/batchIndex.ts b/sdk/batch/batch/src/batchIndex.ts new file mode 100644 index 000000000000..d65737032c26 --- /dev/null +++ b/sdk/batch/batch/src/batchIndex.ts @@ -0,0 +1,14 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + */ + +export { BatchSharedKeyCredentials } from "./batchSharedKeyCredentials"; +export { + BatchServiceClient, + BatchServiceClientContext, + BatchServiceMappers, + BatchServiceModels +} from "./batchServiceClient"; +export * from "./operations"; diff --git a/sdk/batch/batch/src/batchServiceClient.ts b/sdk/batch/batch/src/batchServiceClient.ts index 3c072681bf74..8e4fb1f453ad 100644 --- a/sdk/batch/batch/src/batchServiceClient.ts +++ b/sdk/batch/batch/src/batchServiceClient.ts @@ -9,6 +9,7 @@ */ import * as msRest from "@azure/ms-rest-js"; +import * as msRestAzure from "@azure/ms-rest-azure-js"; import * as Models from "./models"; import * as Mappers from "./models/mappers"; import * as operations from "./operations"; @@ -30,10 +31,11 @@ class BatchServiceClient extends BatchServiceClientContext { /** * Initializes a new instance of the BatchServiceClient class. * @param credentials Credentials needed for the client to connect to Azure. + * @param batchUrl The base URL for all Azure Batch service requests. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, options?: Models.BatchServiceClientOptions) { - super(credentials, options); + constructor(credentials: msRest.ServiceClientCredentials, batchUrl: string, options?: msRestAzure.AzureServiceClientOptions) { + super(credentials, batchUrl, options); this.application = new operations.Application(this); this.pool = new operations.Pool(this); this.account = new operations.Account(this); diff --git a/sdk/batch/batch/src/batchServiceClientContext.ts b/sdk/batch/batch/src/batchServiceClientContext.ts index 8a5f3c08e362..c8b3c9197f14 100644 --- a/sdk/batch/batch/src/batchServiceClientContext.ts +++ b/sdk/batch/batch/src/batchServiceClientContext.ts @@ -8,26 +8,30 @@ * regenerated. */ -import * as Models from "./models"; import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; const packageName = "@azure/batch"; -const packageVersion = "0.1.0"; +const packageVersion = "7.0.0"; export class BatchServiceClientContext extends msRestAzure.AzureServiceClient { credentials: msRest.ServiceClientCredentials; apiVersion?: string; + batchUrl: string; /** * Initializes a new instance of the BatchServiceClient class. * @param credentials Credentials needed for the client to connect to Azure. + * @param batchUrl The base URL for all Azure Batch service requests. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, options?: Models.BatchServiceClientOptions) { + constructor(credentials: msRest.ServiceClientCredentials, batchUrl: string, options?: msRestAzure.AzureServiceClientOptions) { if (credentials == undefined) { throw new Error('\'credentials\' cannot be null.'); } + if (batchUrl == undefined) { + throw new Error('\'batchUrl\' cannot be null.'); + } if (!options) { options = {}; @@ -39,12 +43,13 @@ export class BatchServiceClientContext extends msRestAzure.AzureServiceClient { super(credentials, options); - this.apiVersion = '2018-08-01.7.0'; + this.apiVersion = '2018-12-01.8.0'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; - this.baseUri = options.baseUri || this.baseUri || "https://batch.core.windows.net"; + this.baseUri = "{batchUrl}"; this.requestContentType = "application/json; charset=utf-8"; this.credentials = credentials; + this.batchUrl = batchUrl; if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) { this.acceptLanguage = options.acceptLanguage; diff --git a/sdk/batch/batch/src/batchSharedKeyCredentials.ts b/sdk/batch/batch/src/batchSharedKeyCredentials.ts new file mode 100644 index 000000000000..fab8f5b80bab --- /dev/null +++ b/sdk/batch/batch/src/batchSharedKeyCredentials.ts @@ -0,0 +1,199 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + */ + +import { + Constants, + WebResource, + ServiceClientCredentials, + HttpHeaders, + HttpMethods +} from "@azure/ms-rest-js"; +import { HmacSha256Sign } from "./hmacSha256"; +import url from "url-parse"; +import { Buffer } from "buffer"; + +/** + * Creates a new BatchSharedKeyCredentials object. + * @constructor + * @param accountName The batch account name. + * @param accountKey The batch account key. + */ +export class BatchSharedKeyCredentials implements ServiceClientCredentials { + /** + * The batch account name. + */ + accountName: string; + /** + * The batch account key. + */ + accountKey: string; + + private _signer: HmacSha256Sign; + + constructor(accountName: string, accountKey: string) { + if (!accountName || typeof accountName.valueOf() !== "string") { + throw new Error("accountName must be a non empty string."); + } + + if (!accountKey || typeof accountKey.valueOf() !== "string") { + throw new Error("accountKey must be a non empty string."); + } + this.accountName = accountName; + this.accountKey = accountKey; + this._signer = new HmacSha256Sign(accountKey); + } + + /** + * Signs a request with the Authentication header. + * + * @param {webResource} The WebResource to be signed. + * @param {function(error)} callback The callback function. + * @return {undefined} + */ + signRequest(webResource: WebResource): Promise { + // Help function to get header value, if header without value, append a newline + function getvalueToAppend(value: HttpHeaders, headerName: string): string { + if (!value || !value.get(headerName)) { + return "\n"; + } else { + return value.get(headerName) + "\n"; + } + } + + // Help function to get content length + function getContentLengthToAppend(value: HttpHeaders, method: HttpMethods, body: any): string { + if (!value || !value.get("Content-Length")) { + // Get content length from body if available + if (body) { + return Buffer.byteLength(body) + "\n"; + } + // For GET verb, do not add content-length + if (method === "GET") { + return "\n"; + } else { + return "0\n"; + } + } else { + return value.get("Content-Length") + "\n"; + } + } + + // Set Headers + if (!webResource.headers.get("ocp-date")) { + webResource.headers.set("ocp-date", new Date().toUTCString()); + } + + // Add verb and standard HTTP header as single line + let stringToSign = + webResource.method + + "\n" + + getvalueToAppend(webResource.headers, "Content-Encoding") + + getvalueToAppend(webResource.headers, "Content-Language") + + getContentLengthToAppend(webResource.headers, webResource.method, webResource.body) + + getvalueToAppend(webResource.headers, "Content-MD5") + + getvalueToAppend(webResource.headers, "Content-Type") + + getvalueToAppend(webResource.headers, "Date") + + getvalueToAppend(webResource.headers, "If-Modified-Since") + + getvalueToAppend(webResource.headers, "If-Match") + + getvalueToAppend(webResource.headers, "If-None-Match") + + getvalueToAppend(webResource.headers, "If-Unmodified-Since") + + getvalueToAppend(webResource.headers, "Range"); + + // Add customize HTTP header + stringToSign += this._getCanonicalizedHeaders(webResource); + + // Add path/query from uri + stringToSign += this._getCanonicalizedResource(webResource); + + // Signed with sha256 + const signature = this._signer.sign(stringToSign); + + // Add authrization header + webResource.headers.set( + Constants.HeaderConstants.AUTHORIZATION, + `SharedKey ${this.accountName}:${signature}` + ); + return Promise.resolve(webResource); + } + + /* + * Constructs the Canonicalized Headers string. + * + * To construct the CanonicalizedHeaders portion of the signature string, + * follow these steps: 1. Retrieve all headers for the resource that begin + * with ocp-, including the ocp-date header. 2. Convert each HTTP header + * name to lowercase. 3. Sort the headers lexicographically by header name, + * in ascending order. Each header may appear only once in the + * string. 4. Unfold the string by replacing any breaking white space with a + * single space. 5. Trim any white space around the colon in the header. 6. + * Finally, append a new line character to each canonicalized header in the + * resulting list. Construct the CanonicalizedHeaders string by + * concatenating all headers in this list into a single string. + * + * @param The WebResource object. + * @return The canonicalized headers. + */ + private _getCanonicalizedHeaders(webResource: WebResource): string { + // Build canonicalized headers + let canonicalizedHeaders = ""; + if (webResource.headers) { + const canonicalizedHeadersArray = []; + + // Retrieve all headers for begin with ocp- + for (const header of webResource.headers.headerNames()) { + if (header.indexOf("ocp-") === 0) { + canonicalizedHeadersArray.push(header); + } + } + + // Sort the header by header name + canonicalizedHeadersArray.sort(); + for (const currentHeader of canonicalizedHeadersArray) { + const value = webResource.headers.get(currentHeader); + if (value) { + // Make header value lower case and apend a new line for each header + canonicalizedHeaders += currentHeader.toLowerCase() + ":" + value + "\n"; + } + } + } + + return canonicalizedHeaders; + } + + /* + * Retrieves the webresource's canonicalized resource string. + * @param webResource The webresource to get the canonicalized resource string from. + * @return The canonicalized resource string. + */ + private _getCanonicalizedResource(webResource: WebResource): string { + let path = "/"; + const urlstring = url(webResource.url, true); + if (urlstring.pathname) { + path = urlstring.pathname; + } + + let canonicalizedResource = "/" + this.accountName + path; + + // Get the raw query string values for signing + const queryStringValues = urlstring.query; + + // Build the canonicalized resource by sorting the values by name. + if (queryStringValues) { + let paramNames: string[] = []; + Object.keys(queryStringValues).forEach((n) => { + return paramNames.push(n); + }); + + // All the queries sorted by query name + paramNames = paramNames.sort(); + for (const name of paramNames) { + canonicalizedResource += "\n" + name + ":" + queryStringValues[name]; + } + } + + return canonicalizedResource; + } +} diff --git a/sdk/batch/batch/src/hmacSha256.ts b/sdk/batch/batch/src/hmacSha256.ts new file mode 100644 index 000000000000..2667126c4313 --- /dev/null +++ b/sdk/batch/batch/src/hmacSha256.ts @@ -0,0 +1,36 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + */ + +import jssha from "jssha"; +import { Buffer } from "buffer"; + +/** + * Describes the HmacSHA256Sign object. + */ +export class HmacSha256Sign { + private _accessKey: string; + private _decodedAccessKey: Buffer; + + constructor(accessKey: string) { + this._accessKey = accessKey; + this._decodedAccessKey = Buffer.from(this._accessKey, "base64"); + } + + /** + * Computes a signature for the specified string using the HMAC-SHA256 algorithm. + * + * @param stringToSign The UTF-8-encoded string to sign. + * @return A String that contains the HMAC-SHA256-encoded signature. + */ + sign(stringToSign: string): string { + // Encoding the Signature + // Signature=Base64(HMAC-SHA256(UTF8(StringToSign))) + const shaObj = new jssha("SHA-256", "ARRAYBUFFER"); + shaObj.setHMACKey(this._decodedAccessKey, "ARRAYBUFFER"); + shaObj.update(Buffer.from(stringToSign, "utf8")); + return shaObj.getHMAC("B64"); + } +} diff --git a/sdk/batch/batch/src/models/accountMappers.ts b/sdk/batch/batch/src/models/accountMappers.ts index 55b93adb8331..629450373d4d 100644 --- a/sdk/batch/batch/src/models/accountMappers.ts +++ b/sdk/batch/batch/src/models/accountMappers.ts @@ -1,24 +1,21 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - AccountListNodeAgentSkusResult, - NodeAgentSku, - ImageReference, AccountListNodeAgentSkusHeaders, + AccountListNodeAgentSkusResult, + AccountListPoolNodeCountsHeaders, BatchError, - ErrorMessage, BatchErrorDetail, - PoolNodeCountsListResult, - PoolNodeCounts, + ErrorMessage, + ImageReference, + NodeAgentSku, NodeCounts, - AccountListPoolNodeCountsHeaders + PoolNodeCounts, + PoolNodeCountsListResult } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/applicationMappers.ts b/sdk/batch/batch/src/models/applicationMappers.ts index cc21944cef8b..63ed8a7bc26d 100644 --- a/sdk/batch/batch/src/models/applicationMappers.ts +++ b/sdk/batch/batch/src/models/applicationMappers.ts @@ -1,20 +1,17 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { + ApplicationGetHeaders, + ApplicationListHeaders, ApplicationListResult, ApplicationSummary, - ApplicationListHeaders, BatchError, - ErrorMessage, BatchErrorDetail, - ApplicationGetHeaders + ErrorMessage } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/certificateOperationsMappers.ts b/sdk/batch/batch/src/models/certificateOperationsMappers.ts index 58b6fcd76fc8..a9c098e7567e 100644 --- a/sdk/batch/batch/src/models/certificateOperationsMappers.ts +++ b/sdk/batch/batch/src/models/certificateOperationsMappers.ts @@ -1,26 +1,23 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - CertificateAddParameter, - CertificateAddHeaders, BatchError, - ErrorMessage, BatchErrorDetail, - CertificateListResult, Certificate, - DeleteCertificateError, - NameValuePair, - CertificateListHeaders, + CertificateAddHeaders, + CertificateAddParameter, CertificateCancelDeletionHeaders, CertificateDeleteHeaders, - CertificateGetHeaders + CertificateGetHeaders, + CertificateListHeaders, + CertificateListResult, + DeleteCertificateError, + ErrorMessage, + NameValuePair } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/computeNodeOperationsMappers.ts b/sdk/batch/batch/src/models/computeNodeOperationsMappers.ts index f60a3722e121..244abfabbddc 100644 --- a/sdk/batch/batch/src/models/computeNodeOperationsMappers.ts +++ b/sdk/batch/batch/src/models/computeNodeOperationsMappers.ts @@ -1,56 +1,53 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - ComputeNodeUser, - ComputeNodeAddUserHeaders, + AutoUserSpecification, BatchError, - ErrorMessage, BatchErrorDetail, + CertificateReference, + ComputeNode, + ComputeNodeAddUserHeaders, ComputeNodeDeleteUserHeaders, - NodeUpdateUserParameter, + ComputeNodeDisableSchedulingHeaders, + ComputeNodeEnableSchedulingHeaders, + ComputeNodeEndpointConfiguration, + ComputeNodeError, + ComputeNodeGetHeaders, + ComputeNodeGetRemoteDesktopHeaders, + ComputeNodeGetRemoteLoginSettingsHeaders, + ComputeNodeGetRemoteLoginSettingsResult, + ComputeNodeListHeaders, + ComputeNodeListResult, + ComputeNodeRebootHeaders, + ComputeNodeReimageHeaders, ComputeNodeUpdateUserHeaders, - ComputeNode, - TaskInformation, - TaskExecutionInformation, - TaskContainerExecutionInformation, - TaskFailureInformation, - NameValuePair, - StartTask, - TaskContainerSettings, + ComputeNodeUploadBatchServiceLogsHeaders, + ComputeNodeUser, ContainerRegistry, - ResourceFile, EnvironmentSetting, - UserIdentity, - AutoUserSpecification, - StartTaskInformation, - CertificateReference, - ComputeNodeError, - ComputeNodeEndpointConfiguration, + ErrorMessage, InboundEndpoint, + NameValuePair, NodeAgentInformation, - ComputeNodeGetHeaders, + NodeDisableSchedulingParameter, NodeRebootParameter, - ComputeNodeRebootHeaders, NodeReimageParameter, - ComputeNodeReimageHeaders, - NodeDisableSchedulingParameter, - ComputeNodeDisableSchedulingHeaders, - ComputeNodeEnableSchedulingHeaders, - ComputeNodeGetRemoteLoginSettingsResult, - ComputeNodeGetRemoteLoginSettingsHeaders, - ComputeNodeGetRemoteDesktopHeaders, + NodeUpdateUserParameter, + ResourceFile, + StartTask, + StartTaskInformation, + TaskContainerExecutionInformation, + TaskContainerSettings, + TaskExecutionInformation, + TaskFailureInformation, + TaskInformation, UploadBatchServiceLogsConfiguration, UploadBatchServiceLogsResult, - ComputeNodeUploadBatchServiceLogsHeaders, - ComputeNodeListResult, - ComputeNodeListHeaders + UserIdentity } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/fileMappers.ts b/sdk/batch/batch/src/models/fileMappers.ts index 502d491e2d6f..3f165a649309 100644 --- a/sdk/batch/batch/src/models/fileMappers.ts +++ b/sdk/batch/batch/src/models/fileMappers.ts @@ -1,27 +1,24 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - FileDeleteFromTaskHeaders, BatchError, - ErrorMessage, BatchErrorDetail, - FileGetFromTaskHeaders, - FileGetPropertiesFromTaskHeaders, + ErrorMessage, FileDeleteFromComputeNodeHeaders, + FileDeleteFromTaskHeaders, FileGetFromComputeNodeHeaders, + FileGetFromTaskHeaders, FileGetPropertiesFromComputeNodeHeaders, - NodeFileListResult, - NodeFile, - FileProperties, + FileGetPropertiesFromTaskHeaders, + FileListFromComputeNodeHeaders, FileListFromTaskHeaders, - FileListFromComputeNodeHeaders + FileProperties, + NodeFile, + NodeFileListResult } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/index.ts b/sdk/batch/batch/src/models/index.ts index 0c25f5051f41..83858b5a3c1a 100644 --- a/sdk/batch/batch/src/models/index.ts +++ b/sdk/batch/batch/src/models/index.ts @@ -1,14194 +1,11203 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js"; +import { BaseResource, CloudError } from "@azure/ms-rest-azure-js"; import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; - /** - * @interface * An interface representing PoolUsageMetrics. * @summary Usage metrics for a pool across an aggregation interval. - * */ export interface PoolUsageMetrics { /** - * @member {string} poolId The ID of the pool whose metrics are aggregated in - * this entry. + * The ID of the pool whose metrics are aggregated in this entry. */ poolId: string; /** - * @member {Date} startTime The start time of the aggregation interval - * covered by this entry. + * The start time of the aggregation interval covered by this entry. */ startTime: Date; /** - * @member {Date} endTime The end time of the aggregation interval covered by - * this entry. + * The end time of the aggregation interval covered by this entry. */ endTime: Date; /** - * @member {string} vmSize The size of virtual machines in the pool. All VMs - * in a pool are the same size. For information about available sizes of - * virtual machines in pools, see Choose a VM size for compute nodes in an - * Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + * The size of virtual machines in the pool. All VMs in a pool are the same size. For information + * about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in + * an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */ vmSize: string; /** - * @member {number} totalCoreHours The total core hours used in the pool - * during this aggregation interval. + * The total core hours used in the pool during this aggregation interval. */ totalCoreHours: number; - /** - * @member {number} dataIngressGiB The cross data center network ingress to - * the pool during this interval, in GiB. - */ - dataIngressGiB: number; - /** - * @member {number} dataEgressGiB The cross data center network egress from - * the pool during this interval, in GiB. - */ - dataEgressGiB: number; } /** - * @interface * An interface representing ImageReference. - * @summary A reference to an Azure Virtual Machines Marketplace image or a - * custom Azure Virtual Machine image. To get the list of all Azure Marketplace - * image references verified by Azure Batch, see the 'List node agent SKUs' - * operation. - * + * @summary A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual + * Machine image. To get the list of all Azure Marketplace image references verified by Azure + * Batch, see the 'List node agent SKUs' operation. */ export interface ImageReference { /** - * @member {string} [publisher] The publisher of the Azure Virtual Machines - * Marketplace image. For example, Canonical or MicrosoftWindowsServer. + * The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or + * MicrosoftWindowsServer. */ publisher?: string; /** - * @member {string} [offer] The offer type of the Azure Virtual Machines - * Marketplace image. For example, UbuntuServer or WindowsServer. + * The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or + * WindowsServer. */ offer?: string; /** - * @member {string} [sku] The SKU of the Azure Virtual Machines Marketplace - * image. For example, 14.04.0-LTS or 2012-R2-Datacenter. + * The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or + * 2012-R2-Datacenter. */ sku?: string; /** - * @member {string} [version] The version of the Azure Virtual Machines - * Marketplace image. A value of 'latest' can be specified to select the - * latest version of an image. If omitted, the default is 'latest'. + * The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be + * specified to select the latest version of an image. If omitted, the default is 'latest'. */ version?: string; /** - * @member {string} [virtualMachineImageId] The ARM resource identifier of - * the virtual machine image. Computes nodes of the pool will be created - * using this custom image. This is of the form + * The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be + * created using this custom image. This is of the form * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as - * the Azure Batch account. For information about the firewall settings for - * the Batch node agent to communicate with the Batch service see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. + * This property is mutually exclusive with other ImageReference properties. The virtual machine + * image must be in the same region and subscription as the Azure Batch account. For more + * details, see https://docs.microsoft.com/azure/batch/batch-custom-images. */ virtualMachineImageId?: string; } /** - * @interface - * An interface representing NodeAgentSku. + * The Batch node agent is a program that runs on each node in the pool, and provides the + * command-and-control interface between the node and the Batch service. There are different + * implementations of the node agent, known as SKUs, for different operating systems. * @summary A node agent SKU supported by the Batch service. - * - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. - * */ export interface NodeAgentSku { /** - * @member {string} [id] The ID of the node agent SKU. + * The ID of the node agent SKU. */ id?: string; /** - * @member {ImageReference[]} [verifiedImageReferences] The list of Azure - * Marketplace images verified to be compatible with this node agent SKU. - * This collection is not exhaustive (the node agent may be compatible with - * other images). + * The list of Azure Marketplace images verified to be compatible with this node agent SKU. This + * collection is not exhaustive (the node agent may be compatible with other images). */ verifiedImageReferences?: ImageReference[]; /** - * @member {OSType} [osType] The type of operating system (e.g. Windows or - * Linux) compatible with the node agent SKU. Possible values include: - * 'linux', 'windows' + * The type of operating system (e.g. Windows or Linux) compatible with the node agent SKU. + * Possible values include: 'linux', 'windows' */ osType?: OSType; } /** - * @interface * An interface representing AuthenticationTokenSettings. - * @summary The settings for an authentication token that the task can use to - * perform Batch service operations. - * + * @summary The settings for an authentication token that the task can use to perform Batch service + * operations. */ export interface AuthenticationTokenSettings { /** - * @member {AccessScope[]} [access] The Batch resources to which the token - * grants access. The authentication token grants access to a limited set of - * Batch service operations. Currently the only supported value for the - * access property is 'job', which grants access to all operations related to - * the job which contains the task. + * The Batch resources to which the token grants access. The authentication token grants access + * to a limited set of Batch service operations. Currently the only supported value for the + * access property is 'job', which grants access to all operations related to the job which + * contains the task. */ access?: AccessScope[]; } /** - * @interface * An interface representing UsageStatistics. * @summary Statistics related to pool usage information. - * */ export interface UsageStatistics { /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {string} dedicatedCoreTime The aggregated wall-clock time of the - * dedicated compute node cores being part of the pool. + * The aggregated wall-clock time of the dedicated compute node cores being part of the pool. */ dedicatedCoreTime: string; } /** - * @interface * An interface representing ResourceStatistics. - * @summary Statistics related to resource consumption by compute nodes in a - * pool. - * + * @summary Statistics related to resource consumption by compute nodes in a pool. */ export interface ResourceStatistics { /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {number} avgCPUPercentage The average CPU usage across all nodes - * in the pool (percentage per node). + * The average CPU usage across all nodes in the pool (percentage per node). */ avgCPUPercentage: number; /** - * @member {number} avgMemoryGiB The average memory usage in GiB across all - * nodes in the pool. + * The average memory usage in GiB across all nodes in the pool. */ avgMemoryGiB: number; /** - * @member {number} peakMemoryGiB The peak memory usage in GiB across all - * nodes in the pool. + * The peak memory usage in GiB across all nodes in the pool. */ peakMemoryGiB: number; /** - * @member {number} avgDiskGiB The average used disk space in GiB across all - * nodes in the pool. + * The average used disk space in GiB across all nodes in the pool. */ avgDiskGiB: number; /** - * @member {number} peakDiskGiB The peak used disk space in GiB across all - * nodes in the pool. + * The peak used disk space in GiB across all nodes in the pool. */ peakDiskGiB: number; /** - * @member {number} diskReadIOps The total number of disk read operations - * across all nodes in the pool. + * The total number of disk read operations across all nodes in the pool. */ diskReadIOps: number; /** - * @member {number} diskWriteIOps The total number of disk write operations - * across all nodes in the pool. + * The total number of disk write operations across all nodes in the pool. */ diskWriteIOps: number; /** - * @member {number} diskReadGiB The total amount of data in GiB of disk reads - * across all nodes in the pool. + * The total amount of data in GiB of disk reads across all nodes in the pool. */ diskReadGiB: number; /** - * @member {number} diskWriteGiB The total amount of data in GiB of disk - * writes across all nodes in the pool. + * The total amount of data in GiB of disk writes across all nodes in the pool. */ diskWriteGiB: number; /** - * @member {number} networkReadGiB The total amount of data in GiB of network - * reads across all nodes in the pool. + * The total amount of data in GiB of network reads across all nodes in the pool. */ networkReadGiB: number; /** - * @member {number} networkWriteGiB The total amount of data in GiB of - * network writes across all nodes in the pool. + * The total amount of data in GiB of network writes across all nodes in the pool. */ networkWriteGiB: number; } /** - * @interface * An interface representing PoolStatistics. - * @summary Contains utilization and resource usage statistics for the lifetime - * of a pool. - * + * @summary Contains utilization and resource usage statistics for the lifetime of a pool. */ export interface PoolStatistics { /** - * @member {string} url The URL for the statistics. + * The URL for the statistics. */ url: string; /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {UsageStatistics} [usageStats] Statistics related to pool usage, - * such as the amount of core-time used. + * Statistics related to pool usage, such as the amount of core-time used. */ usageStats?: UsageStatistics; /** - * @member {ResourceStatistics} [resourceStats] Statistics related to - * resource consumption by compute nodes in the pool. + * Statistics related to resource consumption by compute nodes in the pool. */ resourceStats?: ResourceStatistics; } /** - * @interface * An interface representing JobStatistics. * @summary Resource usage statistics for a job. - * */ export interface JobStatistics { /** - * @member {string} url The URL of the statistics. + * The URL of the statistics. */ url: string; /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {string} userCPUTime The total user mode CPU time (summed across - * all cores and all compute nodes) consumed by all tasks in the job. + * The total user mode CPU time (summed across all cores and all compute nodes) consumed by all + * tasks in the job. */ userCPUTime: string; /** - * @member {string} kernelCPUTime The total kernel mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in the job. + * The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all + * tasks in the job. */ kernelCPUTime: string; /** - * @member {string} wallClockTime The total wall clock time of all tasks in - * the job. The wall clock time is the elapsed time from when the task - * started running on a compute node to when it finished (or to the last time - * the statistics were updated, if the task had not finished by then). If a - * task was retried, this includes the wall clock time of all the task - * retries. + * The total wall clock time of all tasks in the job. The wall clock time is the elapsed time + * from when the task started running on a compute node to when it finished (or to the last time + * the statistics were updated, if the task had not finished by then). If a task was retried, + * this includes the wall clock time of all the task retries. */ wallClockTime: string; /** - * @member {number} readIOps The total number of disk read operations made by - * all tasks in the job. + * The total number of disk read operations made by all tasks in the job. */ readIOps: number; /** - * @member {number} writeIOps The total number of disk write operations made - * by all tasks in the job. + * The total number of disk write operations made by all tasks in the job. */ writeIOps: number; /** - * @member {number} readIOGiB The total amount of data in GiB read from disk - * by all tasks in the job. + * The total amount of data in GiB read from disk by all tasks in the job. */ readIOGiB: number; /** - * @member {number} writeIOGiB The total amount of data in GiB written to - * disk by all tasks in the job. + * The total amount of data in GiB written to disk by all tasks in the job. */ writeIOGiB: number; /** - * @member {number} numSucceededTasks The total number of tasks successfully - * completed in the job during the given time range. A task completes - * successfully if it returns exit code 0. + * The total number of tasks successfully completed in the job during the given time range. A + * task completes successfully if it returns exit code 0. */ numSucceededTasks: number; /** - * @member {number} numFailedTasks The total number of tasks in the job that - * failed during the given time range. A task fails if it exhausts its - * maximum retry count without returning exit code 0. + * The total number of tasks in the job that failed during the given time range. A task fails if + * it exhausts its maximum retry count without returning exit code 0. */ numFailedTasks: number; /** - * @member {number} numTaskRetries The total number of retries on all the - * tasks in the job during the given time range. + * The total number of retries on all the tasks in the job during the given time range. */ numTaskRetries: number; /** - * @member {string} waitTime The total wait time of all tasks in the job. The - * wait time for a task is defined as the elapsed time between the creation - * of the task and the start of task execution. (If the task is retried due - * to failures, the wait time is the time to the most recent task execution.) - * This value is only reported in the account lifetime statistics; it is not - * included in the job statistics. + * The total wait time of all tasks in the job. The wait time for a task is defined as the + * elapsed time between the creation of the task and the start of task execution. (If the task is + * retried due to failures, the wait time is the time to the most recent task execution.) This + * value is only reported in the account lifetime statistics; it is not included in the job + * statistics. */ waitTime: string; } /** - * @interface * An interface representing NameValuePair. * @summary Represents a name-value pair. - * */ export interface NameValuePair { /** - * @member {string} [name] The name in the name-value pair. + * The name in the name-value pair. */ name?: string; /** - * @member {string} [value] The value in the name-value pair. + * The value in the name-value pair. */ value?: string; } /** - * @interface * An interface representing DeleteCertificateError. - * @summary An error encountered by the Batch service when deleting a - * certificate. - * + * @summary An error encountered by the Batch service when deleting a certificate. */ export interface DeleteCertificateError { /** - * @member {string} [code] An identifier for the certificate deletion error. - * Codes are invariant and are intended to be consumed programmatically. + * An identifier for the certificate deletion error. Codes are invariant and are intended to be + * consumed programmatically. */ code?: string; /** - * @member {string} [message] A message describing the certificate deletion - * error, intended to be suitable for display in a user interface. + * A message describing the certificate deletion error, intended to be suitable for display in a + * user interface. */ message?: string; /** - * @member {NameValuePair[]} [values] A list of additional error details - * related to the certificate deletion error. This list includes details such - * as the active pools and nodes referencing this certificate. However, if a - * large number of resources reference the certificate, the list contains - * only about the first hundred. + * A list of additional error details related to the certificate deletion error. This list + * includes details such as the active pools and nodes referencing this certificate. However, if + * a large number of resources reference the certificate, the list contains only about the first + * hundred. */ values?: NameValuePair[]; } /** - * @interface - * An interface representing Certificate. - * A certificate that can be installed on compute nodes and can be used to - * authenticate operations on the machine. - * + * A certificate that can be installed on compute nodes and can be used to authenticate operations + * on the machine. */ export interface Certificate { /** - * @member {string} [thumbprint] The X.509 thumbprint of the certificate. - * This is a sequence of up to 40 hex digits. + * The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits. */ thumbprint?: string; /** - * @member {string} [thumbprintAlgorithm] The algorithm used to derive the - * thumbprint. + * The algorithm used to derive the thumbprint. */ thumbprintAlgorithm?: string; /** - * @member {string} [url] The URL of the certificate. + * The URL of the certificate. */ url?: string; /** - * @member {CertificateState} [state] The current state of the certificate. - * Possible values include: 'active', 'deleting', 'deleteFailed' + * The current state of the certificate. Possible values include: 'active', 'deleting', + * 'deleteFailed' */ state?: CertificateState; /** - * @member {Date} [stateTransitionTime] The time at which the certificate - * entered its current state. + * The time at which the certificate entered its current state. */ stateTransitionTime?: Date; /** - * @member {CertificateState} [previousState] The previous state of the - * certificate. This property is not set if the certificate is in its initial - * active state. Possible values include: 'active', 'deleting', - * 'deleteFailed' + * The previous state of the certificate. This property is not set if the certificate is in its + * initial active state. Possible values include: 'active', 'deleting', 'deleteFailed' */ previousState?: CertificateState; /** - * @member {Date} [previousStateTransitionTime] The time at which the - * certificate entered its previous state. This property is not set if the + * The time at which the certificate entered its previous state. This property is not set if the * certificate is in its initial Active state. */ previousStateTransitionTime?: Date; /** - * @member {string} [publicData] The public part of the certificate as a - * base-64 encoded .cer file. + * The public part of the certificate as a base-64 encoded .cer file. */ publicData?: string; /** - * @member {DeleteCertificateError} [deleteCertificateError] The error that - * occurred on the last attempt to delete this certificate. This property is - * set only if the certificate is in the DeleteFailed state. + * The error that occurred on the last attempt to delete this certificate. This property is set + * only if the certificate is in the DeleteFailed state. */ deleteCertificateError?: DeleteCertificateError; } /** - * @interface * An interface representing ApplicationPackageReference. - * @summary A reference to an application package to be deployed to compute - * nodes. - * + * @summary A reference to an application package to be deployed to compute nodes. */ export interface ApplicationPackageReference { /** - * @member {string} applicationId The ID of the application to deploy. + * The ID of the application to deploy. */ applicationId: string; /** - * @member {string} [version] The version of the application to deploy. If - * omitted, the default version is deployed. If this is omitted on a pool, - * and no default version is specified for this application, the request - * fails with the error code InvalidApplicationPackageReferences and HTTP - * status code 409. If this is omitted on a task, and no default version is - * specified for this application, the task fails with a pre-processing - * error. + * The version of the application to deploy. If omitted, the default version is deployed. If this + * is omitted on a pool, and no default version is specified for this application, the request + * fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If + * this is omitted on a task, and no default version is specified for this application, the task + * fails with a pre-processing error. */ version?: string; } /** - * @interface * An interface representing ApplicationSummary. - * @summary Contains information about an application in an Azure Batch - * account. - * + * @summary Contains information about an application in an Azure Batch account. */ export interface ApplicationSummary { /** - * @member {string} id A string that uniquely identifies the application - * within the account. + * A string that uniquely identifies the application within the account. */ id: string; /** - * @member {string} displayName The display name for the application. + * The display name for the application. */ displayName: string; /** - * @member {string[]} versions The list of available versions of the - * application. + * The list of available versions of the application. */ versions: string[]; } /** - * @interface * An interface representing CertificateAddParameter. - * @summary A certificate that can be installed on compute nodes and can be - * used to authenticate operations on the machine. - * + * @summary A certificate that can be installed on compute nodes and can be used to authenticate + * operations on the machine. */ export interface CertificateAddParameter { /** - * @member {string} thumbprint The X.509 thumbprint of the certificate. This - * is a sequence of up to 40 hex digits (it may include spaces but these are - * removed). + * The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may + * include spaces but these are removed). */ thumbprint: string; /** - * @member {string} thumbprintAlgorithm The algorithm used to derive the - * thumbprint. This must be sha1. + * The algorithm used to derive the thumbprint. This must be sha1. */ thumbprintAlgorithm: string; /** - * @member {string} data The base64-encoded contents of the certificate. The - * maximum size is 10KB. + * The base64-encoded contents of the certificate. The maximum size is 10KB. */ data: string; /** - * @member {CertificateFormat} [certificateFormat] The format of the - * certificate data. Possible values include: 'pfx', 'cer' + * The format of the certificate data. Possible values include: 'pfx', 'cer' */ certificateFormat?: CertificateFormat; /** - * @member {string} [password] The password to access the certificate's - * private key. This is required if the certificate format is pfx. It should - * be omitted if the certificate format is cer. + * The password to access the certificate's private key. This is required if the certificate + * format is pfx. It should be omitted if the certificate format is cer. */ password?: string; } /** - * @interface * An interface representing FileProperties. * @summary The properties of a file on a compute node. - * */ export interface FileProperties { /** - * @member {Date} [creationTime] The file creation time. The creation time is - * not returned for files on Linux compute nodes. + * The file creation time. The creation time is not returned for files on Linux compute nodes. */ creationTime?: Date; /** - * @member {Date} lastModified The time at which the file was last modified. + * The time at which the file was last modified. */ lastModified: Date; /** - * @member {number} contentLength The length of the file. + * The length of the file. */ contentLength: number; /** - * @member {string} [contentType] The content type of the file. + * The content type of the file. */ contentType?: string; /** - * @member {string} [fileMode] The file mode attribute in octal format. The - * file mode is returned only for files on Linux compute nodes. + * The file mode attribute in octal format. The file mode is returned only for files on Linux + * compute nodes. */ fileMode?: string; } /** - * @interface * An interface representing NodeFile. * @summary Information about a file or directory on a compute node. - * */ export interface NodeFile { /** - * @member {string} [name] The file path. + * The file path. */ name?: string; /** - * @member {string} [url] The URL of the file. + * The URL of the file. */ url?: string; /** - * @member {boolean} [isDirectory] Whether the object represents a directory. + * Whether the object represents a directory. */ isDirectory?: boolean; /** - * @member {FileProperties} [properties] The file properties. + * The file properties. */ properties?: FileProperties; } /** - * @interface * An interface representing Schedule. * @summary The schedule according to which jobs will be created - * */ export interface Schedule { /** - * @member {Date} [doNotRunUntil] The earliest time at which any job may be - * created under this job schedule. If you do not specify a doNotRunUntil - * time, the schedule becomes ready to create jobs immediately. + * The earliest time at which any job may be created under this job schedule. If you do not + * specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately. */ doNotRunUntil?: Date; /** - * @member {Date} [doNotRunAfter] A time after which no job will be created - * under this job schedule. The schedule will move to the completed state as - * soon as this deadline is past and there is no active job under this job - * schedule. If you do not specify a doNotRunAfter time, and you are creating - * a recurring job schedule, the job schedule will remain active until you - * explicitly terminate it. + * A time after which no job will be created under this job schedule. The schedule will move to + * the completed state as soon as this deadline is past and there is no active job under this job + * schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring job + * schedule, the job schedule will remain active until you explicitly terminate it. */ doNotRunAfter?: Date; /** - * @member {string} [startWindow] The time interval, starting from the time - * at which the schedule indicates a job should be created, within which a - * job must be created. If a job is not created within the startWindow - * interval, then the 'opportunity' is lost; no job will be created until the - * next recurrence of the schedule. If the schedule is recurring, and the - * startWindow is longer than the recurrence interval, then this is - * equivalent to an infinite startWindow, because the job that is 'due' in - * one recurrenceInterval is not carried forward into the next recurrence - * interval. The default is infinite. The minimum value is 1 minute. If you - * specify a lower value, the Batch service rejects the schedule with an - * error; if you are calling the REST API directly, the HTTP status code is - * 400 (Bad Request). + * The time interval, starting from the time at which the schedule indicates a job should be + * created, within which a job must be created. If a job is not created within the startWindow + * interval, then the 'opportunity' is lost; no job will be created until the next recurrence of + * the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence + * interval, then this is equivalent to an infinite startWindow, because the job that is 'due' in + * one recurrenceInterval is not carried forward into the next recurrence interval. The default + * is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service + * rejects the schedule with an error; if you are calling the REST API directly, the HTTP status + * code is 400 (Bad Request). */ startWindow?: string; /** - * @member {string} [recurrenceInterval] The time interval between the start - * times of two successive jobs under the job schedule. A job schedule can - * have at most one active job under it at any given time. Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally - * specify a jobManagerTask in the jobSpecification. If you do not use - * jobManagerTask, you will need an external process to monitor when jobs are - * created, add tasks to the jobs and terminate the jobs ready for the next - * recurrence. The default is that the schedule does not recur: one job is - * created, within the startWindow after the doNotRunUntil time, and the - * schedule is complete as soon as that job finishes. The minimum value is 1 - * minute. If you specify a lower value, the Batch service rejects the - * schedule with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). + * The time interval between the start times of two successive jobs under the job schedule. A job + * schedule can have at most one active job under it at any given time. Because a job schedule + * can have at most one active job under it at any given time, if it is time to create a new job + * under a job schedule, but the previous job is still running, the Batch service will not create + * the new job until the previous job finishes. If the previous job does not finish within the + * startWindow period of the new recurrenceInterval, then no new job will be scheduled for that + * interval. For recurring jobs, you should normally specify a jobManagerTask in the + * jobSpecification. If you do not use jobManagerTask, you will need an external process to + * monitor when jobs are created, add tasks to the jobs and terminate the jobs ready for the next + * recurrence. The default is that the schedule does not recur: one job is created, within the + * startWindow after the doNotRunUntil time, and the schedule is complete as soon as that job + * finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service + * rejects the schedule with an error; if you are calling the REST API directly, the HTTP status + * code is 400 (Bad Request). */ recurrenceInterval?: string; } /** - * @interface * An interface representing JobConstraints. * @summary The execution constraints for a job. - * */ export interface JobConstraints { /** - * @member {string} [maxWallClockTime] The maximum elapsed time that the job - * may run, measured from the time the job is created. If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no - * time limit on how long the job may run. + * The maximum elapsed time that the job may run, measured from the time the job is created. If + * the job does not complete within the time limit, the Batch service terminates it and any tasks + * that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. + * If this property is not specified, there is no time limit on how long the job may run. */ maxWallClockTime?: string; /** - * @member {number} [maxTaskRetryCount] The maximum number of times each task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries. - * The Batch service will try each task once, and may then retry up to this - * limit. For example, if the maximum retry count is 3, Batch tries a task up - * to 4 times (one initial try and 3 retries). If the maximum retry count is - * 0, the Batch service does not retry tasks. If the maximum retry count is - * -1, the Batch service retries tasks without limit. The default value is 0 - * (no retries). + * The maximum number of times each task may be retried. The Batch service retries a task if its + * exit code is nonzero. Note that this value specifically controls the number of retries. The + * Batch service will try each task once, and may then retry up to this limit. For example, if + * the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 + * retries). If the maximum retry count is 0, the Batch service does not retry tasks. If the + * maximum retry count is -1, the Batch service retries tasks without limit. The default value is + * 0 (no retries). */ maxTaskRetryCount?: number; } /** - * @interface + * An interface representing JobNetworkConfiguration. + * @summary The network configuration for the job. + */ +export interface JobNetworkConfiguration { + /** + * The ARM resource identifier of the virtual network subnet which nodes running tasks from the + * job will join for the duration of the task. This is only supported for jobs running on + * VirtualMachineConfiguration pools. This is of the form + * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. + * The virtual network must be in the same region and subscription as the Azure Batch account. + * The specified subnet should have enough free IP addresses to accommodate the number of nodes + * which will run tasks from the job. For more details, see + * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. + */ + subnetId: string; +} + +/** * An interface representing ContainerRegistry. * @summary A private container registry. - * */ export interface ContainerRegistry { /** - * @member {string} [registryServer] The registry URL. If omitted, the - * default is "docker.io". + * The registry URL. If omitted, the default is "docker.io". */ registryServer?: string; /** - * @member {string} userName The user name to log into the registry server. + * The user name to log into the registry server. */ userName: string; /** - * @member {string} password The password to log into the registry server. + * The password to log into the registry server. */ password: string; } /** - * @interface * An interface representing TaskContainerSettings. * @summary The container settings for a task. - * */ export interface TaskContainerSettings { /** - * @member {string} [containerRunOptions] Additional options to the container - * create command. These additional options are supplied as arguments to the - * "docker create" command, in addition to those controlled by the Batch + * Additional options to the container create command. These additional options are supplied as + * arguments to the "docker create" command, in addition to those controlled by the Batch * Service. */ containerRunOptions?: string; /** - * @member {string} imageName The image to use to create the container in - * which the task will run. This is the full image reference, as would be - * specified to "docker pull". If no tag is provided as part of the image + * The image to use to create the container in which the task will run. This is the full image + * reference, as would be specified to "docker pull". If no tag is provided as part of the image * name, the tag ":latest" is used as a default. */ imageName: string; /** - * @member {ContainerRegistry} [registry] The private registry which contains - * the container image. This setting can be omitted if was already provided - * at pool creation. + * The private registry which contains the container image. This setting can be omitted if was + * already provided at pool creation. */ registry?: ContainerRegistry; } /** - * @interface * An interface representing ResourceFile. - * @summary A file to be downloaded from Azure blob storage to a compute node. - * + * @summary A single file or multiple files to be downloaded to a compute node. */ export interface ResourceFile { /** - * @member {string} blobSource The URL of the file within Azure Blob Storage. - * This URL must be readable using anonymous access; that is, the Batch - * service does not present any credentials when downloading the blob. There - * are two ways to get such a URL for a blob in Azure storage: include a - * Shared Access Signature (SAS) granting read permissions on the blob, or - * set the ACL for the blob or its container to allow public access. + * The storage container name in the auto storage account. The autoStorageContainerName, + * storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be + * specified. + */ + autoStorageContainerName?: string; + /** + * The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, + * storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be + * specified. This URL must be readable and listable using anonymous access; that is, the Batch + * service does not present any credentials when downloading blobs from the container. There are + * two ways to get such a URL for a container in Azure storage: include a Shared Access Signature + * (SAS) granting read and list permissions on the container, or set the ACL for the container to + * allow public access. + */ + storageContainerUrl?: string; + /** + * The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl + * properties are mutually exclusive and one of them must be specified. If the URL points to + * Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service + * does not present any credentials when downloading the blob. There are two ways to get such a + * URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read + * permissions on the blob, or set the ACL for the blob or its container to allow public access. */ - blobSource: string; + httpUrl?: string; /** - * @member {string} filePath The location on the compute node to which to - * download the file, relative to the task's working directory. + * The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs + * whose names begin with the specified prefix will be downloaded. The property is valid only + * when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial + * filename or a subdirectory. If a prefix is not specified, all the files in the container will + * be downloaded. */ - filePath: string; + blobPrefix?: string; /** - * @member {string} [fileMode] The file permission mode attribute in octal - * format. This property applies only to files being downloaded to Linux - * compute nodes. It will be ignored if it is specified for a resourceFile - * which will be downloaded to a Windows node. If this property is not - * specified for a Linux node, then a default value of 0770 is applied to the - * file. + * The location on the compute node to which to download the file(s), relative to the task's + * working directory. If the httpUrl property is specified, the filePath is required and + * describes the path which the file will be downloaded to, including the filename. Otherwise, if + * the autoStorageContainerName or storageContainerUrl property is specified, filePath is + * optional and is the directory to download the files to. In the case where filePath is used as + * a directory, any directory structure already associated with the input data will be retained + * in full and appended to the specified filePath directory. The specified relative path cannot + * break out of the task's working directory (for example by using '..'). + */ + filePath?: string; + /** + * The file permission mode attribute in octal format. This property applies only to files being + * downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile + * which will be downloaded to a Windows node. If this property is not specified for a Linux + * node, then a default value of 0770 is applied to the file. */ fileMode?: string; } /** - * @interface * An interface representing EnvironmentSetting. * @summary An environment variable to be set on a task process. - * */ export interface EnvironmentSetting { /** - * @member {string} name The name of the environment variable. + * The name of the environment variable. */ name: string; /** - * @member {string} [value] The value of the environment variable. + * The value of the environment variable. */ value?: string; } /** - * @interface * An interface representing ExitOptions. - * @summary Specifies how the Batch service responds to a particular exit - * condition. - * + * @summary Specifies how the Batch service responds to a particular exit condition. */ export interface ExitOptions { /** - * @member {JobAction} [jobAction] An action to take on the job containing - * the task, if the task completes with the given exit condition and the - * job's onTaskFailed property is 'performExitOptionsJobAction'. The default - * is none for exit code 0 and terminate for all other exit conditions. If - * the job's onTaskFailed property is noaction, then specifying this property - * returns an error and the add task request fails with an invalid property - * value error; if you are calling the REST API directly, the HTTP status - * code is 400 (Bad Request). Possible values include: 'none', 'disable', - * 'terminate' + * An action to take on the job containing the task, if the task completes with the given exit + * condition and the job's onTaskFailed property is 'performExitOptionsJobAction'. The default is + * none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed + * property is noaction, then specifying this property returns an error and the add task request + * fails with an invalid property value error; if you are calling the REST API directly, the HTTP + * status code is 400 (Bad Request). Possible values include: 'none', 'disable', 'terminate' */ jobAction?: JobAction; /** - * @member {DependencyAction} [dependencyAction] An action that the Batch - * service performs on tasks that depend on this task. The default is - * 'satisfy' for exit code 0, and 'block' for all other exit conditions. If - * the job's usesTaskDependencies property is set to false, then specifying - * the dependencyAction property returns an error and the add task request - * fails with an invalid property value error; if you are calling the REST - * API directly, the HTTP status code is 400 (Bad Request). Possible values + * An action that the Batch service performs on tasks that depend on this task. The default is + * 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's + * usesTaskDependencies property is set to false, then specifying the dependencyAction property + * returns an error and the add task request fails with an invalid property value error; if you + * are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values * include: 'satisfy', 'block' */ dependencyAction?: DependencyAction; } /** - * @interface * An interface representing ExitCodeMapping. - * @summary How the Batch service should respond if a task exits with a - * particular exit code. - * + * @summary How the Batch service should respond if a task exits with a particular exit code. */ export interface ExitCodeMapping { /** - * @member {number} code A process exit code. + * A process exit code. */ code: number; /** - * @member {ExitOptions} exitOptions How the Batch service should respond if - * the task exits with this exit code. + * How the Batch service should respond if the task exits with this exit code. */ exitOptions: ExitOptions; } /** - * @interface * An interface representing ExitCodeRangeMapping. - * @summary A range of exit codes and how the Batch service should respond to - * exit codes within that range. - * + * @summary A range of exit codes and how the Batch service should respond to exit codes within + * that range. */ export interface ExitCodeRangeMapping { /** - * @member {number} start The first exit code in the range. + * The first exit code in the range. */ start: number; /** - * @member {number} end The last exit code in the range. + * The last exit code in the range. */ end: number; /** - * @member {ExitOptions} exitOptions How the Batch service should respond if - * the task exits with an exit code in the range start to end (inclusive). + * How the Batch service should respond if the task exits with an exit code in the range start to + * end (inclusive). */ exitOptions: ExitOptions; } /** - * @interface * An interface representing ExitConditions. - * @summary Specifies how the Batch service should respond when the task - * completes. - * + * @summary Specifies how the Batch service should respond when the task completes. */ export interface ExitConditions { /** - * @member {ExitCodeMapping[]} [exitCodes] A list of individual task exit - * codes and how the Batch service should respond to them. + * A list of individual task exit codes and how the Batch service should respond to them. */ exitCodes?: ExitCodeMapping[]; /** - * @member {ExitCodeRangeMapping[]} [exitCodeRanges] A list of task exit code - * ranges and how the Batch service should respond to them. + * A list of task exit code ranges and how the Batch service should respond to them. */ exitCodeRanges?: ExitCodeRangeMapping[]; /** - * @member {ExitOptions} [preProcessingError] How the Batch service should - * respond if the task fails to start due to an error. + * How the Batch service should respond if the task fails to start due to an error. */ preProcessingError?: ExitOptions; /** - * @member {ExitOptions} [fileUploadError] How the Batch service should - * respond if a file upload error occurs. If the task exited with an exit - * code that was specified via exitCodes or exitCodeRanges, and then - * encountered a file upload error, then the action specified by the exit - * code takes precedence. + * How the Batch service should respond if a file upload error occurs. If the task exited with an + * exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file + * upload error, then the action specified by the exit code takes precedence. */ fileUploadError?: ExitOptions; /** - * @member {ExitOptions} [default] How the Batch service should respond if - * the task fails with an exit condition not covered by any of the other - * properties. This value is used if the task exits with any nonzero exit - * code not listed in the exitCodes or exitCodeRanges collection, with a - * pre-processing error if the preProcessingError property is not present, or - * with a file upload error if the fileUploadError property is not present. - * If you want non-default behaviour on exit code 0, you must list it + * How the Batch service should respond if the task fails with an exit condition not covered by + * any of the other properties. This value is used if the task exits with any nonzero exit code + * not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the + * preProcessingError property is not present, or with a file upload error if the fileUploadError + * property is not present. If you want non-default behavior on exit code 0, you must list it * explicitly using the exitCodes or exitCodeRanges collection. */ default?: ExitOptions; } /** - * @interface * An interface representing AutoUserSpecification. - * @summary Specifies the parameters for the auto user that runs a task on the - * Batch service. - * + * @summary Specifies the parameters for the auto user that runs a task on the Batch service. */ export interface AutoUserSpecification { /** - * @member {AutoUserScope} [scope] The scope for the auto user. The default - * value is task. Possible values include: 'task', 'pool' + * The scope for the auto user. The default value is task. Possible values include: 'task', + * 'pool' */ scope?: AutoUserScope; /** - * @member {ElevationLevel} [elevationLevel] The elevation level of the auto - * user. The default value is nonAdmin. Possible values include: 'nonAdmin', - * 'admin' + * The elevation level of the auto user. The default value is nonAdmin. Possible values include: + * 'nonAdmin', 'admin' */ elevationLevel?: ElevationLevel; } /** - * @interface - * An interface representing UserIdentity. + * Specify either the userName or autoUser property, but not both. * @summary The definition of the user identity under which the task is run. - * - * Specify either the userName or autoUser property, but not both. On - * CloudServiceConfiguration pools, this user is logged in with the INTERACTIVE - * flag. On Windows VirtualMachineConfiguration pools, this user is logged in - * with the BATCH flag. - * */ export interface UserIdentity { /** - * @member {string} [userName] The name of the user identity under which the - * task is run. The userName and autoUser properties are mutually exclusive; - * you must specify one but not both. + * The name of the user identity under which the task is run. The userName and autoUser + * properties are mutually exclusive; you must specify one but not both. */ userName?: string; /** - * @member {AutoUserSpecification} [autoUser] The auto user under which the - * task is run. The userName and autoUser properties are mutually exclusive; - * you must specify one but not both. + * The auto user under which the task is run. The userName and autoUser properties are mutually + * exclusive; you must specify one but not both. */ autoUser?: AutoUserSpecification; } /** - * @interface * An interface representing LinuxUserConfiguration. * @summary Properties used to create a user account on a Linux node. - * */ export interface LinuxUserConfiguration { /** - * @member {number} [uid] The user ID of the user account. The uid and gid - * properties must be specified together or not at all. If not specified the - * underlying operating system picks the uid. + * The user ID of the user account. The uid and gid properties must be specified together or not + * at all. If not specified the underlying operating system picks the uid. */ uid?: number; /** - * @member {number} [gid] The group ID for the user account. The uid and gid - * properties must be specified together or not at all. If not specified the - * underlying operating system picks the gid. + * The group ID for the user account. The uid and gid properties must be specified together or + * not at all. If not specified the underlying operating system picks the gid. */ gid?: number; /** - * @member {string} [sshPrivateKey] The SSH private key for the user account. - * The private key must not be password protected. The private key is used to - * automatically configure asymmetric-key based authentication for SSH - * between nodes in a Linux pool when the pool's enableInterNodeCommunication - * property is true (it is ignored if enableInterNodeCommunication is false). - * It does this by placing the key pair into the user's .ssh directory. If - * not specified, password-less SSH is not configured between nodes (no - * modification of the user's .ssh directory is done). + * The SSH private key for the user account. The private key must not be password protected. The + * private key is used to automatically configure asymmetric-key based authentication for SSH + * between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true + * (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair + * into the user's .ssh directory. If not specified, password-less SSH is not configured between + * nodes (no modification of the user's .ssh directory is done). */ sshPrivateKey?: string; } /** - * @interface + * An interface representing WindowsUserConfiguration. + * @summary Properties used to create a user account on a Windows node. + */ +export interface WindowsUserConfiguration { + /** + * The login mode for the user. The default value for VirtualMachineConfiguration pools is batch + * and for CloudServiceConfiguration pools is interactive. Possible values include: 'batch', + * 'interactive' + */ + loginMode?: LoginMode; +} + +/** * An interface representing UserAccount. - * @summary Properties used to create a user used to execute tasks on an Azure - * Batch node. - * + * @summary Properties used to create a user used to execute tasks on an Azure Batch node. */ export interface UserAccount { /** - * @member {string} name The name of the user account. + * The name of the user account. */ name: string; /** - * @member {string} password The password for the user account. + * The password for the user account. */ password: string; /** - * @member {ElevationLevel} [elevationLevel] The elevation level of the user - * account. The default value is nonAdmin. Possible values include: - * 'nonAdmin', 'admin' + * The elevation level of the user account. The default value is nonAdmin. Possible values + * include: 'nonAdmin', 'admin' */ elevationLevel?: ElevationLevel; /** - * @member {LinuxUserConfiguration} [linuxUserConfiguration] The - * Linux-specific user configuration for the user account. This property is - * ignored if specified on a Windows pool. If not specified, the user is - * created with the default options. + * The Linux-specific user configuration for the user account. This property is ignored if + * specified on a Windows pool. If not specified, the user is created with the default options. */ linuxUserConfiguration?: LinuxUserConfiguration; + /** + * The Windows-specific user configuration for the user account. This property can only be + * specified if the user is on a Windows pool. If not specified and on a Windows pool, the user + * is created with the default options. + */ + windowsUserConfiguration?: WindowsUserConfiguration; } /** - * @interface * An interface representing TaskConstraints. * @summary Execution constraints to apply to a task. - * */ export interface TaskConstraints { /** - * @member {string} [maxWallClockTime] The maximum elapsed time that the task - * may run, measured from the time the task starts. If the task does not - * complete within the time limit, the Batch service terminates it. If this - * is not specified, there is no time limit on how long the task may run. + * The maximum elapsed time that the task may run, measured from the time the task starts. If the + * task does not complete within the time limit, the Batch service terminates it. If this is not + * specified, there is no time limit on how long the task may run. */ maxWallClockTime?: string; /** - * @member {string} [retentionTime] The minimum time to retain the task - * directory on the compute node where it ran, from the time it completes - * execution. After this time, the Batch service may delete the task - * directory and all its contents. The default is infinite, i.e. the task - * directory will be retained until the compute node is removed or reimaged. + * The minimum time to retain the task directory on the compute node where it ran, from the time + * it completes execution. After this time, the Batch service may delete the task directory and + * all its contents. The default is 7 days, i.e. the task directory will be retained for 7 days + * unless the compute node is removed or the job is deleted. */ retentionTime?: string; /** - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries - * for the task executable due to a nonzero exit code. The Batch service will - * try the task once, and may then retry up to this limit. For example, if - * the maximum retry count is 3, Batch tries the task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry the task after the first attempt. If the maximum - * retry count is -1, the Batch service retries the task without limit. - * Resource files and application packages are only downloaded again if the - * task is retried on a new compute node. + * The maximum number of times the task may be retried. The Batch service retries a task if its + * exit code is nonzero. Note that this value specifically controls the number of retries for the + * task executable due to a nonzero exit code. The Batch service will try the task once, and may + * then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the + * task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch + * service does not retry the task after the first attempt. If the maximum retry count is -1, the + * Batch service retries the task without limit. */ maxTaskRetryCount?: number; } /** - * @interface * An interface representing OutputFileBlobContainerDestination. - * @summary Specifies a file upload destination within an Azure blob storage - * container. - * + * @summary Specifies a file upload destination within an Azure blob storage container. */ export interface OutputFileBlobContainerDestination { /** - * @member {string} [path] The destination blob or virtual directory within - * the Azure Storage container. If filePattern refers to a specific file - * (i.e. contains no wildcards), then path is the name of the blob to which - * to upload that file. If filePattern contains one or more wildcards (and - * therefore may match multiple files), then path is the name of the blob - * virtual directory (which is prepended to each blob name) to which to - * upload the file(s). If omitted, file(s) are uploaded to the root of the - * container with a blob name matching their file name. + * The destination blob or virtual directory within the Azure Storage container. If filePattern + * refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to + * which to upload that file. If filePattern contains one or more wildcards (and therefore may + * match multiple files), then path is the name of the blob virtual directory (which is prepended + * to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the + * root of the container with a blob name matching their file name. */ path?: string; /** - * @member {string} containerUrl The URL of the container within Azure Blob - * Storage to which to upload the file(s). The URL must include a Shared - * Access Signature (SAS) granting write permissions to the container. + * The URL of the container within Azure Blob Storage to which to upload the file(s). The URL + * must include a Shared Access Signature (SAS) granting write permissions to the container. */ containerUrl: string; } /** - * @interface * An interface representing OutputFileDestination. * @summary The destination to which a file should be uploaded. - * */ export interface OutputFileDestination { /** - * @member {OutputFileBlobContainerDestination} [container] A location in - * Azure blob storage to which files are uploaded. + * A location in Azure blob storage to which files are uploaded. */ container?: OutputFileBlobContainerDestination; } /** - * @interface * An interface representing OutputFileUploadOptions. - * @summary Details about an output file upload operation, including under what - * conditions to perform the upload. - * + * @summary Details about an output file upload operation, including under what conditions to + * perform the upload. */ export interface OutputFileUploadOptions { /** - * @member {OutputFileUploadCondition} uploadCondition The conditions under - * which the task output file or set of files should be uploaded. The default - * is taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', + * The conditions under which the task output file or set of files should be uploaded. The + * default is taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', * 'taskCompletion' */ uploadCondition: OutputFileUploadCondition; } /** - * @interface * An interface representing OutputFile. - * @summary A specification for uploading files from an Azure Batch node to - * another location after the Batch service has finished executing the task - * process. - * + * @summary A specification for uploading files from an Azure Batch node to another location after + * the Batch service has finished executing the task process. */ export interface OutputFile { /** - * @member {string} filePattern A pattern indicating which file(s) to upload. - * Both relative and absolute paths are supported. Relative paths are - * relative to the task working directory. The following wildcards are - * supported: * matches 0 or more characters (for example pattern abc* would - * match abc or abcdef), ** matches any directory, ? matches any single - * character, [abc] matches one character in the brackets, and [a-c] matches - * one character in the range. Brackets can include a negation to match any - * character not specified (for example [!abc] matches any character but a, - * b, or c). If a file name starts with "." it is ignored by default but may - * be matched by specifying it explicitly (for example *.gif will not match - * .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that - * does not start in '.' and ends with .txt in the task working directory or - * any subdirectory. If the filename contains a wildcard character it can be - * escaped using brackets (for example abc[*] would match a file named abc*). - * Note that both \ and / are treated as directory separators on Windows, but - * only / is on Linux. Environment variables (%var% on Windows or $var on - * Linux) are expanded prior to the pattern being applied. + * A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. + * Relative paths are relative to the task working directory. The following wildcards are + * supported: * matches 0 or more characters (for example pattern abc* would match abc or + * abcdef), ** matches any directory, ? matches any single character, [abc] matches one character + * in the brackets, and [a-c] matches one character in the range. Brackets can include a negation + * to match any character not specified (for example [!abc] matches any character but a, b, or + * c). If a file name starts with "." it is ignored by default but may be matched by specifying + * it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: + * **\*.txt matches any file that does not start in '.' and ends with .txt in the task working + * directory or any subdirectory. If the filename contains a wildcard character it can be escaped + * using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are + * treated as directory separators on Windows, but only / is on Linux. Environment variables + * (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied. */ filePattern: string; /** - * @member {OutputFileDestination} destination The destination for the output - * file(s). + * The destination for the output file(s). */ destination: OutputFileDestination; /** - * @member {OutputFileUploadOptions} uploadOptions Additional options for the - * upload operation, including under what conditions to perform the upload. + * Additional options for the upload operation, including under what conditions to perform the + * upload. */ uploadOptions: OutputFileUploadOptions; } /** - * @interface - * An interface representing JobManagerTask. + * The Job Manager task is automatically started when the job is created. The Batch service tries + * to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the + * Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as + * possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager + * tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it + * at the highest priority. If there are no idle nodes available, the system may terminate one of + * the running tasks in the pool and return it to the queue in order to make room for the Job + * Manager task to restart. Note that a Job Manager task in one job does not have priority over + * tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job + * Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 + * job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples + * of recovery operations include (but are not limited to) when an unhealthy compute node is + * rebooted or a compute node disappeared due to host failure. Retries due to recovery operations + * are independent of and are not counted against the maxTaskRetryCount. Even if the + * maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of + * this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + * restarted without causing any corruption or duplicate data. The best practice for long running + * tasks is to use some form of checkpointing. * @summary Specifies details of a Job Manager task. - * - * The Job Manager task is automatically started when the job is created. The - * Batch service tries to schedule the Job Manager task before any other tasks - * in the job. When shrinking a pool, the Batch service tries to preserve - * compute nodes where Job Manager tasks are running for as long as possible - * (that is, nodes running 'normal' tasks are removed before nodes running Job - * Manager tasks). When a Job Manager task fails and needs to be restarted, the - * system tries to schedule it at the highest priority. If there are no idle - * nodes available, the system may terminate one of the running tasks in the - * pool and return it to the queue in order to make room for the Job Manager - * task to restart. Note that a Job Manager task in one job does not have - * priority over tasks in other jobs. Across jobs, only job level priorities - * are observed. For example, if a Job Manager in a priority 0 job needs to be - * restarted, it will not displace tasks of a priority 1 job. Batch will retry - * tasks when a recovery operation is triggered on a compute node. Examples of - * recovery operations include (but are not limited to) when an unhealthy - * compute node is rebooted or a compute node disappeared due to host failure. - * Retries due to recovery operations are independent of and are not counted - * against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an - * internal retry due to a recovery operation may occur. Because of this, all - * tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * */ export interface JobManagerTask { /** - * @member {string} id A string that uniquely identifies the Job Manager task - * within the job. The ID can contain any combination of alphanumeric - * characters including hyphens and underscores and cannot contain more than - * 64 characters. + * A string that uniquely identifies the Job Manager task within the job. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores and cannot contain + * more than 64 characters. */ id: string; /** - * @member {string} [displayName] The display name of the Job Manager task. - * It need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * The display name of the Job Manager task. It need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} commandLine The command line of the Job Manager task. The - * command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in - * the command line, for example using "cmd /c MyCommand" in Windows or - * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, - * it should use a relative path (relative to the task working directory), or - * use the Batch provided environment variable + * The command line of the Job Manager task. The command line does not run under a shell, and + * therefore cannot take advantage of shell features such as environment variable expansion. If + * you want to take advantage of such features, you should invoke the shell in the command line, + * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + * command line refers to file paths, it should use a relative path (relative to the task working + * directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the Job Manager task runs. If the pool that will run - * this task has containerConfiguration set, this must be set as well. If the - * pool that will run this task doesn't have containerConfiguration set, this - * must not be set. When this is specified, all directories recursively below - * the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the - * node) are mapped into the container, all task environment variables are - * mapped into the container, and the task command line is executed in the - * container. + * The settings for the container under which the Job Manager task runs. If the pool that will + * run this task has containerConfiguration set, this must be set as well. If the pool that will + * run this task doesn't have containerConfiguration set, this must not be set. When this is + * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure + * Batch directories on the node) are mapped into the container, all task environment variables + * are mapped into the container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * Files listed under this element are located in the task's working - * directory. There is a maximum size for the list of resource files. When - * the max size is exceeded, the request will fail and the response error - * code will be RequestEntityTooLarge. If this occurs, the collection of - * ResourceFiles must be reduced in size. This can be achieved using .zip + * A list of files that the Batch service will download to the compute node before running the + * command line. Files listed under this element are located in the task's working directory. + * There is a maximum size for the list of resource files. When the max size is exceeded, the + * request will fail and the response error code will be RequestEntityTooLarge. If this occurs, + * the collection of ResourceFiles must be reduced in size. This can be achieved using .zip * files, Application Packages, or Docker Containers. */ resourceFiles?: ResourceFile[]; /** - * @member {OutputFile[]} [outputFiles] A list of files that the Batch - * service will upload from the compute node after running the command line. - * For multi-instance tasks, the files will only be uploaded from the compute - * node on which the primary task is executed. + * A list of files that the Batch service will upload from the compute node after running the + * command line. For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. */ outputFiles?: OutputFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the Job Manager task. + * A list of environment variable settings for the Job Manager task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {TaskConstraints} [constraints] Constraints that apply to the Job - * Manager task. + * Constraints that apply to the Job Manager task. */ constraints?: TaskConstraints; /** - * @member {boolean} [killJobOnCompletion] Whether completion of the Job - * Manager task signifies completion of the entire job. If true, when the Job - * Manager task completes, the Batch service marks the job as complete. If - * any tasks are still running at this time (other than Job Release), those - * tasks are terminated. If false, the completion of the Job Manager task - * does not affect the job status. In this case, you should either use the - * onAllTasksComplete attribute to terminate the job, or have a client or - * user terminate the job explicitly. An example of this is if the Job - * Manager creates a set of tasks but then takes no further role in their - * execution. The default value is true. If you are using the - * onAllTasksComplete and onTaskFailure attributes to control job lifetime, - * and using the Job Manager task only to create the tasks for the job (not - * to monitor progress), then it is important to set killJobOnCompletion to - * false. + * Whether completion of the Job Manager task signifies completion of the entire job. If true, + * when the Job Manager task completes, the Batch service marks the job as complete. If any tasks + * are still running at this time (other than Job Release), those tasks are terminated. If false, + * the completion of the Job Manager task does not affect the job status. In this case, you + * should either use the onAllTasksComplete attribute to terminate the job, or have a client or + * user terminate the job explicitly. An example of this is if the Job Manager creates a set of + * tasks but then takes no further role in their execution. The default value is true. If you are + * using the onAllTasksComplete and onTaskFailure attributes to control job lifetime, and using + * the Job Manager task only to create the tasks for the job (not to monitor progress), then it + * is important to set killJobOnCompletion to false. */ killJobOnCompletion?: boolean; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * Job Manager task runs. If omitted, the task runs as a non-administrative - * user unique to the task. + * The user identity under which the Job Manager task runs. If omitted, the task runs as a + * non-administrative user unique to the task. */ userIdentity?: UserIdentity; /** - * @member {boolean} [runExclusive] Whether the Job Manager task requires - * exclusive use of the compute node where it runs. If true, no other tasks - * will run on the same compute node for as long as the Job Manager is - * running. If false, other tasks can run simultaneously with the Job Manager - * on a compute node. The Job Manager task counts normally against the node's - * concurrent task limit, so this is only relevant if the node allows - * multiple concurrent tasks. The default value is true. + * Whether the Job Manager task requires exclusive use of the compute node where it runs. If + * true, no other tasks will run on the same compute node for as long as the Job Manager is + * running. If false, other tasks can run simultaneously with the Job Manager on a compute node. + * The Job Manager task counts normally against the node's concurrent task limit, so this is only + * relevant if the node allows multiple concurrent tasks. The default value is true. */ runExclusive?: boolean; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] A - * list of application packages that the Batch service will deploy to the - * compute node before running the command line. Application packages are - * downloaded and deployed to a shared directory, not the task working - * directory. Therefore, if a referenced package is already on the compute - * node, and is up to date, then it is not re-downloaded; the existing copy - * on the compute node is used. If a referenced application package cannot be - * installed, for example because the package has been deleted or because - * download failed, the task fails. + * A list of application packages that the Batch service will deploy to the compute node before + * running the command line. Application packages are downloaded and deployed to a shared + * directory, not the task working directory. Therefore, if a referenced package is already on + * the compute node, and is up to date, then it is not re-downloaded; the existing copy on the + * compute node is used. If a referenced application package cannot be installed, for example + * because the package has been deleted or because download failed, the task fails. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {AuthenticationTokenSettings} [authenticationTokenSettings] The - * settings for an authentication token that the task can use to perform - * Batch service operations. If this property is set, the Batch service - * provides the task with an authentication token which can be used to - * authenticate Batch service operations without requiring an account access - * key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN - * environment variable. The operations that the task can carry out using the - * token depend on the settings. For example, a task can request job - * permissions in order to add other tasks to the job, or check the status of - * the job or of other tasks under the job. + * The settings for an authentication token that the task can use to perform Batch service + * operations. If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. */ authenticationTokenSettings?: AuthenticationTokenSettings; /** - * @member {boolean} [allowLowPriorityNode] Whether the Job Manager task may - * run on a low-priority compute node. The default value is true. + * Whether the Job Manager task may run on a low-priority compute node. The default value is + * true. */ allowLowPriorityNode?: boolean; } /** - * @interface - * An interface representing JobPreparationTask. - * @summary A Job Preparation task to run before any tasks of the job on any - * given compute node. - * - * You can use Job Preparation to prepare a compute node to run tasks for the - * job. Activities commonly performed in Job Preparation include: Downloading - * common resource files used by all the tasks in the job. The Job Preparation - * task can download these common resource files to the shared location on the - * compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service - * on the compute node so that all tasks of that job can communicate with it. - * If the Job Preparation task fails (that is, exhausts its retry count before - * exiting with exit code 0), Batch will not run tasks of this job on the - * compute node. The node remains ineligible to run tasks of this job until it - * is reimaged. The node remains active and can be used for other jobs. The Job - * Preparation task can run multiple times on the same compute node. Therefore, - * you should write the Job Preparation task to handle re-execution. If the - * compute node is rebooted, the Job Preparation task is run again on the node - * before scheduling any other task of the job, if - * rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not - * previously complete. If the compute node is reimaged, the Job Preparation - * task is run again before scheduling any task of the job. Batch will retry - * tasks when a recovery operation is triggered on a compute node. Examples of - * recovery operations include (but are not limited to) when an unhealthy - * compute node is rebooted or a compute node disappeared due to host failure. - * Retries due to recovery operations are independent of and are not counted - * against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an - * internal retry due to a recovery operation may occur. Because of this, all - * tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * + * You can use Job Preparation to prepare a compute node to run tasks for the job. Activities + * commonly performed in Job Preparation include: Downloading common resource files used by all the + * tasks in the job. The Job Preparation task can download these common resource files to the + * shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local + * service on the compute node so that all tasks of that job can communicate with it. If the Job + * Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), + * Batch will not run tasks of this job on the compute node. The node remains ineligible to run + * tasks of this job until it is reimaged. The node remains active and can be used for other jobs. + * The Job Preparation task can run multiple times on the same compute node. Therefore, you should + * write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job + * Preparation task is run again on the node before scheduling any other task of the job, if + * rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously + * complete. If the compute node is reimaged, the Job Preparation task is run again before + * scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on + * a compute node. Examples of recovery operations include (but are not limited to) when an + * unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries + * due to recovery operations are independent of and are not counted against the maxTaskRetryCount. + * Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. + * Because of this, all tasks should be idempotent. This means tasks need to tolerate being + * interrupted and restarted without causing any corruption or duplicate data. The best practice + * for long running tasks is to use some form of checkpointing. + * @summary A Job Preparation task to run before any tasks of the job on any given compute node. */ export interface JobPreparationTask { /** - * @member {string} [id] A string that uniquely identifies the Job - * Preparation task within the job. The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot - * contain more than 64 characters. If you do not specify this property, the - * Batch service assigns a default value of 'jobpreparation'. No other task - * in the job can have the same ID as the Job Preparation task. If you try to - * submit a task with the same id, the Batch service rejects the request with - * error code TaskIdSameAsJobPreparationTask; if you are calling the REST API - * directly, the HTTP status code is 409 (Conflict). + * A string that uniquely identifies the Job Preparation task within the job. The ID can contain + * any combination of alphanumeric characters including hyphens and underscores and cannot + * contain more than 64 characters. If you do not specify this property, the Batch service + * assigns a default value of 'jobpreparation'. No other task in the job can have the same ID as + * the Job Preparation task. If you try to submit a task with the same id, the Batch service + * rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the + * REST API directly, the HTTP status code is 409 (Conflict). */ id?: string; /** - * @member {string} commandLine The command line of the Job Preparation task. - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in - * the command line, for example using "cmd /c MyCommand" in Windows or - * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, - * it should use a relative path (relative to the task working directory), or - * use the Batch provided environment variable + * The command line of the Job Preparation task. The command line does not run under a shell, and + * therefore cannot take advantage of shell features such as environment variable expansion. If + * you want to take advantage of such features, you should invoke the shell in the command line, + * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + * command line refers to file paths, it should use a relative path (relative to the task working + * directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the Job Preparation task runs. When this is - * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, - * and the task command line is executed in the container. + * The settings for the container under which the Job Preparation task runs. When this is + * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure + * Batch directories on the node) are mapped into the container, all task environment variables + * are mapped into the container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * Files listed under this element are located in the task's working - * directory. There is a maximum size for the list of resource files. When - * the max size is exceeded, the request will fail and the response error - * code will be RequestEntityTooLarge. If this occurs, the collection of - * ResourceFiles must be reduced in size. This can be achieved using .zip + * A list of files that the Batch service will download to the compute node before running the + * command line. Files listed under this element are located in the task's working directory. + * There is a maximum size for the list of resource files. When the max size is exceeded, the + * request will fail and the response error code will be RequestEntityTooLarge. If this occurs, + * the collection of ResourceFiles must be reduced in size. This can be achieved using .zip * files, Application Packages, or Docker Containers. */ resourceFiles?: ResourceFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the Job Preparation task. + * A list of environment variable settings for the Job Preparation task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {TaskConstraints} [constraints] Constraints that apply to the Job - * Preparation task. + * Constraints that apply to the Job Preparation task. */ constraints?: TaskConstraints; /** - * @member {boolean} [waitForSuccess] Whether the Batch service should wait - * for the Job Preparation task to complete successfully before scheduling - * any other tasks of the job on the compute node. A Job Preparation task has - * completed successfully if it exits with exit code 0. If true and the Job - * Preparation task fails on a compute node, the Batch service retries the - * Job Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully - * after all retries, then the Batch service will not schedule tasks of the - * job to the compute node. The compute node remains active and eligible to - * run tasks of other jobs. If false, the Batch service will not wait for the - * Job Preparation task to complete. In this case, other tasks of the job can - * start executing on the compute node while the Job Preparation task is - * still running; and even if the Job Preparation task fails, new tasks will - * continue to be scheduled on the node. The default value is true. + * Whether the Batch service should wait for the Job Preparation task to complete successfully + * before scheduling any other tasks of the job on the compute node. A Job Preparation task has + * completed successfully if it exits with exit code 0. If true and the Job Preparation task + * fails on a compute node, the Batch service retries the Job Preparation task up to its maximum + * retry count (as specified in the constraints element). If the task has still not completed + * successfully after all retries, then the Batch service will not schedule tasks of the job to + * the compute node. The compute node remains active and eligible to run tasks of other jobs. If + * false, the Batch service will not wait for the Job Preparation task to complete. In this case, + * other tasks of the job can start executing on the compute node while the Job Preparation task + * is still running; and even if the Job Preparation task fails, new tasks will continue to be + * scheduled on the node. The default value is true. */ waitForSuccess?: boolean; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a - * non-administrative user unique to the pool on Linux nodes. + * The user identity under which the Job Preparation task runs. If omitted, the task runs as a + * non-administrative user unique to the task on Windows nodes, or a non-administrative user + * unique to the pool on Linux nodes. */ userIdentity?: UserIdentity; /** - * @member {boolean} [rerunOnNodeRebootAfterSuccess] Whether the Batch - * service should rerun the Job Preparation task after a compute node - * reboots. The Job Preparation task is always rerun if a compute node is - * reimaged, or if the Job Preparation task did not complete (e.g. because - * the reboot occurred while the task was running). Therefore, you should - * always write a Job Preparation task to be idempotent and to behave - * correctly if run multiple times. The default value is true. + * Whether the Batch service should rerun the Job Preparation task after a compute node reboots. + * The Job Preparation task is always rerun if a compute node is reimaged, or if the Job + * Preparation task did not complete (e.g. because the reboot occurred while the task was + * running). Therefore, you should always write a Job Preparation task to be idempotent and to + * behave correctly if run multiple times. The default value is true. */ rerunOnNodeRebootAfterSuccess?: boolean; } /** - * @interface - * An interface representing JobReleaseTask. - * @summary A Job Release task to run on job completion on any compute node - * where the job has run. - * - * The Job Release task runs when the job ends, because of one of the - * following: The user calls the Terminate Job API, or the Delete Job API while - * the job is still active, the job's maximum wall clock time constraint is - * reached, and the job is still active, or the job's Job Manager task - * completed, and the job is configured to terminate when the Job Manager - * completes. The Job Release task runs on each compute node where tasks of the - * job have run and the Job Preparation task ran and completed. If you reimage - * a compute node after it has run the Job Preparation task, and the job ends - * without any further tasks of the job running on that compute node (and hence - * the Job Preparation task does not re-run), then the Job Release task does - * not run on that node. If a compute node reboots while the Job Release task - * is still running, the Job Release task runs again when the compute node - * starts up. The job is not marked as complete until all Job Release tasks - * have completed. The Job Release task runs in the background. It does not - * occupy a scheduling slot; that is, it does not count towards the - * maxTasksPerNode limit specified on the pool. - * + * The Job Release task runs when the job ends, because of one of the following: The user calls the + * Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall + * clock time constraint is reached, and the job is still active, or the job's Job Manager task + * completed, and the job is configured to terminate when the Job Manager completes. The Job + * Release task runs on each compute node where tasks of the job have run and the Job Preparation + * task ran and completed. If you reimage a compute node after it has run the Job Preparation task, + * and the job ends without any further tasks of the job running on that compute node (and hence + * the Job Preparation task does not re-run), then the Job Release task does not run on that node. + * If a compute node reboots while the Job Release task is still running, the Job Release task runs + * again when the compute node starts up. The job is not marked as complete until all Job Release + * tasks have completed. The Job Release task runs in the background. It does not occupy a + * scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the + * pool. + * @summary A Job Release task to run on job completion on any compute node where the job has run. */ export interface JobReleaseTask { /** - * @member {string} [id] A string that uniquely identifies the Job Release - * task within the job. The ID can contain any combination of alphanumeric - * characters including hyphens and underscores and cannot contain more than - * 64 characters. If you do not specify this property, the Batch service - * assigns a default value of 'jobrelease'. No other task in the job can have - * the same ID as the Job Release task. If you try to submit a task with the - * same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). + * A string that uniquely identifies the Job Release task within the job. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores and cannot contain + * more than 64 characters. If you do not specify this property, the Batch service assigns a + * default value of 'jobrelease'. No other task in the job can have the same ID as the Job + * Release task. If you try to submit a task with the same id, the Batch service rejects the + * request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, + * the HTTP status code is 409 (Conflict). */ id?: string; /** - * @member {string} commandLine The command line of the Job Release task. The - * command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in - * the command line, for example using "cmd /c MyCommand" in Windows or - * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, - * it should use a relative path (relative to the task working directory), or - * use the Batch provided environment variable + * The command line of the Job Release task. The command line does not run under a shell, and + * therefore cannot take advantage of shell features such as environment variable expansion. If + * you want to take advantage of such features, you should invoke the shell in the command line, + * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + * command line refers to file paths, it should use a relative path (relative to the task working + * directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the Job Release task runs. When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all - * task environment variables are mapped into the container, and the task - * command line is executed in the container. + * The settings for the container under which the Job Release task runs. When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch + * directories on the node) are mapped into the container, all task environment variables are + * mapped into the container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. Files listed under this - * element are located in the task's working directory. + * A list of files that the Batch service will download to the compute node before running the + * command line. There is a maximum size for the list of resource files. When the max size is + * exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If + * this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved + * using .zip files, Application Packages, or Docker Containers. Files listed under this element + * are located in the task's working directory. */ resourceFiles?: ResourceFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the Job Release task. + * A list of environment variable settings for the Job Release task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {string} [maxWallClockTime] The maximum elapsed time that the Job - * Release task may run on a given compute node, measured from the time the - * task starts. If the task does not complete within the time limit, the - * Batch service terminates it. The default value is 15 minutes. You may not - * specify a timeout longer than 15 minutes. If you do, the Batch service - * rejects it with an error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). + * The maximum elapsed time that the Job Release task may run on a given compute node, measured + * from the time the task starts. If the task does not complete within the time limit, the Batch + * service terminates it. The default value is 15 minutes. You may not specify a timeout longer + * than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the + * REST API directly, the HTTP status code is 400 (Bad Request). */ maxWallClockTime?: string; /** - * @member {string} [retentionTime] The minimum time to retain the task - * directory for the Job Release task on the compute node. After this time, - * the Batch service may delete the task directory and all its contents. The - * default is infinite, i.e. the task directory will be retained until the - * compute node is removed or reimaged. + * The minimum time to retain the task directory for the Job Release task on the compute node. + * After this time, the Batch service may delete the task directory and all its contents. The + * default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node + * is removed or the job is deleted. */ retentionTime?: string; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * Job Release task runs. If omitted, the task runs as a non-administrative - * user unique to the task. + * The user identity under which the Job Release task runs. If omitted, the task runs as a + * non-administrative user unique to the task. */ userIdentity?: UserIdentity; } /** - * @interface * An interface representing TaskSchedulingPolicy. * @summary Specifies how tasks should be distributed across compute nodes. - * */ export interface TaskSchedulingPolicy { /** - * @member {ComputeNodeFillType} nodeFillType How tasks are distributed - * across compute nodes in a pool. Possible values include: 'spread', 'pack' + * How tasks are distributed across compute nodes in a pool. Possible values include: 'spread', + * 'pack' */ nodeFillType: ComputeNodeFillType; } /** - * @interface - * An interface representing StartTask. - * @summary A task which is run when a compute node joins a pool in the Azure - * Batch service, or when the compute node is rebooted or reimaged. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * + * Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of + * recovery operations include (but are not limited to) when an unhealthy compute node is rebooted + * or a compute node disappeared due to host failure. Retries due to recovery operations are + * independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount + * is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should + * be idempotent. This means tasks need to tolerate being interrupted and restarted without causing + * any corruption or duplicate data. The best practice for long running tasks is to use some form + * of checkpointing. In some cases the start task may be re-run even though the node was not + * rebooted. Special care should be taken to avoid start tasks which create breakaway process or + * install/launch services from the start task working directory, as this will block Batch from + * being able to re-run the start task. + * @summary A task which is run when a compute node joins a pool in the Azure Batch service, or + * when the compute node is rebooted or reimaged. */ export interface StartTask { /** - * @member {string} commandLine The command line of the start task. The - * command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in - * the command line, for example using "cmd /c MyCommand" in Windows or - * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, - * it should use a relative path (relative to the task working directory), or - * use the Batch provided environment variable + * The command line of the start task. The command line does not run under a shell, and therefore + * cannot take advantage of shell features such as environment variable expansion. If you want to + * take advantage of such features, you should invoke the shell in the command line, for example + * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line + * refers to file paths, it should use a relative path (relative to the task working directory), + * or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the start task runs. When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all - * task environment variables are mapped into the container, and the task - * command line is executed in the container. + * The settings for the container under which the start task runs. When this is specified, all + * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories + * on the node) are mapped into the container, all task environment variables are mapped into the + * container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. Files listed under this - * element are located in the task's working directory. + * A list of files that the Batch service will download to the compute node before running the + * command line. There is a maximum size for the list of resource files. When the max size is + * exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If + * this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved + * using .zip files, Application Packages, or Docker Containers. Files listed under this element + * are located in the task's working directory. */ resourceFiles?: ResourceFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the start task. + * A list of environment variable settings for the start task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * start task runs. If omitted, the task runs as a non-administrative user - * unique to the task. + * The user identity under which the start task runs. If omitted, the task runs as a + * non-administrative user unique to the task. */ userIdentity?: UserIdentity; /** - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries. - * The Batch service will try the task once, and may then retry up to this - * limit. For example, if the maximum retry count is 3, Batch tries the task - * up to 4 times (one initial try and 3 retries). If the maximum retry count - * is 0, the Batch service does not retry the task. If the maximum retry - * count is -1, the Batch service retries the task without limit. + * The maximum number of times the task may be retried. The Batch service retries a task if its + * exit code is nonzero. Note that this value specifically controls the number of retries. The + * Batch service will try the task once, and may then retry up to this limit. For example, if the + * maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). + * If the maximum retry count is 0, the Batch service does not retry the task. If the maximum + * retry count is -1, the Batch service retries the task without limit. */ maxTaskRetryCount?: number; /** - * @member {boolean} [waitForSuccess] Whether the Batch service should wait - * for the start task to complete successfully (that is, to exit with exit - * code 0) before scheduling any tasks on the compute node. If true and the - * start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. + * Whether the Batch service should wait for the start task to complete successfully (that is, to + * exit with exit code 0) before scheduling any tasks on the compute node. If true and the start + * task fails on a compute node, the Batch service retries the start task up to its maximum retry + * count (maxTaskRetryCount). If the task has still not completed successfully after all retries, + * then the Batch service marks the compute node unusable, and will not schedule tasks to it. + * This condition can be detected via the node state and failure info details. If false, the + * Batch service will not wait for the start task to complete. In this case, other tasks can + * start executing on the compute node while the start task is still running; and even if the + * start task fails, new tasks will continue to be scheduled on the node. The default is false. */ waitForSuccess?: boolean; } /** - * @interface * An interface representing CertificateReference. - * @summary A reference to a certificate to be installed on compute nodes in a - * pool. - * + * @summary A reference to a certificate to be installed on compute nodes in a pool. */ export interface CertificateReference { /** - * @member {string} thumbprint The thumbprint of the certificate. + * The thumbprint of the certificate. */ thumbprint: string; /** - * @member {string} thumbprintAlgorithm The algorithm with which the - * thumbprint is associated. This must be sha1. + * The algorithm with which the thumbprint is associated. This must be sha1. */ thumbprintAlgorithm: string; /** - * @member {CertificateStoreLocation} [storeLocation] The location of the - * certificate store on the compute node into which to install the - * certificate. The default value is currentuser. This property is applicable - * only for pools configured with Windows nodes (that is, created with - * cloudServiceConfiguration, or with virtualMachineConfiguration using a - * Windows image reference). For Linux compute nodes, the certificates are - * stored in a directory inside the task working directory and an environment - * variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for - * this location. For certificates with visibility of 'remoteUser', a 'certs' - * directory is created in the user's home directory (e.g., - * /home/{user-name}/certs) and certificates are placed in that directory. + * The location of the certificate store on the compute node into which to install the + * certificate. The default value is currentuser. This property is applicable only for pools + * configured with Windows nodes (that is, created with cloudServiceConfiguration, or with + * virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the + * certificates are stored in a directory inside the task working directory and an environment + * variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For + * certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's + * home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. * Possible values include: 'currentUser', 'localMachine' */ storeLocation?: CertificateStoreLocation; /** - * @member {string} [storeName] The name of the certificate store on the - * compute node into which to install the certificate. This property is - * applicable only for pools configured with Windows nodes (that is, created - * with cloudServiceConfiguration, or with virtualMachineConfiguration using - * a Windows image reference). Common store names include: My, Root, CA, - * Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, - * but any custom store name can also be used. The default value is My. + * The name of the certificate store on the compute node into which to install the certificate. + * This property is applicable only for pools configured with Windows nodes (that is, created + * with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image + * reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, + * TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The + * default value is My. */ storeName?: string; /** - * @member {CertificateVisibility[]} [visibility] Which user accounts on the - * compute node should have access to the private data of the certificate. - * You can specify more than one visibility in this collection. The default - * is all accounts. + * Which user accounts on the compute node should have access to the private data of the + * certificate. You can specify more than one visibility in this collection. The default is all + * accounts. */ visibility?: CertificateVisibility[]; } /** - * @interface - * An interface representing MetadataItem. + * The Batch service does not assign any meaning to this metadata; it is solely for the use of user + * code. * @summary A name-value pair associated with a Batch service resource. - * - * The Batch service does not assign any meaning to this metadata; it is solely - * for the use of user code. - * */ export interface MetadataItem { /** - * @member {string} name The name of the metadata item. + * The name of the metadata item. */ name: string; /** - * @member {string} value The value of the metadata item. + * The value of the metadata item. */ value: string; } /** - * @interface * An interface representing CloudServiceConfiguration. - * @summary The configuration for nodes in a pool based on the Azure Cloud - * Services platform. - * + * @summary The configuration for nodes in a pool based on the Azure Cloud Services platform. */ export interface CloudServiceConfiguration { /** - * @member {string} osFamily The Azure Guest OS family to be installed on the - * virtual machines in the pool. Possible values are: + * The Azure Guest OS family to be installed on the virtual machines in the pool. Possible values + * are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases + * 5 - OS Family 5, equivalent to Windows Server 2016. + * 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS + * Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). */ osFamily: string; /** - * @member {string} [targetOSVersion] The Azure Guest OS version to be - * installed on the virtual machines in the pool. The default value is * - * which specifies the latest operating system version for the specified OS - * family. - */ - targetOSVersion?: string; - /** - * @member {string} [currentOSVersion] The Azure Guest OS Version currently - * installed on the virtual machines in the pool. This may differ from - * targetOSVersion if the pool state is Upgrading. In this case some virtual - * machines may be on the targetOSVersion and some may be on the - * currentOSVersion during the upgrade process. Once all virtual machines - * have upgraded, currentOSVersion is updated to be the same as - * targetOSVersion. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** - */ - readonly currentOSVersion?: string; -} - -/** - * @interface - * An interface representing OSDisk. - * @summary Settings for the operating system disk of the virtual machine. - * - */ -export interface OSDisk { - /** - * @member {CachingType} [caching] The type of caching to enable for the OS - * disk. The default value for caching is readwrite. For information about - * the caching options see: - * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. - * Possible values include: 'none', 'readOnly', 'readWrite' + * The Azure Guest OS version to be installed on the virtual machines in the pool. The default + * value is * which specifies the latest operating system version for the specified OS family. */ - caching?: CachingType; + osVersion?: string; } /** - * @interface * An interface representing WindowsConfiguration. * @summary Windows operating system settings to apply to the virtual machine. - * */ export interface WindowsConfiguration { /** - * @member {boolean} [enableAutomaticUpdates] Whether automatic updates are - * enabled on the virtual machine. If omitted, the default value is true. + * Whether automatic updates are enabled on the virtual machine. If omitted, the default value is + * true. */ enableAutomaticUpdates?: boolean; } /** - * @interface * An interface representing DataDisk. - * @summary Settings which will be used by the data disks associated to compute - * nodes in the pool. - * + * @summary Settings which will be used by the data disks associated to compute nodes in the pool. */ export interface DataDisk { /** - * @member {number} lun The logical unit number. The lun is used to uniquely - * identify each data disk. If attaching multiple disks, each should have a - * distinct lun. + * The logical unit number. The lun is used to uniquely identify each data disk. If attaching + * multiple disks, each should have a distinct lun. */ lun: number; /** - * @member {CachingType} [caching] The type of caching to be enabled for the - * data disks. The default value for caching is readwrite. For information - * about the caching options see: + * The type of caching to be enabled for the data disks. The default value for caching is + * readwrite. For information about the caching options see: * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. * Possible values include: 'none', 'readOnly', 'readWrite' */ caching?: CachingType; /** - * @member {number} diskSizeGB The initial disk size in gigabytes. + * The initial disk size in gigabytes. */ diskSizeGB: number; /** - * @member {StorageAccountType} [storageAccountType] The storage account type - * to be used for the data disk. If omitted, the default is "standard_lrs". - * Possible values include: 'StandardLRS', 'PremiumLRS' + * The storage account type to be used for the data disk. If omitted, the default is + * "standard_lrs". Possible values include: 'StandardLRS', 'PremiumLRS' */ storageAccountType?: StorageAccountType; } /** - * @interface * An interface representing ContainerConfiguration. * @summary The configuration for container-enabled pools. - * */ export interface ContainerConfiguration { /** - * @member {string[]} [containerImageNames] The collection of container image - * names. This is the full image reference, as would be specified to "docker - * pull". An image will be sourced from the default Docker registry unless + * The collection of container image names. This is the full image reference, as would be + * specified to "docker pull". An image will be sourced from the default Docker registry unless * the image is fully qualified with an alternative registry. */ containerImageNames?: string[]; /** - * @member {ContainerRegistry[]} [containerRegistries] Additional private - * registries from which containers can be pulled. If any images must be - * downloaded from a private registry which requires credentials, then those - * credentials must be provided here. + * Additional private registries from which containers can be pulled. If any images must be + * downloaded from a private registry which requires credentials, then those credentials must be + * provided here. */ containerRegistries?: ContainerRegistry[]; } /** - * @interface * An interface representing VirtualMachineConfiguration. - * @summary The configuration for compute nodes in a pool based on the Azure - * Virtual Machines infrastructure. - * + * @summary The configuration for compute nodes in a pool based on the Azure Virtual Machines + * infrastructure. */ export interface VirtualMachineConfiguration { /** - * @member {ImageReference} imageReference A reference to the Azure Virtual - * Machines Marketplace image or the custom Virtual Machine image to use. + * A reference to the Azure Virtual Machines Marketplace image or the custom Virtual Machine + * image to use. */ imageReference: ImageReference; /** - * @member {OSDisk} [osDisk] Settings for the operating system disk of the - * Virtual Machine. - */ - osDisk?: OSDisk; - /** - * @member {string} nodeAgentSKUId The SKU of the Batch node agent to be - * provisioned on compute nodes in the pool. The Batch node agent is a - * program that runs on each node in the pool, and provides the - * command-and-control interface between the node and the Batch service. - * There are different implementations of the node agent, known as SKUs, for - * different operating systems. You must specify a node agent SKU which - * matches the selected image reference. To get the list of supported node - * agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. + * The SKU of the Batch node agent to be provisioned on compute nodes in the pool. The Batch node + * agent is a program that runs on each node in the pool, and provides the command-and-control + * interface between the node and the Batch service. There are different implementations of the + * node agent, known as SKUs, for different operating systems. You must specify a node agent SKU + * which matches the selected image reference. To get the list of supported node agent SKUs along + * with their list of verified image references, see the 'List supported node agent SKUs' + * operation. */ nodeAgentSKUId: string; /** - * @member {WindowsConfiguration} [windowsConfiguration] Windows operating - * system settings on the virtual machine. This property must not be - * specified if the imageReference or osDisk property specifies a Linux OS - * image. + * Windows operating system settings on the virtual machine. This property must not be specified + * if the imageReference property specifies a Linux OS image. */ windowsConfiguration?: WindowsConfiguration; /** - * @member {DataDisk[]} [dataDisks] The configuration for data disks attached - * to the comptue nodes in the pool. This property must be specified if the - * compute nodes in the pool need to have empty data disks attached to them. - * This cannot be updated. Each node gets its own disk (the disk is not a - * file share). Existing disks cannot be attached, each attached disk is - * empty. When the node is removed from the pool, the disk and all data - * associated with it is also deleted. The disk is not formatted after being - * attached, it must be formatted before use - for more information see + * The configuration for data disks attached to the compute nodes in the pool. This property must + * be specified if the compute nodes in the pool need to have empty data disks attached to them. + * This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing + * disks cannot be attached, each attached disk is empty. When the node is removed from the pool, + * the disk and all data associated with it is also deleted. The disk is not formatted after + * being attached, it must be formatted before use - for more information see * https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux * and * https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. */ dataDisks?: DataDisk[]; /** - * @member {string} [licenseType] The type of on-premises license to be used - * when deploying the operating system. This only applies to images that - * contain the Windows operating system, and should only be used when you - * hold valid on-premises licenses for the nodes which will be deployed. If - * omitted, no on-premises licensing discount is applied. Values are: + * The type of on-premises license to be used when deploying the operating system. This only + * applies to images that contain the Windows operating system, and should only be used when you + * hold valid on-premises licenses for the nodes which will be deployed. If omitted, no + * on-premises licensing discount is applied. Values are: * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. */ licenseType?: string; /** - * @member {ContainerConfiguration} [containerConfiguration] The container - * configuration for the pool. If specified, setup is performed on each node - * in the pool to allow tasks to run in containers. All regular tasks and job - * manager tasks run on this pool must specify the containerSettings - * property, and all other tasks may specify it. + * The container configuration for the pool. If specified, setup is performed on each node in the + * pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this + * pool must specify the containerSettings property, and all other tasks may specify it. */ containerConfiguration?: ContainerConfiguration; } /** - * @interface * An interface representing NetworkSecurityGroupRule. * @summary A network security group rule to apply to an inbound endpoint. - * */ export interface NetworkSecurityGroupRule { /** - * @member {number} priority The priority for this rule. Priorities within a - * pool must be unique and are evaluated in order of priority. The lower the - * number the higher the priority. For example, rules could be specified with - * order numbers of 150, 250, and 350. The rule with the order number of 150 - * takes precedence over the rule that has an order of 250. Allowed - * priorities are 150 to 3500. If any reserved or duplicate values are - * provided the request fails with HTTP status code 400. + * The priority for this rule. Priorities within a pool must be unique and are evaluated in order + * of priority. The lower the number the higher the priority. For example, rules could be + * specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes + * precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any + * reserved or duplicate values are provided the request fails with HTTP status code 400. */ priority: number; /** - * @member {NetworkSecurityGroupRuleAccess} access The action that should be - * taken for a specified IP address, subnet range or tag. Possible values - * include: 'allow', 'deny' + * The action that should be taken for a specified IP address, subnet range or tag. Possible + * values include: 'allow', 'deny' */ access: NetworkSecurityGroupRuleAccess; /** - * @member {string} sourceAddressPrefix The source address prefix or tag to - * match for the rule. Valid values are a single IP address (i.e. - * 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all - * addresses). If any other values are provided the request fails with HTTP - * status code 400. + * The source address prefix or tag to match for the rule. Valid values are a single IP address + * (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). + * If any other values are provided the request fails with HTTP status code 400. */ sourceAddressPrefix: string; } /** - * @interface * An interface representing InboundNATPool. - * @summary A inbound NAT pool that can be used to address specific ports on - * compute nodes in a Batch pool externally. - * + * @summary A inbound NAT pool that can be used to address specific ports on compute nodes in a + * Batch pool externally. */ export interface InboundNATPool { /** - * @member {string} name The name of the endpoint. The name must be unique - * within a Batch pool, can contain letters, numbers, underscores, periods, - * and hyphens. Names must start with a letter or number, must end with a - * letter, number, or underscore, and cannot exceed 77 characters. If any - * invalid values are provided the request fails with HTTP status code 400. + * The name of the endpoint. The name must be unique within a Batch pool, can contain letters, + * numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end + * with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values + * are provided the request fails with HTTP status code 400. */ name: string; /** - * @member {InboundEndpointProtocol} protocol The protocol of the endpoint. - * Possible values include: 'tcp', 'udp' + * The protocol of the endpoint. Possible values include: 'tcp', 'udp' */ protocol: InboundEndpointProtocol; /** - * @member {number} backendPort The port number on the compute node. This - * must be unique within a Batch pool. Acceptable values are between 1 and - * 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any - * reserved values are provided the request fails with HTTP status code 400. + * The port number on the compute node. This must be unique within a Batch pool. Acceptable + * values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If + * any reserved values are provided the request fails with HTTP status code 400. */ backendPort: number; /** - * @member {number} frontendPortRangeStart The first port number in the range - * of external ports that will be used to provide inbound access to the - * backendPort on individual compute nodes. Acceptable values range between 1 - * and 65534 except ports from 50000 to 55000 which are reserved. All ranges - * within a pool must be distinct and cannot overlap. Each range must contain - * at least 40 ports. If any reserved or overlapping values are provided the - * request fails with HTTP status code 400. + * The first port number in the range of external ports that will be used to provide inbound + * access to the backendPort on individual compute nodes. Acceptable values range between 1 and + * 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be + * distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or + * overlapping values are provided the request fails with HTTP status code 400. */ frontendPortRangeStart: number; /** - * @member {number} frontendPortRangeEnd The last port number in the range of - * external ports that will be used to provide inbound access to the - * backendPort on individual compute nodes. Acceptable values range between 1 - * and 65534 except ports from 50000 to 55000 which are reserved by the Batch - * service. All ranges within a pool must be distinct and cannot overlap. - * Each range must contain at least 40 ports. If any reserved or overlapping - * values are provided the request fails with HTTP status code 400. + * The last port number in the range of external ports that will be used to provide inbound + * access to the backendPort on individual compute nodes. Acceptable values range between 1 and + * 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges + * within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. + * If any reserved or overlapping values are provided the request fails with HTTP status code + * 400. */ frontendPortRangeEnd: number; /** - * @member {NetworkSecurityGroupRule[]} [networkSecurityGroupRules] A list of - * network security group rules that will be applied to the endpoint. The - * maximum number of rules that can be specified across all the endpoints on - * a Batch pool is 25. If no network security group rules are specified, a - * default rule will be created to allow inbound access to the specified - * backendPort. If the maximum number of network security group rules is + * A list of network security group rules that will be applied to the endpoint. The maximum + * number of rules that can be specified across all the endpoints on a Batch pool is 25. If no + * network security group rules are specified, a default rule will be created to allow inbound + * access to the specified backendPort. If the maximum number of network security group rules is * exceeded the request fails with HTTP status code 400. */ networkSecurityGroupRules?: NetworkSecurityGroupRule[]; } /** - * @interface * An interface representing PoolEndpointConfiguration. * @summary The endpoint configuration for a pool. - * */ export interface PoolEndpointConfiguration { /** - * @member {InboundNATPool[]} inboundNATPools A list of inbound NAT pools - * that can be used to address specific ports on an individual compute node - * externally. The maximum number of inbound NAT pools per Batch pool is 5. - * If the maximum number of inbound NAT pools is exceeded the request fails - * with HTTP status code 400. + * A list of inbound NAT pools that can be used to address specific ports on an individual + * compute node externally. The maximum number of inbound NAT pools per Batch pool is 5. If the + * maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. */ inboundNATPools: InboundNATPool[]; } /** - * @interface - * An interface representing NetworkConfiguration. * The network configuration for a pool. - * */ export interface NetworkConfiguration { /** - * @member {string} [subnetId] The ARM resource identifier of the virtual - * network subnet which the compute nodes of the pool will join. This is of - * the form + * The ARM resource identifier of the virtual network subnet which the compute nodes of the pool + * will join. This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the - * Azure Batch account. The specified subnet should have enough free IP - * addresses to accommodate the number of nodes in the pool. If the subnet - * doesn't have enough free IP addresses, the pool will partially allocate - * compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' - * service principal must have the 'Classic Virtual Machine Contributor' - * Role-Based Access Control (RBAC) role for the specified VNet. The - * specified subnet must allow communication from the Azure Batch service to - * be able to schedule tasks on the compute nodes. This can be verified by - * checking if the specified VNet has any associated Network Security Groups - * (NSG). If communication to the compute nodes in the specified subnet is - * denied by an NSG, then the Batch service will set the state of the compute - * nodes to unusable. For pools created with virtualMachineConfiguration only - * ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, - * but for pools created with cloudServiceConfiguration both ARM and classic - * virtual networks are supported. If the specified VNet has any associated - * Network Security Groups (NSG), then a few reserved system ports must be - * enabled for inbound communication. For pools created with a virtual - * machine configuration, enable ports 29876 and 29877, as well as port 22 - * for Linux and port 3389 for Windows. For pools created with a cloud - * service configuration, enable ports 10100, 20100, and 30100. Also enable - * outbound connections to Azure Storage on port 443. For more details see: + * The virtual network must be in the same region and subscription as the Azure Batch account. + * The specified subnet should have enough free IP addresses to accommodate the number of nodes + * in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially + * allocate compute nodes, and a resize error will occur. For pools created with + * virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') + * are supported, but for pools created with cloudServiceConfiguration both ARM and classic + * virtual networks are supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration */ subnetId?: string; /** - * @member {PoolEndpointConfiguration} [endpointConfiguration] The - * configuration for endpoints on compute nodes in the Batch pool. Pool - * endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. + * The scope of dynamic vnet assignment. Possible values include: 'none', 'job' + */ + dynamicVNetAssignmentScope?: DynamicVNetAssignmentScope; + /** + * The configuration for endpoints on compute nodes in the Batch pool. Pool endpoint + * configuration is only supported on pools with the virtualMachineConfiguration property. */ endpointConfiguration?: PoolEndpointConfiguration; } /** - * @interface * An interface representing PoolSpecification. * @summary Specification for creating a new pool. - * */ export interface PoolSpecification { /** - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * The display name for the pool. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} vmSize The size of the virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines in pools, see Choose a VM size for - * compute nodes in an Azure Batch pool + * The size of the virtual machines in the pool. All virtual machines in a pool are the same + * size. For information about available sizes of virtual machines in pools, see Choose a VM size + * for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */ vmSize: string; /** - * @member {CloudServiceConfiguration} [cloudServiceConfiguration] The cloud - * service configuration for the pool. This property must be specified if the - * pool needs to be created with Azure PaaS VMs. This property and - * virtualMachineConfiguration are mutually exclusive and one of the - * properties must be specified. If neither is specified then the Batch - * service returns an error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). This property cannot be specified - * if the Batch account was created with its poolAllocationMode property set - * to 'UserSubscription'. + * The cloud service configuration for the pool. This property must be specified if the pool + * needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are + * mutually exclusive and one of the properties must be specified. If neither is specified then + * the Batch service returns an error; if you are calling the REST API directly, the HTTP status + * code is 400 (Bad Request). This property cannot be specified if the Batch account was created + * with its poolAllocationMode property set to 'UserSubscription'. */ cloudServiceConfiguration?: CloudServiceConfiguration; /** - * @member {VirtualMachineConfiguration} [virtualMachineConfiguration] The - * virtual machine configuration for the pool. This property must be - * specified if the pool needs to be created with Azure IaaS VMs. This - * property and cloudServiceConfiguration are mutually exclusive and one of - * the properties must be specified. If neither is specified then the Batch - * service returns an error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). + * The virtual machine configuration for the pool. This property must be specified if the pool + * needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are + * mutually exclusive and one of the properties must be specified. If neither is specified then + * the Batch service returns an error; if you are calling the REST API directly, the HTTP status + * code is 400 (Bad Request). */ virtualMachineConfiguration?: VirtualMachineConfiguration; /** - * @member {number} [maxTasksPerNode] The maximum number of tasks that can - * run concurrently on a single compute node in the pool. The default value - * is 1. The maximum value of this setting depends on the size of the compute - * nodes in the pool (the vmSize setting). + * The maximum number of tasks that can run concurrently on a single compute node in the pool. + * The default value is 1. The maximum value is the smaller of 4 times the number of cores of the + * vmSize of the pool or 256. */ maxTasksPerNode?: number; /** - * @member {TaskSchedulingPolicy} [taskSchedulingPolicy] How tasks are - * distributed across compute nodes in a pool. + * How tasks are distributed across compute nodes in a pool. If not specified, the default is + * spread. */ taskSchedulingPolicy?: TaskSchedulingPolicy; /** - * @member {string} [resizeTimeout] The timeout for allocation of compute - * nodes to the pool. This timeout applies only to manual scaling; it has no - * effect when enableAutoScale is set to true. The default value is 15 - * minutes. The minimum value is 5 minutes. If you specify a value less than - * 5 minutes, the Batch service rejects the request with an error; if you are - * calling the REST API directly, the HTTP status code is 400 (Bad Request). + * The timeout for allocation of compute nodes to the pool. This timeout applies only to manual + * scaling; it has no effect when enableAutoScale is set to true. The default value is 15 + * minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch + * service rejects the request with an error; if you are calling the REST API directly, the HTTP + * status code is 400 (Bad Request). */ resizeTimeout?: string; /** - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then - * you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. + * The desired number of dedicated compute nodes in the pool. This property must not be specified + * if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set + * either targetDedicatedNodes, targetLowPriorityNodes, or both. */ targetDedicatedNodes?: number; /** - * @member {number} [targetLowPriorityNodes] The desired number of - * low-priority compute nodes in the pool. This property must not be - * specified if enableAutoScale is set to true. If enableAutoScale is set to - * false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. + * The desired number of low-priority compute nodes in the pool. This property must not be + * specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must + * set either targetDedicatedNodes, targetLowPriorityNodes, or both. */ targetLowPriorityNodes?: number; /** - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula element is required. The pool automatically resizes - * according to the formula. The default value is false. + * Whether the pool size should automatically adjust over time. If false, at least one of + * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the + * autoScaleFormula element is required. The pool automatically resizes according to the formula. + * The default value is false. */ enableAutoScale?: boolean; /** - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to false. It is required if enableAutoScale is set - * to true. The formula is checked for validity before the pool is created. - * If the formula is not valid, the Batch service rejects the request with - * detailed error information. + * The formula for the desired number of compute nodes in the pool. This property must not be + * specified if enableAutoScale is set to false. It is required if enableAutoScale is set to + * true. The formula is checked for validity before the pool is created. If the formula is not + * valid, the Batch service rejects the request with detailed error information. */ autoScaleFormula?: string; /** - * @member {string} [autoScaleEvaluationInterval] The time interval at which - * to automatically adjust the pool size according to the autoscale formula. - * The default value is 15 minutes. The minimum and maximum value are 5 - * minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). + * The time interval at which to automatically adjust the pool size according to the autoscale + * formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 + * hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the + * Batch service rejects the request with an invalid property value error; if you are calling the + * REST API directly, the HTTP status code is 400 (Bad Request). */ autoScaleEvaluationInterval?: string; /** - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication - * limits the maximum size of the pool due to deployment restrictions on the - * nodes of the pool. This may result in the pool not reaching its desired - * size. The default value is false. + * Whether the pool permits direct communication between nodes. Enabling inter-node communication + * limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. + * This may result in the pool not reaching its desired size. The default value is false. */ enableInterNodeCommunication?: boolean; /** - * @member {NetworkConfiguration} [networkConfiguration] The network - * configuration for the pool. + * The network configuration for the pool. */ networkConfiguration?: NetworkConfiguration; /** - * @member {StartTask} [startTask] A task to run on each compute node as it - * joins the pool. The task runs when the node is added to the pool or when - * the node is restarted. + * A task to run on each compute node as it joins the pool. The task runs when the node is added + * to the pool or when the node is restarted. */ startTask?: StartTask; /** - * @member {CertificateReference[]} [certificateReferences] A list of - * certificates to be installed on each compute node in the pool. For Windows - * compute nodes, the Batch service installs the certificates to the - * specified certificate store and location. For Linux compute nodes, the - * certificates are stored in a directory inside the task working directory - * and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the - * task to query for this location. For certificates with visibility of - * 'remoteUser', a 'certs' directory is created in the user's home directory - * (e.g., /home/{user-name}/certs) and certificates are placed in that - * directory. + * A list of certificates to be installed on each compute node in the pool. For Windows compute + * nodes, the Batch service installs the certificates to the specified certificate store and + * location. For Linux compute nodes, the certificates are stored in a directory inside the task + * working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the + * task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' + * directory is created in the user's home directory (e.g., /home/{user-name}/certs) and + * certificates are placed in that directory. */ certificateReferences?: CertificateReference[]; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] The - * list of application packages to be installed on each compute node in the - * pool. + * The list of application packages to be installed on each compute node in the pool. Changes to + * application package references affect all new compute nodes joining the pool, but do not + * affect compute nodes that are already in the pool until they are rebooted or reimaged. There + * is a maximum of 10 application package references on any given pool. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {string[]} [applicationLicenses] The list of application licenses - * the Batch service will make available on each compute node in the pool. - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. + * The list of application licenses the Batch service will make available on each compute node in + * the pool. The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An + * additional charge applies for each application license added to the pool. */ applicationLicenses?: string[]; /** - * @member {UserAccount[]} [userAccounts] The list of user accounts to be - * created on each node in the pool. + * The list of user accounts to be created on each node in the pool. */ userAccounts?: UserAccount[]; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the pool as metadata. The Batch service does not assign any meaning - * to metadata; it is solely for the use of user code. + * A list of name-value pairs associated with the pool as metadata. The Batch service does not + * assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing AutoPoolSpecification. - * @summary Specifies characteristics for a temporary 'auto pool'. The Batch - * service will create this auto pool when the job is submitted. - * + * @summary Specifies characteristics for a temporary 'auto pool'. The Batch service will create + * this auto pool when the job is submitted. */ export interface AutoPoolSpecification { /** - * @member {string} [autoPoolIdPrefix] A prefix to be added to the unique - * identifier when a pool is automatically created. The Batch service assigns - * each auto pool a unique identifier on creation. To distinguish between - * pools created for different purposes, you can specify this element to add - * a prefix to the ID that is assigned. The prefix can be up to 20 characters - * long. + * A prefix to be added to the unique identifier when a pool is automatically created. The Batch + * service assigns each auto pool a unique identifier on creation. To distinguish between pools + * created for different purposes, you can specify this element to add a prefix to the ID that is + * assigned. The prefix can be up to 20 characters long. */ autoPoolIdPrefix?: string; /** - * @member {PoolLifetimeOption} poolLifetimeOption The minimum lifetime of - * created auto pools, and how multiple jobs on a schedule are assigned to - * pools. Possible values include: 'jobSchedule', 'job' + * The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned + * to pools. Possible values include: 'jobSchedule', 'job' */ poolLifetimeOption: PoolLifetimeOption; /** - * @member {boolean} [keepAlive] Whether to keep an auto pool alive after its - * lifetime expires. If false, the Batch service deletes the pool once its - * lifetime (as determined by the poolLifetimeOption setting) expires; that - * is, when the job or job schedule completes. If true, the Batch service - * does not delete the pool automatically. It is up to the user to delete - * auto pools created with this option. + * Whether to keep an auto pool alive after its lifetime expires. If false, the Batch service + * deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; + * that is, when the job or job schedule completes. If true, the Batch service does not delete + * the pool automatically. It is up to the user to delete auto pools created with this option. */ keepAlive?: boolean; /** - * @member {PoolSpecification} [pool] The pool specification for the auto - * pool. + * The pool specification for the auto pool. */ pool?: PoolSpecification; } /** - * @interface * An interface representing PoolInformation. * @summary Specifies how a job should be assigned to a pool. - * */ export interface PoolInformation { /** - * @member {string} [poolId] The ID of an existing pool. All the tasks of the - * job will run on the specified pool. You must ensure that the pool - * referenced by this property exists. If the pool does not exist at the time - * the Batch service tries to schedule a job, no tasks for the job will run - * until you create a pool with that id. Note that the Batch service will not - * reject the job request; it will simply not run tasks until the pool - * exists. You must specify either the pool ID or the auto pool - * specification, but not both. + * The ID of an existing pool. All the tasks of the job will run on the specified pool. You must + * ensure that the pool referenced by this property exists. If the pool does not exist at the + * time the Batch service tries to schedule a job, no tasks for the job will run until you create + * a pool with that id. Note that the Batch service will not reject the job request; it will + * simply not run tasks until the pool exists. You must specify either the pool ID or the auto + * pool specification, but not both. */ poolId?: string; /** - * @member {AutoPoolSpecification} [autoPoolSpecification] Characteristics - * for a temporary 'auto pool'. The Batch service will create this auto pool - * when the job is submitted. If auto pool creation fails, the Batch service - * moves the job to a completed state, and the pool creation error is set in - * the job's scheduling error property. The Batch service manages the - * lifetime (both creation and, unless keepAlive is specified, deletion) of - * the auto pool. Any user actions that affect the lifetime of the auto pool - * while the job is active will result in unexpected behavior. You must - * specify either the pool ID or the auto pool specification, but not both. + * Characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when + * the job is submitted. If auto pool creation fails, the Batch service moves the job to a + * completed state, and the pool creation error is set in the job's scheduling error property. + * The Batch service manages the lifetime (both creation and, unless keepAlive is specified, + * deletion) of the auto pool. Any user actions that affect the lifetime of the auto pool while + * the job is active will result in unexpected behavior. You must specify either the pool ID or + * the auto pool specification, but not both. */ autoPoolSpecification?: AutoPoolSpecification; } /** - * @interface * An interface representing JobSpecification. * @summary Specifies details of the jobs to be created on a schedule. - * */ export interface JobSpecification { /** - * @member {number} [priority] The priority of jobs created under this - * schedule. Priority values can range from -1000 to 1000, with -1000 being - * the lowest priority and 1000 being the highest priority. The default value - * is 0. This priority is used as the default for all jobs under the job - * schedule. You can update a job's priority after it has been created using - * by using the update job API. + * The priority of jobs created under this schedule. Priority values can range from -1000 to + * 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default + * value is 0. This priority is used as the default for all jobs under the job schedule. You can + * update a job's priority after it has been created using by using the update job API. */ priority?: number; /** - * @member {string} [displayName] The display name for jobs created under - * this schedule. The name need not be unique and can contain any Unicode - * characters up to a maximum length of 1024. + * The display name for jobs created under this schedule. The name need not be unique and can + * contain any Unicode characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can - * define dependencies on each other. The default is false. + * Whether tasks in the job can define dependencies on each other. The default is false. */ usesTaskDependencies?: boolean; /** - * @member {OnAllTasksComplete} [onAllTasksComplete] The action the Batch - * service should take when all tasks in a job created under this schedule - * are in the completed state. Note that if a job contains no tasks, then all - * tasks are considered complete. This option is therefore most commonly used - * with a Job Manager task; if you want to use automatic job termination - * without a Job Manager, you should initially set onAllTasksComplete to - * noaction and update the job properties to set onAllTasksComplete to - * terminatejob once you have finished adding tasks. The default is noaction. - * Possible values include: 'noAction', 'terminateJob' + * The action the Batch service should take when all tasks in a job created under this schedule + * are in the completed state. Note that if a job contains no tasks, then all tasks are + * considered complete. This option is therefore most commonly used with a Job Manager task; if + * you want to use automatic job termination without a Job Manager, you should initially set + * onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to + * terminatejob once you have finished adding tasks. The default is noaction. Possible values + * include: 'noAction', 'terminateJob' */ onAllTasksComplete?: OnAllTasksComplete; /** - * @member {OnTaskFailure} [onTaskFailure] The action the Batch service - * should take when any task fails in a job created under this schedule. A - * task is considered to have failed if it have failed if has a failureInfo. - * A failureInfo is set if the task completes with a non-zero exit code after - * exhausting its retry count, or if there was an error starting the task, - * for example due to a resource file download error. The default is - * noaction. Possible values include: 'noAction', + * The action the Batch service should take when any task fails in a job created under this + * schedule. A task is considered to have failed if it have failed if has a failureInfo. A + * failureInfo is set if the task completes with a non-zero exit code after exhausting its retry + * count, or if there was an error starting the task, for example due to a resource file download + * error. The default is noaction. Possible values include: 'noAction', * 'performExitOptionsJobAction' */ onTaskFailure?: OnTaskFailure; /** - * @member {JobConstraints} [constraints] The execution constraints for jobs - * created under this schedule. + * The network configuration for the job. + */ + networkConfiguration?: JobNetworkConfiguration; + /** + * The execution constraints for jobs created under this schedule. */ constraints?: JobConstraints; /** - * @member {JobManagerTask} [jobManagerTask] The details of a Job Manager - * task to be launched when a job is started under this schedule. If the job - * does not specify a Job Manager task, the user must explicitly add tasks to - * the job using the Task API. If the job does specify a Job Manager task, - * the Batch service creates the Job Manager task when the job is created, - * and will try to schedule the Job Manager task before scheduling other - * tasks in the job. + * The details of a Job Manager task to be launched when a job is started under this schedule. If + * the job does not specify a Job Manager task, the user must explicitly add tasks to the job + * using the Task API. If the job does specify a Job Manager task, the Batch service creates the + * Job Manager task when the job is created, and will try to schedule the Job Manager task before + * scheduling other tasks in the job. */ jobManagerTask?: JobManagerTask; /** - * @member {JobPreparationTask} [jobPreparationTask] The Job Preparation task - * for jobs created under this schedule. If a job has a Job Preparation task, - * the Batch service will run the Job Preparation task on a compute node - * before starting any tasks of that job on that compute node. + * The Job Preparation task for jobs created under this schedule. If a job has a Job Preparation + * task, the Batch service will run the Job Preparation task on a compute node before starting + * any tasks of that job on that compute node. */ jobPreparationTask?: JobPreparationTask; /** - * @member {JobReleaseTask} [jobReleaseTask] The Job Release task for jobs - * created under this schedule. The primary purpose of the Job Release task - * is to undo changes to compute nodes made by the Job Preparation task. - * Example activities include deleting local files, or shutting down services - * that were started as part of job preparation. A Job Release task cannot be - * specified without also specifying a Job Preparation task for the job. The - * Batch service runs the Job Release task on the compute nodes that have run - * the Job Preparation task. + * The Job Release task for jobs created under this schedule. The primary purpose of the Job + * Release task is to undo changes to compute nodes made by the Job Preparation task. Example + * activities include deleting local files, or shutting down services that were started as part + * of job preparation. A Job Release task cannot be specified without also specifying a Job + * Preparation task for the job. The Batch service runs the Job Release task on the compute nodes + * that have run the Job Preparation task. */ jobReleaseTask?: JobReleaseTask; /** - * @member {EnvironmentSetting[]} [commonEnvironmentSettings] A list of - * common environment variable settings. These environment variables are set - * for all tasks in jobs created under this schedule (including the Job - * Manager, Job Preparation and Job Release tasks). Individual tasks can - * override an environment setting specified here by specifying the same - * setting name with a different value. + * A list of common environment variable settings. These environment variables are set for all + * tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job + * Release tasks). Individual tasks can override an environment setting specified here by + * specifying the same setting name with a different value. */ commonEnvironmentSettings?: EnvironmentSetting[]; /** - * @member {PoolInformation} poolInfo The pool on which the Batch service - * runs the tasks of jobs created under this schedule. + * The pool on which the Batch service runs the tasks of jobs created under this schedule. */ poolInfo: PoolInformation; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with each job created under this schedule as metadata. The Batch service - * does not assign any meaning to metadata; it is solely for the use of user + * A list of name-value pairs associated with each job created under this schedule as metadata. + * The Batch service does not assign any meaning to metadata; it is solely for the use of user * code. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing RecentJob. - * @summary Information about the most recent job to run under the job - * schedule. - * + * @summary Information about the most recent job to run under the job schedule. */ export interface RecentJob { /** - * @member {string} [id] The ID of the job. + * The ID of the job. */ id?: string; /** - * @member {string} [url] The URL of the job. + * The URL of the job. */ url?: string; } /** - * @interface * An interface representing JobScheduleExecutionInformation. - * @summary Contains information about jobs that have been and will be run - * under a job schedule. - * + * @summary Contains information about jobs that have been and will be run under a job schedule. */ export interface JobScheduleExecutionInformation { /** - * @member {Date} [nextRunTime] The next time at which a job will be created - * under this schedule. This property is meaningful only if the schedule is - * in the active state when the time comes around. For example, if the - * schedule is disabled, no job will be created at nextRunTime unless the job - * is enabled before then. + * The next time at which a job will be created under this schedule. This property is meaningful + * only if the schedule is in the active state when the time comes around. For example, if the + * schedule is disabled, no job will be created at nextRunTime unless the job is enabled before + * then. */ nextRunTime?: Date; /** - * @member {RecentJob} [recentJob] Information about the most recent job - * under the job schedule. This property is present only if the at least one - * job has run under the schedule. + * Information about the most recent job under the job schedule. This property is present only if + * the at least one job has run under the schedule. */ recentJob?: RecentJob; /** - * @member {Date} [endTime] The time at which the schedule ended. This - * property is set only if the job schedule is in the completed state. + * The time at which the schedule ended. This property is set only if the job schedule is in the + * completed state. */ endTime?: Date; } /** - * @interface * An interface representing JobScheduleStatistics. * @summary Resource usage statistics for a job schedule. - * */ export interface JobScheduleStatistics { /** - * @member {string} url The URL of the statistics. + * The URL of the statistics. */ url: string; /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {string} userCPUTime The total user mode CPU time (summed across - * all cores and all compute nodes) consumed by all tasks in all jobs created - * under the schedule. + * The total user mode CPU time (summed across all cores and all compute nodes) consumed by all + * tasks in all jobs created under the schedule. */ userCPUTime: string; /** - * @member {string} kernelCPUTime The total kernel mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in all jobs - * created under the schedule. + * The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all + * tasks in all jobs created under the schedule. */ kernelCPUTime: string; /** - * @member {string} wallClockTime The total wall clock time of all the tasks - * in all the jobs created under the schedule. The wall clock time is the - * elapsed time from when the task started running on a compute node to when - * it finished (or to the last time the statistics were updated, if the task - * had not finished by then). If a task was retried, this includes the wall - * clock time of all the task retries. + * The total wall clock time of all the tasks in all the jobs created under the schedule. The + * wall clock time is the elapsed time from when the task started running on a compute node to + * when it finished (or to the last time the statistics were updated, if the task had not + * finished by then). If a task was retried, this includes the wall clock time of all the task + * retries. */ wallClockTime: string; /** - * @member {number} readIOps The total number of disk read operations made by - * all tasks in all jobs created under the schedule. + * The total number of disk read operations made by all tasks in all jobs created under the + * schedule. */ readIOps: number; /** - * @member {number} writeIOps The total number of disk write operations made - * by all tasks in all jobs created under the schedule. + * The total number of disk write operations made by all tasks in all jobs created under the + * schedule. */ writeIOps: number; /** - * @member {number} readIOGiB The total gibibytes read from disk by all tasks - * in all jobs created under the schedule. + * The total gibibytes read from disk by all tasks in all jobs created under the schedule. */ readIOGiB: number; /** - * @member {number} writeIOGiB The total gibibytes written to disk by all - * tasks in all jobs created under the schedule. + * The total gibibytes written to disk by all tasks in all jobs created under the schedule. */ writeIOGiB: number; /** - * @member {number} numSucceededTasks The total number of tasks successfully - * completed during the given time range in jobs created under the schedule. - * A task completes successfully if it returns exit code 0. + * The total number of tasks successfully completed during the given time range in jobs created + * under the schedule. A task completes successfully if it returns exit code 0. */ numSucceededTasks: number; /** - * @member {number} numFailedTasks The total number of tasks that failed - * during the given time range in jobs created under the schedule. A task - * fails if it exhausts its maximum retry count without returning exit code - * 0. + * The total number of tasks that failed during the given time range in jobs created under the + * schedule. A task fails if it exhausts its maximum retry count without returning exit code 0. */ numFailedTasks: number; /** - * @member {number} numTaskRetries The total number of retries during the - * given time range on all tasks in all jobs created under the schedule. + * The total number of retries during the given time range on all tasks in all jobs created under + * the schedule. */ numTaskRetries: number; /** - * @member {string} waitTime The total wait time of all tasks in all jobs - * created under the schedule. The wait time for a task is defined as the - * elapsed time between the creation of the task and the start of task - * execution. (If the task is retried due to failures, the wait time is the - * time to the most recent task execution.). This value is only reported in - * the account lifetime statistics; it is not included in the job statistics. + * The total wait time of all tasks in all jobs created under the schedule. The wait time for a + * task is defined as the elapsed time between the creation of the task and the start of task + * execution. (If the task is retried due to failures, the wait time is the time to the most + * recent task execution.). This value is only reported in the account lifetime statistics; it is + * not included in the job statistics. */ waitTime: string; } /** - * @interface * An interface representing CloudJobSchedule. - * @summary A job schedule that allows recurring jobs by specifying when to run - * jobs and a specification used to create each job. - * + * @summary A job schedule that allows recurring jobs by specifying when to run jobs and a + * specification used to create each job. */ export interface CloudJobSchedule { /** - * @member {string} [id] A string that uniquely identifies the schedule - * within the account. + * A string that uniquely identifies the schedule within the account. */ id?: string; /** - * @member {string} [displayName] The display name for the schedule. + * The display name for the schedule. */ displayName?: string; /** - * @member {string} [url] The URL of the job schedule. + * The URL of the job schedule. */ url?: string; /** - * @member {string} [eTag] The ETag of the job schedule. This is an opaque - * string. You can use it to detect whether the job schedule has changed - * between requests. In particular, you can be pass the ETag with an Update - * Job Schedule request to specify that your changes should take effect only - * if nobody else has modified the schedule in the meantime. + * The ETag of the job schedule. This is an opaque string. You can use it to detect whether the + * job schedule has changed between requests. In particular, you can be pass the ETag with an + * Update Job Schedule request to specify that your changes should take effect only if nobody + * else has modified the schedule in the meantime. */ eTag?: string; /** - * @member {Date} [lastModified] The last modified time of the job schedule. - * This is the last time at which the schedule level data, such as the job - * specification or recurrence information, changed. It does not factor in + * The last modified time of the job schedule. This is the last time at which the schedule level + * data, such as the job specification or recurrence information, changed. It does not factor in * job-level changes such as new jobs being created or jobs changing state. */ lastModified?: Date; /** - * @member {Date} [creationTime] The creation time of the job schedule. + * The creation time of the job schedule. */ creationTime?: Date; /** - * @member {JobScheduleState} [state] The current state of the job schedule. - * Possible values include: 'active', 'completed', 'disabled', 'terminating', - * 'deleting' + * The current state of the job schedule. Possible values include: 'active', 'completed', + * 'disabled', 'terminating', 'deleting' */ state?: JobScheduleState; /** - * @member {Date} [stateTransitionTime] The time at which the job schedule - * entered the current state. + * The time at which the job schedule entered the current state. */ stateTransitionTime?: Date; /** - * @member {JobScheduleState} [previousState] The previous state of the job - * schedule. This property is not present if the job schedule is in its - * initial active state. Possible values include: 'active', 'completed', - * 'disabled', 'terminating', 'deleting' + * The previous state of the job schedule. This property is not present if the job schedule is in + * its initial active state. Possible values include: 'active', 'completed', 'disabled', + * 'terminating', 'deleting' */ previousState?: JobScheduleState; /** - * @member {Date} [previousStateTransitionTime] The time at which the job - * schedule entered its previous state. This property is not present if the - * job schedule is in its initial active state. + * The time at which the job schedule entered its previous state. This property is not present if + * the job schedule is in its initial active state. */ previousStateTransitionTime?: Date; /** - * @member {Schedule} [schedule] The schedule according to which jobs will be - * created. + * The schedule according to which jobs will be created. */ schedule?: Schedule; /** - * @member {JobSpecification} [jobSpecification] The details of the jobs to - * be created on this schedule. + * The details of the jobs to be created on this schedule. */ jobSpecification?: JobSpecification; /** - * @member {JobScheduleExecutionInformation} [executionInfo] Information - * about jobs that have been and will be run under this schedule. + * Information about jobs that have been and will be run under this schedule. */ executionInfo?: JobScheduleExecutionInformation; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the schedule as metadata. The Batch service does not assign any - * meaning to metadata; it is solely for the use of user code. + * A list of name-value pairs associated with the schedule as metadata. The Batch service does + * not assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; /** - * @member {JobScheduleStatistics} [stats] The lifetime resource usage - * statistics for the job schedule. The statistics may not be immediately - * available. The Batch service performs periodic roll-up of statistics. The - * typical delay is about 30 minutes. + * The lifetime resource usage statistics for the job schedule. The statistics may not be + * immediately available. The Batch service performs periodic roll-up of statistics. The typical + * delay is about 30 minutes. */ stats?: JobScheduleStatistics; } /** - * @interface * An interface representing JobScheduleAddParameter. - * @summary A job schedule that allows recurring jobs by specifying when to run - * jobs and a specification used to create each job. - * + * @summary A job schedule that allows recurring jobs by specifying when to run jobs and a + * specification used to create each job. */ export interface JobScheduleAddParameter { /** - * @member {string} id A string that uniquely identifies the schedule within - * the account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two IDs within an account that differ only by case). + * A string that uniquely identifies the schedule within the account. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores, and cannot contain + * more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not + * have two IDs within an account that differ only by case). */ id: string; /** - * @member {string} [displayName] The display name for the schedule. The - * display name need not be unique and can contain any Unicode characters up - * to a maximum length of 1024. + * The display name for the schedule. The display name need not be unique and can contain any + * Unicode characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {Schedule} schedule The schedule according to which jobs will be - * created. + * The schedule according to which jobs will be created. */ schedule: Schedule; /** - * @member {JobSpecification} jobSpecification The details of the jobs to be - * created on this schedule. + * The details of the jobs to be created on this schedule. */ jobSpecification: JobSpecification; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the schedule as metadata. The Batch service does not assign any - * meaning to metadata; it is solely for the use of user code. + * A list of name-value pairs associated with the schedule as metadata. The Batch service does + * not assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing JobSchedulingError. * @summary An error encountered by the Batch service when scheduling a job. - * */ export interface JobSchedulingError { /** - * @member {ErrorCategory} category The category of the job scheduling error. - * Possible values include: 'userError', 'serverError' + * The category of the job scheduling error. Possible values include: 'userError', 'serverError' */ category: ErrorCategory; /** - * @member {string} [code] An identifier for the job scheduling error. Codes - * are invariant and are intended to be consumed programmatically. + * An identifier for the job scheduling error. Codes are invariant and are intended to be + * consumed programmatically. */ code?: string; /** - * @member {string} [message] A message describing the job scheduling error, - * intended to be suitable for display in a user interface. + * A message describing the job scheduling error, intended to be suitable for display in a user + * interface. */ message?: string; /** - * @member {NameValuePair[]} [details] A list of additional error details - * related to the scheduling error. + * A list of additional error details related to the scheduling error. */ details?: NameValuePair[]; } /** - * @interface * An interface representing JobExecutionInformation. - * @summary Contains information about the execution of a job in the Azure - * Batch service. - * + * @summary Contains information about the execution of a job in the Azure Batch service. */ export interface JobExecutionInformation { /** - * @member {Date} startTime The start time of the job. This is the time at - * which the job was created. + * The start time of the job. This is the time at which the job was created. */ startTime: Date; /** - * @member {Date} [endTime] The completion time of the job. This property is - * set only if the job is in the completed state. + * The completion time of the job. This property is set only if the job is in the completed + * state. */ endTime?: Date; /** - * @member {string} [poolId] The ID of the pool to which this job is - * assigned. This element contains the actual pool where the job is assigned. - * When you get job details from the service, they also contain a poolInfo - * element, which contains the pool configuration data from when the job was - * added or updated. That poolInfo element may also contain a poolId element. - * If it does, the two IDs are the same. If it does not, it means the job ran - * on an auto pool, and this property contains the ID of that auto pool. + * The ID of the pool to which this job is assigned. This element contains the actual pool where + * the job is assigned. When you get job details from the service, they also contain a poolInfo + * element, which contains the pool configuration data from when the job was added or updated. + * That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. + * If it does not, it means the job ran on an auto pool, and this property contains the ID of + * that auto pool. */ poolId?: string; /** - * @member {JobSchedulingError} [schedulingError] Details of any error - * encountered by the service in starting the job. This property is not set + * Details of any error encountered by the service in starting the job. This property is not set * if there was no error starting the job. */ schedulingError?: JobSchedulingError; /** - * @member {string} [terminateReason] A string describing the reason the job - * ended. This property is set only if the job is in the completed state. If - * the Batch service terminates the job, it sets the reason as follows: - * JMComplete - the Job Manager task completed, and killJobOnCompletion was - * set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime - * constraint. TerminateJobSchedule - the job ran as part of a schedule, and - * the schedule terminated. AllTasksComplete - the job's onAllTasksComplete - * attribute is set to terminatejob, and all tasks in the job are complete. - * TaskFailed - the job's onTaskFailure attribute is set to - * performExitOptionsJobAction, and a task in the job failed with an exit - * condition that specified a jobAction of terminatejob. Any other string is - * a user-defined reason specified in a call to the 'Terminate a job' - * operation. + * A string describing the reason the job ended. This property is set only if the job is in the + * completed state. If the Batch service terminates the job, it sets the reason as follows: + * JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. + * MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule + * - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's + * onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. + * TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a + * task in the job failed with an exit condition that specified a jobAction of terminatejob. Any + * other string is a user-defined reason specified in a call to the 'Terminate a job' operation. */ terminateReason?: string; } /** - * @interface * An interface representing CloudJob. * @summary An Azure Batch job. - * */ export interface CloudJob { /** - * @member {string} [id] A string that uniquely identifies the job within the - * account. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). + * A string that uniquely identifies the job within the account. The ID is case-preserving and + * case-insensitive (that is, you may not have two IDs within an account that differ only by + * case). */ id?: string; /** - * @member {string} [displayName] The display name for the job. + * The display name for the job. */ displayName?: string; /** - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can - * define dependencies on each other. The default is false. + * Whether tasks in the job can define dependencies on each other. The default is false. */ usesTaskDependencies?: boolean; /** - * @member {string} [url] The URL of the job. + * The URL of the job. */ url?: string; /** - * @member {string} [eTag] The ETag of the job. This is an opaque string. You - * can use it to detect whether the job has changed between requests. In - * particular, you can be pass the ETag when updating a job to specify that - * your changes should take effect only if nobody else has modified the job - * in the meantime. + * The ETag of the job. This is an opaque string. You can use it to detect whether the job has + * changed between requests. In particular, you can be pass the ETag when updating a job to + * specify that your changes should take effect only if nobody else has modified the job in the + * meantime. */ eTag?: string; /** - * @member {Date} [lastModified] The last modified time of the job. This is - * the last time at which the job level data, such as the job state or - * priority, changed. It does not factor in task-level changes such as adding + * The last modified time of the job. This is the last time at which the job level data, such as + * the job state or priority, changed. It does not factor in task-level changes such as adding * new tasks or tasks changing state. */ lastModified?: Date; /** - * @member {Date} [creationTime] The creation time of the job. + * The creation time of the job. */ creationTime?: Date; /** - * @member {JobState} [state] The current state of the job. Possible values - * include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', - * 'completed', 'deleting' + * The current state of the job. Possible values include: 'active', 'disabling', 'disabled', + * 'enabling', 'terminating', 'completed', 'deleting' */ state?: JobState; /** - * @member {Date} [stateTransitionTime] The time at which the job entered its - * current state. + * The time at which the job entered its current state. */ stateTransitionTime?: Date; /** - * @member {JobState} [previousState] The previous state of the job. This - * property is not set if the job is in its initial Active state. Possible - * values include: 'active', 'disabling', 'disabled', 'enabling', - * 'terminating', 'completed', 'deleting' + * The previous state of the job. This property is not set if the job is in its initial Active + * state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', + * 'completed', 'deleting' */ previousState?: JobState; /** - * @member {Date} [previousStateTransitionTime] The time at which the job - * entered its previous state. This property is not set if the job is in its - * initial Active state. + * The time at which the job entered its previous state. This property is not set if the job is + * in its initial Active state. */ previousStateTransitionTime?: Date; /** - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. The default value is 0. + * The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the + * lowest priority and 1000 being the highest priority. The default value is 0. */ priority?: number; /** - * @member {JobConstraints} [constraints] The execution constraints for the - * job. + * The execution constraints for the job. */ constraints?: JobConstraints; /** - * @member {JobManagerTask} [jobManagerTask] Details of a Job Manager task to - * be launched when the job is started. + * Details of a Job Manager task to be launched when the job is started. */ jobManagerTask?: JobManagerTask; /** - * @member {JobPreparationTask} [jobPreparationTask] The Job Preparation - * task. The Job Preparation task is a special task run on each node before + * The Job Preparation task. The Job Preparation task is a special task run on each node before * any other task of the job. */ jobPreparationTask?: JobPreparationTask; /** - * @member {JobReleaseTask} [jobReleaseTask] The Job Release task. The Job - * Release task is a special task run at the end of the job on each node that - * has run any other task of the job. + * The Job Release task. The Job Release task is a special task run at the end of the job on each + * node that has run any other task of the job. */ jobReleaseTask?: JobReleaseTask; /** - * @member {EnvironmentSetting[]} [commonEnvironmentSettings] The list of - * common environment variable settings. These environment variables are set - * for all tasks in the job (including the Job Manager, Job Preparation and - * Job Release tasks). Individual tasks can override an environment setting - * specified here by specifying the same setting name with a different value. + * The list of common environment variable settings. These environment variables are set for all + * tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). + * Individual tasks can override an environment setting specified here by specifying the same + * setting name with a different value. */ commonEnvironmentSettings?: EnvironmentSetting[]; /** - * @member {PoolInformation} [poolInfo] The pool settings associated with the - * job. + * The pool settings associated with the job. */ poolInfo?: PoolInformation; /** - * @member {OnAllTasksComplete} [onAllTasksComplete] The action the Batch - * service should take when all tasks in the job are in the completed state. - * The default is noaction. Possible values include: 'noAction', - * 'terminateJob' + * The action the Batch service should take when all tasks in the job are in the completed state. + * The default is noaction. Possible values include: 'noAction', 'terminateJob' */ onAllTasksComplete?: OnAllTasksComplete; /** - * @member {OnTaskFailure} [onTaskFailure] The action the Batch service - * should take when any task in the job fails. A task is considered to have - * failed if has a failureInfo. A failureInfo is set if the task completes - * with a non-zero exit code after exhausting its retry count, or if there - * was an error starting the task, for example due to a resource file - * download error. The default is noaction. Possible values include: - * 'noAction', 'performExitOptionsJobAction' + * The action the Batch service should take when any task in the job fails. A task is considered + * to have failed if has a failureInfo. A failureInfo is set if the task completes with a + * non-zero exit code after exhausting its retry count, or if there was an error starting the + * task, for example due to a resource file download error. The default is noaction. Possible + * values include: 'noAction', 'performExitOptionsJobAction' */ onTaskFailure?: OnTaskFailure; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job as metadata. The Batch service does not assign any meaning to - * metadata; it is solely for the use of user code. + * The network configuration for the job. + */ + networkConfiguration?: JobNetworkConfiguration; + /** + * A list of name-value pairs associated with the job as metadata. The Batch service does not + * assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; /** - * @member {JobExecutionInformation} [executionInfo] The execution - * information for the job. + * The execution information for the job. */ executionInfo?: JobExecutionInformation; /** - * @member {JobStatistics} [stats] Resource usage statistics for the entire - * lifetime of the job. The statistics may not be immediately available. The - * Batch service performs periodic roll-up of statistics. The typical delay - * is about 30 minutes. + * Resource usage statistics for the entire lifetime of the job. This property is populated only + * if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise + * it is null. The statistics may not be immediately available. The Batch service performs + * periodic roll-up of statistics. The typical delay is about 30 minutes. */ stats?: JobStatistics; } /** - * @interface * An interface representing JobAddParameter. * @summary An Azure Batch job to add. - * */ export interface JobAddParameter { /** - * @member {string} id A string that uniquely identifies the job within the - * account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two IDs within an account that differ only by case). + * A string that uniquely identifies the job within the account. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores, and cannot contain + * more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not + * have two IDs within an account that differ only by case). */ id: string; /** - * @member {string} [displayName] The display name for the job. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * The display name for the job. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. The default value is 0. + * The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the + * lowest priority and 1000 being the highest priority. The default value is 0. */ priority?: number; /** - * @member {JobConstraints} [constraints] The execution constraints for the - * job. + * The execution constraints for the job. */ constraints?: JobConstraints; /** - * @member {JobManagerTask} [jobManagerTask] Details of a Job Manager task to - * be launched when the job is started. If the job does not specify a Job - * Manager task, the user must explicitly add tasks to the job. If the job - * does specify a Job Manager task, the Batch service creates the Job Manager - * task when the job is created, and will try to schedule the Job Manager - * task before scheduling other tasks in the job. The Job Manager task's - * typical purpose is to control and/or monitor job execution, for example by - * deciding what additional tasks to run, determining when the work is - * complete, etc. (However, a Job Manager task is not restricted to these - * activities - it is a fully-fledged task in the system and perform whatever - * actions are required for the job.) For example, a Job Manager task might - * download a file specified as a parameter, analyze the contents of that - * file and submit additional tasks based on those contents. + * Details of a Job Manager task to be launched when the job is started. If the job does not + * specify a Job Manager task, the user must explicitly add tasks to the job. If the job does + * specify a Job Manager task, the Batch service creates the Job Manager task when the job is + * created, and will try to schedule the Job Manager task before scheduling other tasks in the + * job. The Job Manager task's typical purpose is to control and/or monitor job execution, for + * example by deciding what additional tasks to run, determining when the work is complete, etc. + * (However, a Job Manager task is not restricted to these activities - it is a fully-fledged + * task in the system and perform whatever actions are required for the job.) For example, a Job + * Manager task might download a file specified as a parameter, analyze the contents of that file + * and submit additional tasks based on those contents. */ jobManagerTask?: JobManagerTask; /** - * @member {JobPreparationTask} [jobPreparationTask] The Job Preparation - * task. If a job has a Job Preparation task, the Batch service will run the - * Job Preparation task on a compute node before starting any tasks of that - * job on that compute node. + * The Job Preparation task. If a job has a Job Preparation task, the Batch service will run the + * Job Preparation task on a compute node before starting any tasks of that job on that compute + * node. */ jobPreparationTask?: JobPreparationTask; /** - * @member {JobReleaseTask} [jobReleaseTask] The Job Release task. A Job - * Release task cannot be specified without also specifying a Job Preparation - * task for the job. The Batch service runs the Job Release task on the - * compute nodes that have run the Job Preparation task. The primary purpose - * of the Job Release task is to undo changes to compute nodes made by the - * Job Preparation task. Example activities include deleting local files, or - * shutting down services that were started as part of job preparation. + * The Job Release task. A Job Release task cannot be specified without also specifying a Job + * Preparation task for the job. The Batch service runs the Job Release task on the compute nodes + * that have run the Job Preparation task. The primary purpose of the Job Release task is to undo + * changes to compute nodes made by the Job Preparation task. Example activities include deleting + * local files, or shutting down services that were started as part of job preparation. */ jobReleaseTask?: JobReleaseTask; /** - * @member {EnvironmentSetting[]} [commonEnvironmentSettings] The list of - * common environment variable settings. These environment variables are set - * for all tasks in the job (including the Job Manager, Job Preparation and - * Job Release tasks). Individual tasks can override an environment setting - * specified here by specifying the same setting name with a different value. + * The list of common environment variable settings. These environment variables are set for all + * tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). + * Individual tasks can override an environment setting specified here by specifying the same + * setting name with a different value. */ commonEnvironmentSettings?: EnvironmentSetting[]; /** - * @member {PoolInformation} poolInfo The pool on which the Batch service - * runs the job's tasks. + * The pool on which the Batch service runs the job's tasks. */ poolInfo: PoolInformation; /** - * @member {OnAllTasksComplete} [onAllTasksComplete] The action the Batch - * service should take when all tasks in the job are in the completed state. - * Note that if a job contains no tasks, then all tasks are considered - * complete. This option is therefore most commonly used with a Job Manager - * task; if you want to use automatic job termination without a Job Manager, - * you should initially set onAllTasksComplete to noaction and update the job - * properties to set onAllTasksComplete to terminatejob once you have - * finished adding tasks. The default is noaction. Possible values include: - * 'noAction', 'terminateJob' + * The action the Batch service should take when all tasks in the job are in the completed state. + * Note that if a job contains no tasks, then all tasks are considered complete. This option is + * therefore most commonly used with a Job Manager task; if you want to use automatic job + * termination without a Job Manager, you should initially set onAllTasksComplete to noaction and + * update the job properties to set onAllTasksComplete to terminatejob once you have finished + * adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob' */ onAllTasksComplete?: OnAllTasksComplete; /** - * @member {OnTaskFailure} [onTaskFailure] The action the Batch service - * should take when any task in the job fails. A task is considered to have - * failed if has a failureInfo. A failureInfo is set if the task completes - * with a non-zero exit code after exhausting its retry count, or if there - * was an error starting the task, for example due to a resource file - * download error. The default is noaction. Possible values include: - * 'noAction', 'performExitOptionsJobAction' + * The action the Batch service should take when any task in the job fails. A task is considered + * to have failed if has a failureInfo. A failureInfo is set if the task completes with a + * non-zero exit code after exhausting its retry count, or if there was an error starting the + * task, for example due to a resource file download error. The default is noaction. Possible + * values include: 'noAction', 'performExitOptionsJobAction' */ onTaskFailure?: OnTaskFailure; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job as metadata. The Batch service does not assign any meaning to - * metadata; it is solely for the use of user code. + * A list of name-value pairs associated with the job as metadata. The Batch service does not + * assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; /** - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can - * define dependencies on each other. The default is false. + * Whether tasks in the job can define dependencies on each other. The default is false. */ usesTaskDependencies?: boolean; + /** + * The network configuration for the job. + */ + networkConfiguration?: JobNetworkConfiguration; } /** - * @interface * An interface representing TaskContainerExecutionInformation. * @summary Contains information about the container which a task is executing. - * */ export interface TaskContainerExecutionInformation { /** - * @member {string} [containerId] The ID of the container. + * The ID of the container. */ containerId?: string; /** - * @member {string} [state] The state of the container. This is the state of - * the container according to the Docker service. It is equivalent to the - * status field returned by "docker inspect". + * The state of the container. This is the state of the container according to the Docker + * service. It is equivalent to the status field returned by "docker inspect". */ state?: string; /** - * @member {string} [error] Detailed error information about the container. - * This is the detailed error string from the Docker service, if available. - * It is equivalent to the error field returned by "docker inspect". + * Detailed error information about the container. This is the detailed error string from the + * Docker service, if available. It is equivalent to the error field returned by "docker + * inspect". */ error?: string; } /** - * @interface * An interface representing TaskFailureInformation. * @summary Information about a task failure. - * */ export interface TaskFailureInformation { /** - * @member {ErrorCategory} category The category of the task error. Possible - * values include: 'userError', 'serverError' + * The category of the task error. Possible values include: 'userError', 'serverError' */ category: ErrorCategory; /** - * @member {string} [code] An identifier for the task error. Codes are - * invariant and are intended to be consumed programmatically. + * An identifier for the task error. Codes are invariant and are intended to be consumed + * programmatically. */ code?: string; /** - * @member {string} [message] A message describing the task error, intended - * to be suitable for display in a user interface. + * A message describing the task error, intended to be suitable for display in a user interface. */ message?: string; /** - * @member {NameValuePair[]} [details] A list of additional details related - * to the error. + * A list of additional details related to the error. */ details?: NameValuePair[]; } /** - * @interface * An interface representing JobPreparationTaskExecutionInformation. - * @summary Contains information about the execution of a Job Preparation task - * on a compute node. - * + * @summary Contains information about the execution of a Job Preparation task on a compute node. */ export interface JobPreparationTaskExecutionInformation { /** - * @member {Date} startTime The time at which the task started running. If - * the task has been restarted or retried, this is the most recent time at - * which the task started running. + * The time at which the task started running. If the task has been restarted or retried, this is + * the most recent time at which the task started running. */ startTime: Date; /** - * @member {Date} [endTime] The time at which the Job Preparation task - * completed. This property is set only if the task is in the Completed - * state. + * The time at which the Job Preparation task completed. This property is set only if the task is + * in the Completed state. */ endTime?: Date; /** - * @member {JobPreparationTaskState} state The current state of the Job - * Preparation task on the compute node. Possible values include: 'running', - * 'completed' + * The current state of the Job Preparation task on the compute node. Possible values include: + * 'running', 'completed' */ state: JobPreparationTaskState; /** - * @member {string} [taskRootDirectory] The root directory of the Job - * Preparation task on the compute node. You can use this path to retrieve - * files created by the task, such as log files. + * The root directory of the Job Preparation task on the compute node. You can use this path to + * retrieve files created by the task, such as log files. */ taskRootDirectory?: string; /** - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of - * the Job Preparation task on the compute node. + * The URL to the root directory of the Job Preparation task on the compute node. */ taskRootDirectoryUrl?: string; /** - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific - * convention implemented by the application developer for that process. If - * you use the exit code value to make decisions in your code, be sure that - * you know the exit code convention used by the application process. Note - * that the exit code may also be generated by the compute node operating - * system, such as when a process is forcibly terminated. + * The exit code of the program specified on the task command line. This parameter is returned + * only if the task is in the completed state. The exit code for a process reflects the specific + * convention implemented by the application developer for that process. If you use the exit code + * value to make decisions in your code, be sure that you know the exit code convention used by + * the application process. Note that the exit code may also be generated by the compute node + * operating system, such as when a process is forcibly terminated. */ exitCode?: number; /** - * @member {TaskContainerExecutionInformation} [containerInfo] Information - * about the container under which the task is executing. This property is - * set only if the task runs in a container context. + * Information about the container under which the task is executing. This property is set only + * if the task runs in a container context. */ containerInfo?: TaskContainerExecutionInformation; /** - * @member {TaskFailureInformation} [failureInfo] Information describing the - * task failure, if any. This property is set only if the task is in the - * completed state and encountered a failure. + * Information describing the task failure, if any. This property is set only if the task is in + * the completed state and encountered a failure. */ failureInfo?: TaskFailureInformation; /** - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. Task application failures (non-zero - * exit code) are retried, pre-processing errors (the task could not be run) - * and file upload errors are not retried. The Batch service will retry the - * task up to the limit specified by the constraints. + * The number of times the task has been retried by the Batch service. Task application failures + * (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file + * upload errors are not retried. The Batch service will retry the task up to the limit specified + * by the constraints. Task application failures (non-zero exit code) are retried, pre-processing + * errors (the task could not be run) and file upload errors are not retried. The Batch service + * will retry the task up to the limit specified by the constraints. */ retryCount: number; /** - * @member {Date} [lastRetryTime] The most recent time at which a retry of - * the Job Preparation task started running. This property is set only if the - * task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node - * was rebooted during a retry, then the startTime is updated but the - * lastRetryTime is not. + * The most recent time at which a retry of the Job Preparation task started running. This + * property is set only if the task was retried (i.e. retryCount is nonzero). If present, this is + * typically the same as startTime, but may be different if the task has been restarted for + * reasons other than retry; for example, if the compute node was rebooted during a retry, then + * the startTime is updated but the lastRetryTime is not. */ lastRetryTime?: Date; /** - * @member {TaskExecutionResult} [result] The result of the task execution. - * If the value is 'failed', then the details of the failure can be found in - * the failureInfo property. Possible values include: 'success', 'failure' + * The result of the task execution. If the value is 'failed', then the details of the failure + * can be found in the failureInfo property. Possible values include: 'success', 'failure' */ result?: TaskExecutionResult; } /** - * @interface * An interface representing JobReleaseTaskExecutionInformation. - * @summary Contains information about the execution of a Job Release task on a - * compute node. - * + * @summary Contains information about the execution of a Job Release task on a compute node. */ export interface JobReleaseTaskExecutionInformation { /** - * @member {Date} startTime The time at which the task started running. If - * the task has been restarted or retried, this is the most recent time at - * which the task started running. + * The time at which the task started running. If the task has been restarted or retried, this is + * the most recent time at which the task started running. */ startTime: Date; /** - * @member {Date} [endTime] The time at which the Job Release task completed. - * This property is set only if the task is in the Completed state. + * The time at which the Job Release task completed. This property is set only if the task is in + * the Completed state. */ endTime?: Date; /** - * @member {JobReleaseTaskState} state The current state of the Job Release - * task on the compute node. Possible values include: 'running', 'completed' + * The current state of the Job Release task on the compute node. Possible values include: + * 'running', 'completed' */ state: JobReleaseTaskState; /** - * @member {string} [taskRootDirectory] The root directory of the Job Release - * task on the compute node. You can use this path to retrieve files created - * by the task, such as log files. + * The root directory of the Job Release task on the compute node. You can use this path to + * retrieve files created by the task, such as log files. */ taskRootDirectory?: string; /** - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of - * the Job Release task on the compute node. + * The URL to the root directory of the Job Release task on the compute node. */ taskRootDirectoryUrl?: string; /** - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific - * convention implemented by the application developer for that process. If - * you use the exit code value to make decisions in your code, be sure that - * you know the exit code convention used by the application process. Note - * that the exit code may also be generated by the compute node operating - * system, such as when a process is forcibly terminated. + * The exit code of the program specified on the task command line. This parameter is returned + * only if the task is in the completed state. The exit code for a process reflects the specific + * convention implemented by the application developer for that process. If you use the exit code + * value to make decisions in your code, be sure that you know the exit code convention used by + * the application process. Note that the exit code may also be generated by the compute node + * operating system, such as when a process is forcibly terminated. */ exitCode?: number; /** - * @member {TaskContainerExecutionInformation} [containerInfo] Information - * about the container under which the task is executing. This property is - * set only if the task runs in a container context. + * Information about the container under which the task is executing. This property is set only + * if the task runs in a container context. */ containerInfo?: TaskContainerExecutionInformation; /** - * @member {TaskFailureInformation} [failureInfo] Information describing the - * task failure, if any. This property is set only if the task is in the - * completed state and encountered a failure. + * Information describing the task failure, if any. This property is set only if the task is in + * the completed state and encountered a failure. */ failureInfo?: TaskFailureInformation; /** - * @member {TaskExecutionResult} [result] The result of the task execution. - * If the value is 'failed', then the details of the failure can be found in - * the failureInfo property. Possible values include: 'success', 'failure' + * The result of the task execution. If the value is 'failed', then the details of the failure + * can be found in the failureInfo property. Possible values include: 'success', 'failure' */ result?: TaskExecutionResult; } /** - * @interface * An interface representing JobPreparationAndReleaseTaskExecutionInformation. - * @summary The status of the Job Preparation and Job Release tasks on a - * compute node. - * + * @summary The status of the Job Preparation and Job Release tasks on a compute node. */ export interface JobPreparationAndReleaseTaskExecutionInformation { /** - * @member {string} [poolId] The ID of the pool containing the compute node - * to which this entry refers. + * The ID of the pool containing the compute node to which this entry refers. */ poolId?: string; /** - * @member {string} [nodeId] The ID of the compute node to which this entry - * refers. + * The ID of the compute node to which this entry refers. */ nodeId?: string; /** - * @member {string} [nodeUrl] The URL of the compute node to which this entry - * refers. + * The URL of the compute node to which this entry refers. */ nodeUrl?: string; /** - * @member {JobPreparationTaskExecutionInformation} - * [jobPreparationTaskExecutionInfo] Information about the execution status - * of the Job Preparation task on this compute node. + * Information about the execution status of the Job Preparation task on this compute node. */ jobPreparationTaskExecutionInfo?: JobPreparationTaskExecutionInformation; /** - * @member {JobReleaseTaskExecutionInformation} [jobReleaseTaskExecutionInfo] - * Information about the execution status of the Job Release task on this - * compute node. This property is set only if the Job Release task has run on - * the node. + * Information about the execution status of the Job Release task on this compute node. This + * property is set only if the Job Release task has run on the node. */ jobReleaseTaskExecutionInfo?: JobReleaseTaskExecutionInformation; } /** - * @interface * An interface representing TaskCounts. * @summary The task counts for a job. - * */ export interface TaskCounts { /** - * @member {number} active The number of tasks in the active state. + * The number of tasks in the active state. */ active: number; /** - * @member {number} running The number of tasks in the running or preparing - * state. + * The number of tasks in the running or preparing state. */ running: number; /** - * @member {number} completed The number of tasks in the completed state. + * The number of tasks in the completed state. */ completed: number; /** - * @member {number} succeeded The number of tasks which succeeded. A task - * succeeds if its result (found in the executionInfo property) is 'success'. + * The number of tasks which succeeded. A task succeeds if its result (found in the executionInfo + * property) is 'success'. */ succeeded: number; /** - * @member {number} failed The number of tasks which failed. A task fails if - * its result (found in the executionInfo property) is 'failure'. + * The number of tasks which failed. A task fails if its result (found in the executionInfo + * property) is 'failure'. */ failed: number; } /** - * @interface * An interface representing AutoScaleRunError. - * @summary An error that occurred when executing or evaluating a pool - * autoscale formula. - * + * @summary An error that occurred when executing or evaluating a pool autoscale formula. */ export interface AutoScaleRunError { /** - * @member {string} [code] An identifier for the autoscale error. Codes are - * invariant and are intended to be consumed programmatically. + * An identifier for the autoscale error. Codes are invariant and are intended to be consumed + * programmatically. */ code?: string; /** - * @member {string} [message] A message describing the autoscale error, - * intended to be suitable for display in a user interface. + * A message describing the autoscale error, intended to be suitable for display in a user + * interface. */ message?: string; /** - * @member {NameValuePair[]} [values] A list of additional error details - * related to the autoscale error. + * A list of additional error details related to the autoscale error. */ values?: NameValuePair[]; } /** - * @interface * An interface representing AutoScaleRun. - * @summary The results and errors from an execution of a pool autoscale - * formula. - * + * @summary The results and errors from an execution of a pool autoscale formula. */ export interface AutoScaleRun { /** - * @member {Date} timestamp The time at which the autoscale formula was last - * evaluated. + * The time at which the autoscale formula was last evaluated. */ timestamp: Date; /** - * @member {string} [results] The final values of all variables used in the - * evaluation of the autoscale formula. Each variable value is returned in - * the form $variable=value, and variables are separated by semicolons. + * The final values of all variables used in the evaluation of the autoscale formula. Each + * variable value is returned in the form $variable=value, and variables are separated by + * semicolons. */ results?: string; /** - * @member {AutoScaleRunError} [error] Details of the error encountered - * evaluating the autoscale formula on the pool, if the evaluation was - * unsuccessful. + * Details of the error encountered evaluating the autoscale formula on the pool, if the + * evaluation was unsuccessful. */ error?: AutoScaleRunError; } /** - * @interface * An interface representing ResizeError. * @summary An error that occurred when resizing a pool. - * */ export interface ResizeError { /** - * @member {string} [code] An identifier for the pool resize error. Codes are - * invariant and are intended to be consumed programmatically. + * An identifier for the pool resize error. Codes are invariant and are intended to be consumed + * programmatically. */ code?: string; /** - * @member {string} [message] A message describing the pool resize error, - * intended to be suitable for display in a user interface. + * A message describing the pool resize error, intended to be suitable for display in a user + * interface. */ message?: string; /** - * @member {NameValuePair[]} [values] A list of additional error details - * related to the pool resize error. + * A list of additional error details related to the pool resize error. */ values?: NameValuePair[]; } /** - * @interface * An interface representing CloudPool. * @summary A pool in the Azure Batch service. - * */ export interface CloudPool { /** - * @member {string} [id] A string that uniquely identifies the pool within - * the account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two IDs within an account that differ only by case). + * A string that uniquely identifies the pool within the account. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores, and cannot contain + * more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not + * have two IDs within an account that differ only by case). */ id?: string; /** - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * The display name for the pool. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} [url] The URL of the pool. + * The URL of the pool. */ url?: string; /** - * @member {string} [eTag] The ETag of the pool. This is an opaque string. - * You can use it to detect whether the pool has changed between requests. In - * particular, you can be pass the ETag when updating a pool to specify that - * your changes should take effect only if nobody else has modified the pool - * in the meantime. + * The ETag of the pool. This is an opaque string. You can use it to detect whether the pool has + * changed between requests. In particular, you can be pass the ETag when updating a pool to + * specify that your changes should take effect only if nobody else has modified the pool in the + * meantime. */ eTag?: string; /** - * @member {Date} [lastModified] The last modified time of the pool. This is - * the last time at which the pool level data, such as the - * targetDedicatedNodes or enableAutoscale settings, changed. It does not - * factor in node-level changes such as a compute node changing state. + * The last modified time of the pool. This is the last time at which the pool level data, such + * as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in + * node-level changes such as a compute node changing state. */ lastModified?: Date; /** - * @member {Date} [creationTime] The creation time of the pool. + * The creation time of the pool. */ creationTime?: Date; /** - * @member {PoolState} [state] The current state of the pool. Possible values - * include: 'active', 'deleting', 'upgrading' + * The current state of the pool. Possible values include: 'active', 'deleting' */ state?: PoolState; /** - * @member {Date} [stateTransitionTime] The time at which the pool entered - * its current state. + * The time at which the pool entered its current state. */ stateTransitionTime?: Date; /** - * @member {AllocationState} [allocationState] Whether the pool is resizing. - * Possible values include: 'steady', 'resizing', 'stopping' + * Whether the pool is resizing. Possible values include: 'steady', 'resizing', 'stopping' */ allocationState?: AllocationState; /** - * @member {Date} [allocationStateTransitionTime] The time at which the pool - * entered its current allocation state. + * The time at which the pool entered its current allocation state. */ allocationStateTransitionTime?: Date; /** - * @member {string} [vmSize] The size of virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines in pools, see Choose a VM size for + * The size of virtual machines in the pool. All virtual machines in a pool are the same size. + * For information about available sizes of virtual machines in pools, see Choose a VM size for * compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */ vmSize?: string; /** - * @member {CloudServiceConfiguration} [cloudServiceConfiguration] The cloud - * service configuration for the pool. This property and - * virtualMachineConfiguration are mutually exclusive and one of the - * properties must be specified. This property cannot be specified if the - * Batch account was created with its poolAllocationMode property set to + * The cloud service configuration for the pool. This property and virtualMachineConfiguration + * are mutually exclusive and one of the properties must be specified. This property cannot be + * specified if the Batch account was created with its poolAllocationMode property set to * 'UserSubscription'. */ cloudServiceConfiguration?: CloudServiceConfiguration; /** - * @member {VirtualMachineConfiguration} [virtualMachineConfiguration] The - * virtual machine configuration for the pool. This property and - * cloudServiceConfiguration are mutually exclusive and one of the properties - * must be specified. + * The virtual machine configuration for the pool. This property and cloudServiceConfiguration + * are mutually exclusive and one of the properties must be specified. */ virtualMachineConfiguration?: VirtualMachineConfiguration; /** - * @member {string} [resizeTimeout] The timeout for allocation of compute - * nodes to the pool. This is the timeout for the most recent resize - * operation. (The initial sizing when the pool is created counts as a - * resize.) The default value is 15 minutes. + * The timeout for allocation of compute nodes to the pool. This is the timeout for the most + * recent resize operation. (The initial sizing when the pool is created counts as a resize.) The + * default value is 15 minutes. */ resizeTimeout?: string; /** - * @member {ResizeError[]} [resizeErrors] A list of errors encountered while - * performing the last resize on the pool. This property is set only if one - * or more errors occurred during the last pool resize, and only when the - * pool allocationState is Steady. + * A list of errors encountered while performing the last resize on the pool. This property is + * set only if one or more errors occurred during the last pool resize, and only when the pool + * allocationState is Steady. */ resizeErrors?: ResizeError[]; /** - * @member {number} [currentDedicatedNodes] The number of dedicated compute - * nodes currently in the pool. + * The number of dedicated compute nodes currently in the pool. */ currentDedicatedNodes?: number; /** - * @member {number} [currentLowPriorityNodes] The number of low-priority - * compute nodes currently in the pool. Low-priority compute nodes which have - * been preempted are included in this count. + * The number of low-priority compute nodes currently in the pool. Low-priority compute nodes + * which have been preempted are included in this count. */ currentLowPriorityNodes?: number; /** - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. + * The desired number of dedicated compute nodes in the pool. */ targetDedicatedNodes?: number; /** - * @member {number} [targetLowPriorityNodes] The desired number of - * low-priority compute nodes in the pool. + * The desired number of low-priority compute nodes in the pool. */ targetLowPriorityNodes?: number; /** - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula property is required and the pool automatically - * resizes according to the formula. The default value is false. + * Whether the pool size should automatically adjust over time. If false, at least one of + * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the + * autoScaleFormula property is required and the pool automatically resizes according to the + * formula. The default value is false. */ enableAutoScale?: boolean; /** - * @member {string} [autoScaleFormula] A formula for the desired number of - * compute nodes in the pool. This property is set only if the pool - * automatically scales, i.e. enableAutoScale is true. + * A formula for the desired number of compute nodes in the pool. This property is set only if + * the pool automatically scales, i.e. enableAutoScale is true. */ autoScaleFormula?: string; /** - * @member {string} [autoScaleEvaluationInterval] The time interval at which - * to automatically adjust the pool size according to the autoscale formula. - * This property is set only if the pool automatically scales, i.e. - * enableAutoScale is true. + * The time interval at which to automatically adjust the pool size according to the autoscale + * formula. This property is set only if the pool automatically scales, i.e. enableAutoScale is + * true. */ autoScaleEvaluationInterval?: string; /** - * @member {AutoScaleRun} [autoScaleRun] The results and errors from the last - * execution of the autoscale formula. This property is set only if the pool - * automatically scales, i.e. enableAutoScale is true. + * The results and errors from the last execution of the autoscale formula. This property is set + * only if the pool automatically scales, i.e. enableAutoScale is true. */ autoScaleRun?: AutoScaleRun; /** - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. This imposes restrictions on which - * nodes can be assigned to the pool. Specifying this value can reduce the - * chance of the requested number of nodes to be allocated in the pool. + * Whether the pool permits direct communication between nodes. This imposes restrictions on + * which nodes can be assigned to the pool. Specifying this value can reduce the chance of the + * requested number of nodes to be allocated in the pool. */ enableInterNodeCommunication?: boolean; /** - * @member {NetworkConfiguration} [networkConfiguration] The network - * configuration for the pool. + * The network configuration for the pool. */ networkConfiguration?: NetworkConfiguration; /** - * @member {StartTask} [startTask] A task specified to run on each compute - * node as it joins the pool. + * A task specified to run on each compute node as it joins the pool. */ startTask?: StartTask; /** - * @member {CertificateReference[]} [certificateReferences] The list of - * certificates to be installed on each compute node in the pool. For Windows - * compute nodes, the Batch service installs the certificates to the - * specified certificate store and location. For Linux compute nodes, the - * certificates are stored in a directory inside the task working directory - * and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the - * task to query for this location. For certificates with visibility of - * 'remoteUser', a 'certs' directory is created in the user's home directory - * (e.g., /home/{user-name}/certs) and certificates are placed in that - * directory. + * The list of certificates to be installed on each compute node in the pool. For Windows compute + * nodes, the Batch service installs the certificates to the specified certificate store and + * location. For Linux compute nodes, the certificates are stored in a directory inside the task + * working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the + * task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' + * directory is created in the user's home directory (e.g., /home/{user-name}/certs) and + * certificates are placed in that directory. */ certificateReferences?: CertificateReference[]; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] The - * list of application packages to be installed on each compute node in the - * pool. + * The list of application packages to be installed on each compute node in the pool. Changes to + * application package references affect all new compute nodes joining the pool, but do not + * affect compute nodes that are already in the pool until they are rebooted or reimaged. There + * is a maximum of 10 application package references on any given pool. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {string[]} [applicationLicenses] The list of application licenses - * the Batch service will make available on each compute node in the pool. - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. + * The list of application licenses the Batch service will make available on each compute node in + * the pool. The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. */ applicationLicenses?: string[]; /** - * @member {number} [maxTasksPerNode] The maximum number of tasks that can - * run concurrently on a single compute node in the pool. + * The maximum number of tasks that can run concurrently on a single compute node in the pool. + * The default value is 1. The maximum value is the smaller of 4 times the number of cores of the + * vmSize of the pool or 256. */ maxTasksPerNode?: number; /** - * @member {TaskSchedulingPolicy} [taskSchedulingPolicy] How tasks are - * distributed across compute nodes in a pool. + * How tasks are distributed across compute nodes in a pool. If not specified, the default is + * spread. */ taskSchedulingPolicy?: TaskSchedulingPolicy; /** - * @member {UserAccount[]} [userAccounts] The list of user accounts to be - * created on each node in the pool. + * The list of user accounts to be created on each node in the pool. */ userAccounts?: UserAccount[]; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the pool as metadata. + * A list of name-value pairs associated with the pool as metadata. */ metadata?: MetadataItem[]; /** - * @member {PoolStatistics} [stats] Utilization and resource usage statistics - * for the entire lifetime of the pool. The statistics may not be immediately - * available. The Batch service performs periodic roll-up of statistics. The - * typical delay is about 30 minutes. + * Utilization and resource usage statistics for the entire lifetime of the pool. This property + * is populated only if the CloudPool was retrieved with an expand clause including the 'stats' + * attribute; otherwise it is null. The statistics may not be immediately available. The Batch + * service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */ stats?: PoolStatistics; } /** - * @interface * An interface representing PoolAddParameter. * @summary A pool in the Azure Batch service to add. - * */ export interface PoolAddParameter { /** - * @member {string} id A string that uniquely identifies the pool within the - * account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two pool IDs within an account that differ only by case). + * A string that uniquely identifies the pool within the account. The ID can contain any + * combination of alphanumeric characters including hyphens and underscores, and cannot contain + * more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not + * have two pool IDs within an account that differ only by case). */ id: string; /** - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * The display name for the pool. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} vmSize The size of virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines for Cloud Services pools (pools + * The size of virtual machines in the pool. All virtual machines in a pool are the same size. + * For information about available sizes of virtual machines for Cloud Services pools (pools * created with cloudServiceConfiguration), see Sizes for Cloud Services - * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). - * Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and - * A2V2. For information about available VM sizes for pools using images from - * the Virtual Machines Marketplace (pools created with - * virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) - * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) - * or Sizes for Virtual Machines (Windows) - * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). - * Batch supports all Azure VM sizes except STANDARD_A0 and those with - * premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). + * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch + * supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about + * available VM sizes for pools using images from the Virtual Machines Marketplace (pools created + * with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes + * for Virtual Machines (Windows) + * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch + * supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, + * STANDARD_DS, and STANDARD_DSV2 series). */ vmSize: string; /** - * @member {CloudServiceConfiguration} [cloudServiceConfiguration] The cloud - * service configuration for the pool. This property and - * virtualMachineConfiguration are mutually exclusive and one of the - * properties must be specified. This property cannot be specified if the - * Batch account was created with its poolAllocationMode property set to + * The cloud service configuration for the pool. This property and virtualMachineConfiguration + * are mutually exclusive and one of the properties must be specified. This property cannot be + * specified if the Batch account was created with its poolAllocationMode property set to * 'UserSubscription'. */ cloudServiceConfiguration?: CloudServiceConfiguration; /** - * @member {VirtualMachineConfiguration} [virtualMachineConfiguration] The - * virtual machine configuration for the pool. This property and - * cloudServiceConfiguration are mutually exclusive and one of the properties - * must be specified. + * The virtual machine configuration for the pool. This property and cloudServiceConfiguration + * are mutually exclusive and one of the properties must be specified. */ virtualMachineConfiguration?: VirtualMachineConfiguration; /** - * @member {string} [resizeTimeout] The timeout for allocation of compute - * nodes to the pool. This timeout applies only to manual scaling; it has no - * effect when enableAutoScale is set to true. The default value is 15 - * minutes. The minimum value is 5 minutes. If you specify a value less than - * 5 minutes, the Batch service returns an error; if you are calling the REST - * API directly, the HTTP status code is 400 (Bad Request). + * The timeout for allocation of compute nodes to the pool. This timeout applies only to manual + * scaling; it has no effect when enableAutoScale is set to true. The default value is 15 + * minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch + * service returns an error; if you are calling the REST API directly, the HTTP status code is + * 400 (Bad Request). */ resizeTimeout?: string; /** - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then - * you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. + * The desired number of dedicated compute nodes in the pool. This property must not be specified + * if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set + * either targetDedicatedNodes, targetLowPriorityNodes, or both. */ targetDedicatedNodes?: number; /** - * @member {number} [targetLowPriorityNodes] The desired number of - * low-priority compute nodes in the pool. This property must not be - * specified if enableAutoScale is set to true. If enableAutoScale is set to - * false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. + * The desired number of low-priority compute nodes in the pool. This property must not be + * specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must + * set either targetDedicatedNodes, targetLowPriorityNodes, or both. */ targetLowPriorityNodes?: number; /** - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula property is required and the pool automatically - * resizes according to the formula. The default value is false. + * Whether the pool size should automatically adjust over time. If false, at least one of + * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the + * autoScaleFormula property is required and the pool automatically resizes according to the + * formula. The default value is false. */ enableAutoScale?: boolean; /** - * @member {string} [autoScaleFormula] A formula for the desired number of - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to false. It is required if enableAutoScale is set - * to true. The formula is checked for validity before the pool is created. - * If the formula is not valid, the Batch service rejects the request with - * detailed error information. For more information about specifying this - * formula, see 'Automatically scale compute nodes in an Azure Batch pool' - * (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). + * A formula for the desired number of compute nodes in the pool. This property must not be + * specified if enableAutoScale is set to false. It is required if enableAutoScale is set to + * true. The formula is checked for validity before the pool is created. If the formula is not + * valid, the Batch service rejects the request with detailed error information. For more + * information about specifying this formula, see 'Automatically scale compute nodes in an Azure + * Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). */ autoScaleFormula?: string; /** - * @member {string} [autoScaleEvaluationInterval] The time interval at which - * to automatically adjust the pool size according to the autoscale formula. - * The default value is 15 minutes. The minimum and maximum value are 5 - * minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service returns an error; if - * you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). + * The time interval at which to automatically adjust the pool size according to the autoscale + * formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 + * hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the + * Batch service returns an error; if you are calling the REST API directly, the HTTP status code + * is 400 (Bad Request). */ autoScaleEvaluationInterval?: string; /** - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication - * limits the maximum size of the pool due to deployment restrictions on the - * nodes of the pool. This may result in the pool not reaching its desired - * size. The default value is false. + * Whether the pool permits direct communication between nodes. Enabling inter-node communication + * limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. + * This may result in the pool not reaching its desired size. The default value is false. */ enableInterNodeCommunication?: boolean; /** - * @member {NetworkConfiguration} [networkConfiguration] The network - * configuration for the pool. + * The network configuration for the pool. */ networkConfiguration?: NetworkConfiguration; /** - * @member {StartTask} [startTask] A task specified to run on each compute - * node as it joins the pool. The task runs when the node is added to the - * pool or when the node is restarted. + * A task specified to run on each compute node as it joins the pool. The task runs when the node + * is added to the pool or when the node is restarted. */ startTask?: StartTask; /** - * @member {CertificateReference[]} [certificateReferences] The list of - * certificates to be installed on each compute node in the pool. For Windows - * compute nodes, the Batch service installs the certificates to the - * specified certificate store and location. For Linux compute nodes, the - * certificates are stored in a directory inside the task working directory - * and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the - * task to query for this location. For certificates with visibility of - * 'remoteUser', a 'certs' directory is created in the user's home directory - * (e.g., /home/{user-name}/certs) and certificates are placed in that - * directory. + * The list of certificates to be installed on each compute node in the pool. For Windows compute + * nodes, the Batch service installs the certificates to the specified certificate store and + * location. For Linux compute nodes, the certificates are stored in a directory inside the task + * working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the + * task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' + * directory is created in the user's home directory (e.g., /home/{user-name}/certs) and + * certificates are placed in that directory. */ certificateReferences?: CertificateReference[]; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] The - * list of application packages to be installed on each compute node in the - * pool. + * The list of application packages to be installed on each compute node in the pool. Changes to + * application package references affect all new compute nodes joining the pool, but do not + * affect compute nodes that are already in the pool until they are rebooted or reimaged. There + * is a maximum of 10 application package references on any given pool. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {string[]} [applicationLicenses] The list of application licenses - * the Batch service will make available on each compute node in the pool. - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. + * The list of application licenses the Batch service will make available on each compute node in + * the pool. The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. */ applicationLicenses?: string[]; /** - * @member {number} [maxTasksPerNode] The maximum number of tasks that can - * run concurrently on a single compute node in the pool. The default value - * is 1. The maximum value of this setting depends on the size of the compute - * nodes in the pool (the vmSize setting). + * The maximum number of tasks that can run concurrently on a single compute node in the pool. + * The default value is 1. The maximum value is the smaller of 4 times the number of cores of the + * vmSize of the pool or 256. */ maxTasksPerNode?: number; /** - * @member {TaskSchedulingPolicy} [taskSchedulingPolicy] How tasks are - * distributed across compute nodes in a pool. + * How tasks are distributed across compute nodes in a pool. If not specified, the default is + * spread. */ taskSchedulingPolicy?: TaskSchedulingPolicy; /** - * @member {UserAccount[]} [userAccounts] The list of user accounts to be - * created on each node in the pool. + * The list of user accounts to be created on each node in the pool. */ userAccounts?: UserAccount[]; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the pool as metadata. The Batch service does not assign any meaning - * to metadata; it is solely for the use of user code. + * A list of name-value pairs associated with the pool as metadata. The Batch service does not + * assign any meaning to metadata; it is solely for the use of user code. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing AffinityInformation. - * @summary A locality hint that can be used by the Batch service to select a - * compute node on which to start a task. - * + * @summary A locality hint that can be used by the Batch service to select a compute node on which + * to start a task. */ export interface AffinityInformation { /** - * @member {string} affinityId An opaque string representing the location of - * a compute node or a task that has run previously. You can pass the - * affinityId of a compute node to indicate that this task needs to run on - * that compute node. Note that this is just a soft affinity. If the target - * node is busy or unavailable at the time the task is scheduled, then the - * task will be scheduled elsewhere. + * An opaque string representing the location of a compute node or a task that has run + * previously. You can pass the affinityId of a compute node to indicate that this task needs to + * run on that compute node. Note that this is just a soft affinity. If the target node is busy + * or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere. */ affinityId: string; } /** - * @interface * An interface representing TaskExecutionInformation. * @summary Information about the execution of a task. - * */ export interface TaskExecutionInformation { /** - * @member {Date} [startTime] The time at which the task started running. - * 'Running' corresponds to the running state, so if the task specifies - * resource files or application packages, then the start time reflects the - * time at which the task started downloading or deploying these. If the task - * has been restarted or retried, this is the most recent time at which the - * task started running. This property is present only for tasks that are in - * the running or completed state. + * The time at which the task started running. 'Running' corresponds to the running state, so if + * the task specifies resource files or application packages, then the start time reflects the + * time at which the task started downloading or deploying these. If the task has been restarted + * or retried, this is the most recent time at which the task started running. This property is + * present only for tasks that are in the running or completed state. */ startTime?: Date; /** - * @member {Date} [endTime] The time at which the task completed. This - * property is set only if the task is in the Completed state. + * The time at which the task completed. This property is set only if the task is in the + * Completed state. */ endTime?: Date; /** - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This property is set only if the task is in the - * completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the task (due to - * timeout, or user termination via the API) you may see an operating - * system-defined exit code. + * The exit code of the program specified on the task command line. This property is set only if + * the task is in the completed state. In general, the exit code for a process reflects the + * specific convention implemented by the application developer for that process. If you use the + * exit code value to make decisions in your code, be sure that you know the exit code convention + * used by the application process. However, if the Batch service terminates the task (due to + * timeout, or user termination via the API) you may see an operating system-defined exit code. */ exitCode?: number; /** - * @member {TaskContainerExecutionInformation} [containerInfo] Information - * about the container under which the task is executing. This property is - * set only if the task runs in a container context. + * Information about the container under which the task is executing. This property is set only + * if the task runs in a container context. */ containerInfo?: TaskContainerExecutionInformation; /** - * @member {TaskFailureInformation} [failureInfo] Information describing the - * task failure, if any. This property is set only if the task is in the - * completed state and encountered a failure. + * Information describing the task failure, if any. This property is set only if the task is in + * the completed state and encountered a failure. */ failureInfo?: TaskFailureInformation; /** - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. + * The number of times the task has been retried by the Batch service. Task application failures + * (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file + * upload errors are not retried. The Batch service will retry the task up to the limit specified + * by the constraints. */ retryCount: number; /** - * @member {Date} [lastRetryTime] The most recent time at which a retry of - * the task started running. This element is present only if the task was - * retried (i.e. retryCount is nonzero). If present, this is typically the - * same as startTime, but may be different if the task has been restarted for - * reasons other than retry; for example, if the compute node was rebooted - * during a retry, then the startTime is updated but the lastRetryTime is - * not. + * The most recent time at which a retry of the task started running. This element is present + * only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the + * same as startTime, but may be different if the task has been restarted for reasons other than + * retry; for example, if the compute node was rebooted during a retry, then the startTime is + * updated but the lastRetryTime is not. */ lastRetryTime?: Date; /** - * @member {number} requeueCount The number of times the task has been - * requeued by the Batch service as the result of a user request. When the - * user removes nodes from a pool (by resizing/shrinking the pool) or when - * the job is being disabled, the user can specify that running tasks on the - * nodes be requeued for execution. This count tracks how many times the task - * has been requeued for these reasons. + * The number of times the task has been requeued by the Batch service as the result of a user + * request. When the user removes nodes from a pool (by resizing/shrinking the pool) or when the + * job is being disabled, the user can specify that running tasks on the nodes be requeued for + * execution. This count tracks how many times the task has been requeued for these reasons. */ requeueCount: number; /** - * @member {Date} [lastRequeueTime] The most recent time at which the task - * has been requeued by the Batch service as the result of a user request. - * This property is set only if the requeueCount is nonzero. + * The most recent time at which the task has been requeued by the Batch service as the result of + * a user request. This property is set only if the requeueCount is nonzero. */ lastRequeueTime?: Date; /** - * @member {TaskExecutionResult} [result] The result of the task execution. - * If the value is 'failed', then the details of the failure can be found in - * the failureInfo property. Possible values include: 'success', 'failure' + * The result of the task execution. If the value is 'failed', then the details of the failure + * can be found in the failureInfo property. Possible values include: 'success', 'failure' */ result?: TaskExecutionResult; } /** - * @interface * An interface representing ComputeNodeInformation. * @summary Information about the compute node on which a task ran. - * */ export interface ComputeNodeInformation { /** - * @member {string} [affinityId] An identifier for the compute node on which - * the task ran, which can be passed when adding a task to request that the - * task be scheduled on this compute node. + * An identifier for the compute node on which the task ran, which can be passed when adding a + * task to request that the task be scheduled on this compute node. */ affinityId?: string; /** - * @member {string} [nodeUrl] The URL of the node on which the task ran. . + * The URL of the node on which the task ran. . */ nodeUrl?: string; /** - * @member {string} [poolId] The ID of the pool on which the task ran. + * The ID of the pool on which the task ran. */ poolId?: string; /** - * @member {string} [nodeId] The ID of the node on which the task ran. + * The ID of the node on which the task ran. */ nodeId?: string; /** - * @member {string} [taskRootDirectory] The root directory of the task on the - * compute node. + * The root directory of the task on the compute node. */ taskRootDirectory?: string; /** - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of - * the task on the compute node. + * The URL to the root directory of the task on the compute node. */ taskRootDirectoryUrl?: string; } /** - * @interface - * An interface representing NodeAgentInformation. + * The Batch node agent is a program that runs on each node in the pool and provides Batch + * capability on the compute node. * @summary Information about the node agent. - * - * The Batch node agent is a program that runs on each node in the pool and - * provides Batch capability on the compute node. - * */ export interface NodeAgentInformation { /** - * @member {string} version The version of the Batch node agent running on - * the compute node. This version number can be checked against the node - * agent release notes located at + * The version of the Batch node agent running on the compute node. This version number can be + * checked against the node agent release notes located at * https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. */ version: string; /** - * @member {Date} lastUpdateTime The time when the node agent was updated on - * the compute node. This is the most recent time that the node agent was - * updated to a new version. + * The time when the node agent was updated on the compute node. This is the most recent time + * that the node agent was updated to a new version. */ lastUpdateTime: Date; } /** - * @interface - * An interface representing MultiInstanceSettings. + * Multi-instance tasks are commonly used to support MPI tasks. In the MPI case, if any of the + * subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance + * task fails. The multi-instance task is then terminated and retried, up to its retry limit. * @summary Settings which specify how to run a multi-instance task. - * - * Multi-instance tasks are commonly used to support MPI tasks. - * */ export interface MultiInstanceSettings { /** - * @member {number} [numberOfInstances] The number of compute nodes required - * by the task. If omitted, the default is 1. + * The number of compute nodes required by the task. If omitted, the default is 1. */ numberOfInstances?: number; /** - * @member {string} coordinationCommandLine The command line to run on all - * the compute nodes to enable them to coordinate when the primary runs the - * main task command. A typical coordination command line launches a - * background service and verifies that the service is ready to process - * inter-node messages. + * The command line to run on all the compute nodes to enable them to coordinate when the primary + * runs the main task command. A typical coordination command line launches a background service + * and verifies that the service is ready to process inter-node messages. */ coordinationCommandLine: string; /** - * @member {ResourceFile[]} [commonResourceFiles] A list of files that the - * Batch service will download before running the coordination command line. - * The difference between common resource files and task resource files is - * that common resource files are downloaded for all subtasks including the - * primary, whereas task resource files are downloaded only for the primary. - * Also note that these resource files are not downloaded to the task working - * directory, but instead are downloaded to the task root directory (one - * directory above the working directory). There is a maximum size for the - * list of resource files. When the max size is exceeded, the request will - * fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can - * be achieved using .zip files, Application Packages, or Docker Containers. + * A list of files that the Batch service will download before running the coordination command + * line. The difference between common resource files and task resource files is that common + * resource files are downloaded for all subtasks including the primary, whereas task resource + * files are downloaded only for the primary. Also note that these resource files are not + * downloaded to the task working directory, but instead are downloaded to the task root + * directory (one directory above the working directory). There is a maximum size for the list + * of resource files. When the max size is exceeded, the request will fail and the response + * error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must + * be reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. */ commonResourceFiles?: ResourceFile[]; } /** - * @interface * An interface representing TaskStatistics. * @summary Resource usage statistics for a task. - * */ export interface TaskStatistics { /** - * @member {string} url The URL of the statistics. + * The URL of the statistics. */ url: string; /** - * @member {Date} startTime The start time of the time range covered by the - * statistics. + * The start time of the time range covered by the statistics. */ startTime: Date; /** - * @member {Date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. + * The time at which the statistics were last updated. All statistics are limited to the range + * between startTime and lastUpdateTime. */ lastUpdateTime: Date; /** - * @member {string} userCPUTime The total user mode CPU time (summed across - * all cores and all compute nodes) consumed by the task. + * The total user mode CPU time (summed across all cores and all compute nodes) consumed by the + * task. */ userCPUTime: string; /** - * @member {string} kernelCPUTime The total kernel mode CPU time (summed - * across all cores and all compute nodes) consumed by the task. + * The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by the + * task. */ kernelCPUTime: string; /** - * @member {string} wallClockTime The total wall clock time of the task. The - * wall clock time is the elapsed time from when the task started running on - * a compute node to when it finished (or to the last time the statistics - * were updated, if the task had not finished by then). If the task was - * retried, this includes the wall clock time of all the task retries. + * The total wall clock time of the task. The wall clock time is the elapsed time from when the + * task started running on a compute node to when it finished (or to the last time the statistics + * were updated, if the task had not finished by then). If the task was retried, this includes + * the wall clock time of all the task retries. */ wallClockTime: string; /** - * @member {number} readIOps The total number of disk read operations made by - * the task. + * The total number of disk read operations made by the task. */ readIOps: number; /** - * @member {number} writeIOps The total number of disk write operations made - * by the task. + * The total number of disk write operations made by the task. */ writeIOps: number; /** - * @member {number} readIOGiB The total gibibytes read from disk by the task. + * The total gibibytes read from disk by the task. */ readIOGiB: number; /** - * @member {number} writeIOGiB The total gibibytes written to disk by the - * task. + * The total gibibytes written to disk by the task. */ writeIOGiB: number; /** - * @member {string} waitTime The total wait time of the task. The wait time - * for a task is defined as the elapsed time between the creation of the task - * and the start of task execution. (If the task is retried due to failures, - * the wait time is the time to the most recent task execution.). + * The total wait time of the task. The wait time for a task is defined as the elapsed time + * between the creation of the task and the start of task execution. (If the task is retried due + * to failures, the wait time is the time to the most recent task execution.). */ waitTime: string; } /** - * @interface - * An interface representing TaskIdRange. - * @summary A range of task IDs that a task can depend on. All tasks with IDs - * in the range must complete successfully before the dependent task can be - * scheduled. - * - * The start and end of the range are inclusive. For example, if a range has - * start 9 and end 12, then it represents tasks '9', '10', '11' and '12'. - * + * The start and end of the range are inclusive. For example, if a range has start 9 and end 12, + * then it represents tasks '9', '10', '11' and '12'. + * @summary A range of task IDs that a task can depend on. All tasks with IDs in the range must + * complete successfully before the dependent task can be scheduled. */ export interface TaskIdRange { /** - * @member {number} start The first task ID in the range. + * The first task ID in the range. */ start: number; /** - * @member {number} end The last task ID in the range. + * The last task ID in the range. */ end: number; } /** - * @interface * An interface representing TaskDependencies. - * @summary Specifies any dependencies of a task. Any task that is explicitly - * specified or within a dependency range must complete before the dependant - * task will be scheduled. - * + * @summary Specifies any dependencies of a task. Any task that is explicitly specified or within a + * dependency range must complete before the dependant task will be scheduled. */ export interface TaskDependencies { /** - * @member {string[]} [taskIds] The list of task IDs that this task depends - * on. All tasks in this list must complete successfully before the dependent - * task can be scheduled. The taskIds collection is limited to 64000 - * characters total (i.e. the combined length of all task IDs). If the - * taskIds collection exceeds the maximum length, the Add Task request fails - * with error code TaskDependencyListTooLong. In this case consider using - * task ID ranges instead. + * The list of task IDs that this task depends on. All tasks in this list must complete + * successfully before the dependent task can be scheduled. The taskIds collection is limited to + * 64000 characters total (i.e. the combined length of all task IDs). If the taskIds collection + * exceeds the maximum length, the Add Task request fails with error code + * TaskDependencyListTooLong. In this case consider using task ID ranges instead. */ taskIds?: string[]; /** - * @member {TaskIdRange[]} [taskIdRanges] The list of task ID ranges that - * this task depends on. All tasks in all ranges must complete successfully - * before the dependent task can be scheduled. + * The list of task ID ranges that this task depends on. All tasks in all ranges must complete + * successfully before the dependent task can be scheduled. */ taskIdRanges?: TaskIdRange[]; } /** - * @interface - * An interface representing CloudTask. + * Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of + * recovery operations include (but are not limited to) when an unhealthy compute node is rebooted + * or a compute node disappeared due to host failure. Retries due to recovery operations are + * independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount + * is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should + * be idempotent. This means tasks need to tolerate being interrupted and restarted without causing + * any corruption or duplicate data. The best practice for long running tasks is to use some form + * of checkpointing. * @summary An Azure Batch task. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * */ export interface CloudTask { /** - * @member {string} [id] A string that uniquely identifies the task within - * the job. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 + * A string that uniquely identifies the task within the job. The ID can contain any combination + * of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 * characters. */ id?: string; /** - * @member {string} [displayName] A display name for the task. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * A display name for the task. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} [url] The URL of the task. + * The URL of the task. */ url?: string; /** - * @member {string} [eTag] The ETag of the task. This is an opaque string. - * You can use it to detect whether the task has changed between requests. In - * particular, you can be pass the ETag when updating a task to specify that - * your changes should take effect only if nobody else has modified the task - * in the meantime. + * The ETag of the task. This is an opaque string. You can use it to detect whether the task has + * changed between requests. In particular, you can be pass the ETag when updating a task to + * specify that your changes should take effect only if nobody else has modified the task in the + * meantime. */ eTag?: string; /** - * @member {Date} [lastModified] The last modified time of the task. + * The last modified time of the task. */ lastModified?: Date; /** - * @member {Date} [creationTime] The creation time of the task. + * The creation time of the task. */ creationTime?: Date; /** - * @member {ExitConditions} [exitConditions] How the Batch service should - * respond when the task completes. + * How the Batch service should respond when the task completes. */ exitConditions?: ExitConditions; /** - * @member {TaskState} [state] The current state of the task. Possible values - * include: 'active', 'preparing', 'running', 'completed' + * The current state of the task. Possible values include: 'active', 'preparing', 'running', + * 'completed' */ state?: TaskState; /** - * @member {Date} [stateTransitionTime] The time at which the task entered - * its current state. + * The time at which the task entered its current state. */ stateTransitionTime?: Date; /** - * @member {TaskState} [previousState] The previous state of the task. This - * property is not set if the task is in its initial Active state. Possible - * values include: 'active', 'preparing', 'running', 'completed' + * The previous state of the task. This property is not set if the task is in its initial Active + * state. Possible values include: 'active', 'preparing', 'running', 'completed' */ previousState?: TaskState; /** - * @member {Date} [previousStateTransitionTime] The time at which the task - * entered its previous state. This property is not set if the task is in its - * initial Active state. + * The time at which the task entered its previous state. This property is not set if the task is + * in its initial Active state. */ previousStateTransitionTime?: Date; /** - * @member {string} [commandLine] The command line of the task. For - * multi-instance tasks, the command line is executed as the primary task, - * after the primary task and all subtasks have finished executing the - * coordination command line. The command line does not run under a shell, - * and therefore cannot take advantage of shell features such as environment - * variable expansion. If you want to take advantage of such features, you - * should invoke the shell in the command line, for example using "cmd /c - * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command - * line refers to file paths, it should use a relative path (relative to the - * task working directory), or use the Batch provided environment variable + * The command line of the task. For multi-instance tasks, the command line is executed as the + * primary task, after the primary task and all subtasks have finished executing the coordination + * command line. The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine?: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the task runs. If the pool that will run this task - * has containerConfiguration set, this must be set as well. If the pool that - * will run this task doesn't have containerConfiguration set, this must not - * be set. When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) - * are mapped into the container, all task environment variables are mapped - * into the container, and the task command line is executed in the - * container. + * The settings for the container under which the task runs. If the pool that will run this task + * has containerConfiguration set, this must be set as well. If the pool that will run this task + * doesn't have containerConfiguration set, this must not be set. When this is specified, all + * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories + * on the node) are mapped into the container, all task environment variables are mapped into the + * container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * For multi-instance tasks, the resource files will only be downloaded to - * the compute node on which the primary task is executed. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. + * A list of files that the Batch service will download to the compute node before running the + * command line. For multi-instance tasks, the resource files will only be downloaded to the + * compute node on which the primary task is executed. There is a maximum size for the list of + * resource files. When the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be + * reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. */ resourceFiles?: ResourceFile[]; /** - * @member {OutputFile[]} [outputFiles] A list of files that the Batch - * service will upload from the compute node after running the command line. - * For multi-instance tasks, the files will only be uploaded from the compute - * node on which the primary task is executed. + * A list of files that the Batch service will upload from the compute node after running the + * command line. For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. */ outputFiles?: OutputFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the task. + * A list of environment variable settings for the task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {AffinityInformation} [affinityInfo] A locality hint that can be - * used by the Batch service to select a compute node on which to start the - * new task. + * A locality hint that can be used by the Batch service to select a compute node on which to + * start the new task. */ affinityInfo?: AffinityInformation; /** - * @member {TaskConstraints} [constraints] The execution constraints that - * apply to this task. + * The execution constraints that apply to this task. */ constraints?: TaskConstraints; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * task runs. If omitted, the task runs as a non-administrative user unique - * to the task. + * The user identity under which the task runs. If omitted, the task runs as a non-administrative + * user unique to the task. */ userIdentity?: UserIdentity; /** - * @member {TaskExecutionInformation} [executionInfo] Information about the - * execution of the task. + * Information about the execution of the task. */ executionInfo?: TaskExecutionInformation; /** - * @member {ComputeNodeInformation} [nodeInfo] Information about the compute - * node on which the task ran. + * Information about the compute node on which the task ran. */ nodeInfo?: ComputeNodeInformation; /** - * @member {MultiInstanceSettings} [multiInstanceSettings] An object that - * indicates that the task is a multi-instance task, and contains information + * An object that indicates that the task is a multi-instance task, and contains information * about how to run the multi-instance task. */ multiInstanceSettings?: MultiInstanceSettings; /** - * @member {TaskStatistics} [stats] Resource usage statistics for the task. + * Resource usage statistics for the task. */ stats?: TaskStatistics; /** - * @member {TaskDependencies} [dependsOn] The tasks that this task depends - * on. This task will not be scheduled until all tasks that it depends on - * have completed successfully. If any of those tasks fail and exhaust their - * retry counts, this task will never be scheduled. + * The tasks that this task depends on. This task will not be scheduled until all tasks that it + * depends on have completed successfully. If any of those tasks fail and exhaust their retry + * counts, this task will never be scheduled. */ dependsOn?: TaskDependencies; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] A - * list of application packages that the Batch service will deploy to the - * compute node before running the command line. Application packages are - * downloaded and deployed to a shared directory, not the task working - * directory. Therefore, if a referenced package is already on the compute - * node, and is up to date, then it is not re-downloaded; the existing copy - * on the compute node is used. If a referenced application package cannot be - * installed, for example because the package has been deleted or because - * download failed, the task fails. + * A list of application packages that the Batch service will deploy to the compute node before + * running the command line. Application packages are downloaded and deployed to a shared + * directory, not the task working directory. Therefore, if a referenced package is already on + * the compute node, and is up to date, then it is not re-downloaded; the existing copy on the + * compute node is used. If a referenced application package cannot be installed, for example + * because the package has been deleted or because download failed, the task fails. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {AuthenticationTokenSettings} [authenticationTokenSettings] The - * settings for an authentication token that the task can use to perform - * Batch service operations. If this property is set, the Batch service - * provides the task with an authentication token which can be used to - * authenticate Batch service operations without requiring an account access - * key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN - * environment variable. The operations that the task can carry out using the - * token depend on the settings. For example, a task can request job - * permissions in order to add other tasks to the job, or check the status of - * the job or of other tasks under the job. + * The settings for an authentication token that the task can use to perform Batch service + * operations. If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. */ authenticationTokenSettings?: AuthenticationTokenSettings; } /** - * @interface - * An interface representing TaskAddParameter. + * Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of + * recovery operations include (but are not limited to) when an unhealthy compute node is rebooted + * or a compute node disappeared due to host failure. Retries due to recovery operations are + * independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount + * is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should + * be idempotent. This means tasks need to tolerate being interrupted and restarted without causing + * any corruption or duplicate data. The best practice for long running tasks is to use some form + * of checkpointing. * @summary An Azure Batch task to add. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * */ export interface TaskAddParameter { /** - * @member {string} id A string that uniquely identifies the task within the - * job. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two IDs within a job that differ only by case). + * A string that uniquely identifies the task within the job. The ID can contain any combination + * of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 + * characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs + * within a job that differ only by case). */ id: string; /** - * @member {string} [displayName] A display name for the task. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. + * A display name for the task. The display name need not be unique and can contain any Unicode + * characters up to a maximum length of 1024. */ displayName?: string; /** - * @member {string} commandLine The command line of the task. For - * multi-instance tasks, the command line is executed as the primary task, - * after the primary task and all subtasks have finished executing the - * coordination command line. The command line does not run under a shell, - * and therefore cannot take advantage of shell features such as environment - * variable expansion. If you want to take advantage of such features, you - * should invoke the shell in the command line, for example using "cmd /c - * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command - * line refers to file paths, it should use a relative path (relative to the - * task working directory), or use the Batch provided environment variable + * The command line of the task. For multi-instance tasks, the command line is executed as the + * primary task, after the primary task and all subtasks have finished executing the coordination + * command line. The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */ commandLine: string; /** - * @member {TaskContainerSettings} [containerSettings] The settings for the - * container under which the task runs. If the pool that will run this task - * has containerConfiguration set, this must be set as well. If the pool that - * will run this task doesn't have containerConfiguration set, this must not - * be set. When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) - * are mapped into the container, all task environment variables are mapped - * into the container, and the task command line is executed in the - * container. + * The settings for the container under which the task runs. If the pool that will run this task + * has containerConfiguration set, this must be set as well. If the pool that will run this task + * doesn't have containerConfiguration set, this must not be set. When this is specified, all + * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories + * on the node) are mapped into the container, all task environment variables are mapped into the + * container, and the task command line is executed in the container. */ containerSettings?: TaskContainerSettings; /** - * @member {ExitConditions} [exitConditions] How the Batch service should - * respond when the task completes. + * How the Batch service should respond when the task completes. */ exitConditions?: ExitConditions; /** - * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch - * service will download to the compute node before running the command line. - * For multi-instance tasks, the resource files will only be downloaded to - * the compute node on which the primary task is executed. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. + * A list of files that the Batch service will download to the compute node before running the + * command line. For multi-instance tasks, the resource files will only be downloaded to the + * compute node on which the primary task is executed. There is a maximum size for the list of + * resource files. When the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be + * reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. */ resourceFiles?: ResourceFile[]; /** - * @member {OutputFile[]} [outputFiles] A list of files that the Batch - * service will upload from the compute node after running the command line. - * For multi-instance tasks, the files will only be uploaded from the compute - * node on which the primary task is executed. + * A list of files that the Batch service will upload from the compute node after running the + * command line. For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. */ outputFiles?: OutputFile[]; /** - * @member {EnvironmentSetting[]} [environmentSettings] A list of environment - * variable settings for the task. + * A list of environment variable settings for the task. */ environmentSettings?: EnvironmentSetting[]; /** - * @member {AffinityInformation} [affinityInfo] A locality hint that can be - * used by the Batch service to select a compute node on which to start the - * new task. + * A locality hint that can be used by the Batch service to select a compute node on which to + * start the new task. */ affinityInfo?: AffinityInformation; /** - * @member {TaskConstraints} [constraints] The execution constraints that - * apply to this task. If you do not specify constraints, the - * maxTaskRetryCount is the maxTaskRetryCount specified for the job, and the - * maxWallClockTime and retentionTime are infinite. + * The execution constraints that apply to this task. If you do not specify constraints, the + * maxTaskRetryCount is the maxTaskRetryCount specified for the job, the maxWallClockTime is + * infinite, and the retentionTime is 7 days. */ constraints?: TaskConstraints; /** - * @member {UserIdentity} [userIdentity] The user identity under which the - * task runs. If omitted, the task runs as a non-administrative user unique - * to the task. + * The user identity under which the task runs. If omitted, the task runs as a non-administrative + * user unique to the task. */ userIdentity?: UserIdentity; /** - * @member {MultiInstanceSettings} [multiInstanceSettings] An object that - * indicates that the task is a multi-instance task, and contains information + * An object that indicates that the task is a multi-instance task, and contains information * about how to run the multi-instance task. */ multiInstanceSettings?: MultiInstanceSettings; /** - * @member {TaskDependencies} [dependsOn] The tasks that this task depends - * on. This task will not be scheduled until all tasks that it depends on - * have completed successfully. If any of those tasks fail and exhaust their - * retry counts, this task will never be scheduled. If the job does not have - * usesTaskDependencies set to true, and this element is present, the request - * fails with error code TaskDependenciesNotSpecifiedOnJob. + * The tasks that this task depends on. This task will not be scheduled until all tasks that it + * depends on have completed successfully. If any of those tasks fail and exhaust their retry + * counts, this task will never be scheduled. If the job does not have usesTaskDependencies set + * to true, and this element is present, the request fails with error code + * TaskDependenciesNotSpecifiedOnJob. */ dependsOn?: TaskDependencies; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] A - * list of application packages that the Batch service will deploy to the - * compute node before running the command line. Application packages are - * downloaded and deployed to a shared directory, not the task working - * directory. Therefore, if a referenced package is already on the compute - * node, and is up to date, then it is not re-downloaded; the existing copy - * on the compute node is used. If a referenced application package cannot be - * installed, for example because the package has been deleted or because - * download failed, the task fails. + * A list of application packages that the Batch service will deploy to the compute node before + * running the command line. Application packages are downloaded and deployed to a shared + * directory, not the task working directory. Therefore, if a referenced package is already on + * the compute node, and is up to date, then it is not re-downloaded; the existing copy on the + * compute node is used. If a referenced application package cannot be installed, for example + * because the package has been deleted or because download failed, the task fails. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {AuthenticationTokenSettings} [authenticationTokenSettings] The - * settings for an authentication token that the task can use to perform - * Batch service operations. If this property is set, the Batch service - * provides the task with an authentication token which can be used to - * authenticate Batch service operations without requiring an account access - * key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN - * environment variable. The operations that the task can carry out using the - * token depend on the settings. For example, a task can request job - * permissions in order to add other tasks to the job, or check the status of - * the job or of other tasks under the job. + * The settings for an authentication token that the task can use to perform Batch service + * operations. If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. */ authenticationTokenSettings?: AuthenticationTokenSettings; } /** - * @interface * An interface representing TaskAddCollectionParameter. * @summary A collection of Azure Batch tasks to add. - * */ export interface TaskAddCollectionParameter { /** - * @member {TaskAddParameter[]} value The collection of tasks to add. The - * maximum count of tasks is 100. The total serialized size of this - * collection must be less than 1MB. If it is greater than 1MB (for example - * if each task has 100's of resource files or environment variables), the - * request will fail with code 'RequestBodyTooLarge' and should be retried - * again with fewer tasks. + * The collection of tasks to add. The maximum count of tasks is 100. The total serialized size + * of this collection must be less than 1MB. If it is greater than 1MB (for example if each task + * has 100's of resource files or environment variables), the request will fail with code + * 'RequestBodyTooLarge' and should be retried again with fewer tasks. */ value: TaskAddParameter[]; } /** - * @interface * An interface representing ErrorMessage. * @summary An error message received in an Azure Batch error response. - * */ export interface ErrorMessage { /** - * @member {string} [lang] The language code of the error message. + * The language code of the error message. */ lang?: string; /** - * @member {string} [value] The text of the message. + * The text of the message. */ value?: string; } /** - * @interface * An interface representing BatchErrorDetail. - * @summary An item of additional information included in an Azure Batch error - * response. - * + * @summary An item of additional information included in an Azure Batch error response. */ export interface BatchErrorDetail { /** - * @member {string} [key] An identifier specifying the meaning of the Value - * property. + * An identifier specifying the meaning of the Value property. */ key?: string; /** - * @member {string} [value] The additional information included with the - * error response. + * The additional information included with the error response. */ value?: string; } /** - * @interface * An interface representing BatchError. * @summary An error response received from the Azure Batch service. - * */ export interface BatchError { /** - * @member {string} [code] An identifier for the error. Codes are invariant - * and are intended to be consumed programmatically. + * An identifier for the error. Codes are invariant and are intended to be consumed + * programmatically. */ code?: string; /** - * @member {ErrorMessage} [message] A message describing the error, intended - * to be suitable for display in a user interface. + * A message describing the error, intended to be suitable for display in a user interface. */ message?: ErrorMessage; /** - * @member {BatchErrorDetail[]} [values] A collection of key-value pairs - * containing additional details about the error. + * A collection of key-value pairs containing additional details about the error. */ values?: BatchErrorDetail[]; } /** - * @interface * An interface representing TaskAddResult. - * @summary Result for a single task added as part of an add task collection - * operation. - * + * @summary Result for a single task added as part of an add task collection operation. */ export interface TaskAddResult { /** - * @member {TaskAddStatus} status The status of the add task request. - * Possible values include: 'success', 'clientError', 'serverError' + * The status of the add task request. Possible values include: 'success', 'clientError', + * 'serverError' */ status: TaskAddStatus; /** - * @member {string} taskId The ID of the task for which this is the result. + * The ID of the task for which this is the result. */ taskId: string; /** - * @member {string} [eTag] The ETag of the task, if the task was successfully - * added. You can use this to detect whether the task has changed between - * requests. In particular, you can be pass the ETag with an Update Task - * request to specify that your changes should take effect only if nobody - * else has modified the job in the meantime. + * The ETag of the task, if the task was successfully added. You can use this to detect whether + * the task has changed between requests. In particular, you can be pass the ETag with an Update + * Task request to specify that your changes should take effect only if nobody else has modified + * the job in the meantime. */ eTag?: string; /** - * @member {Date} [lastModified] The last modified time of the task. + * The last modified time of the task. */ lastModified?: Date; /** - * @member {string} [location] The URL of the task, if the task was - * successfully added. + * The URL of the task, if the task was successfully added. */ location?: string; /** - * @member {BatchError} [error] The error encountered while attempting to add - * the task. + * The error encountered while attempting to add the task. */ error?: BatchError; } /** - * @interface * An interface representing TaskAddCollectionResult. * @summary The result of adding a collection of tasks to a job. - * */ export interface TaskAddCollectionResult { /** - * @member {TaskAddResult[]} [value] The results of the add task collection - * operation. + * The results of the add task collection operation. */ value?: TaskAddResult[]; } /** - * @interface * An interface representing SubtaskInformation. * @summary Information about an Azure Batch subtask. - * */ export interface SubtaskInformation { /** - * @member {number} [id] The ID of the subtask. + * The ID of the subtask. */ id?: number; /** - * @member {ComputeNodeInformation} [nodeInfo] Information about the compute - * node on which the subtask ran. + * Information about the compute node on which the subtask ran. */ nodeInfo?: ComputeNodeInformation; /** - * @member {Date} [startTime] The time at which the subtask started running. - * If the subtask has been restarted or retried, this is the most recent time - * at which the subtask started running. + * The time at which the subtask started running. If the subtask has been restarted or retried, + * this is the most recent time at which the subtask started running. */ startTime?: Date; /** - * @member {Date} [endTime] The time at which the subtask completed. This - * property is set only if the subtask is in the Completed state. + * The time at which the subtask completed. This property is set only if the subtask is in the + * Completed state. */ endTime?: Date; /** - * @member {number} [exitCode] The exit code of the program specified on the - * subtask command line. This property is set only if the subtask is in the - * completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the subtask (due to - * timeout, or user termination via the API) you may see an operating - * system-defined exit code. + * The exit code of the program specified on the subtask command line. This property is set only + * if the subtask is in the completed state. In general, the exit code for a process reflects the + * specific convention implemented by the application developer for that process. If you use the + * exit code value to make decisions in your code, be sure that you know the exit code convention + * used by the application process. However, if the Batch service terminates the subtask (due to + * timeout, or user termination via the API) you may see an operating system-defined exit code. */ exitCode?: number; /** - * @member {TaskContainerExecutionInformation} [containerInfo] Information - * about the container under which the task is executing. This property is - * set only if the task runs in a container context. + * Information about the container under which the task is executing. This property is set only + * if the task runs in a container context. */ containerInfo?: TaskContainerExecutionInformation; /** - * @member {TaskFailureInformation} [failureInfo] Information describing the - * task failure, if any. This property is set only if the task is in the - * completed state and encountered a failure. + * Information describing the task failure, if any. This property is set only if the task is in + * the completed state and encountered a failure. */ failureInfo?: TaskFailureInformation; /** - * @member {SubtaskState} [state] The current state of the subtask. Possible - * values include: 'preparing', 'running', 'completed' + * The current state of the subtask. Possible values include: 'preparing', 'running', 'completed' */ state?: SubtaskState; /** - * @member {Date} [stateTransitionTime] The time at which the subtask entered - * its current state. + * The time at which the subtask entered its current state. */ stateTransitionTime?: Date; /** - * @member {SubtaskState} [previousState] The previous state of the subtask. - * This property is not set if the subtask is in its initial running state. - * Possible values include: 'preparing', 'running', 'completed' + * The previous state of the subtask. This property is not set if the subtask is in its initial + * running state. Possible values include: 'preparing', 'running', 'completed' */ previousState?: SubtaskState; /** - * @member {Date} [previousStateTransitionTime] The time at which the subtask - * entered its previous state. This property is not set if the subtask is in - * its initial running state. + * The time at which the subtask entered its previous state. This property is not set if the + * subtask is in its initial running state. */ previousStateTransitionTime?: Date; /** - * @member {TaskExecutionResult} [result] The result of the task execution. - * If the value is 'failed', then the details of the failure can be found in - * the failureInfo property. Possible values include: 'success', 'failure' + * The result of the task execution. If the value is 'failed', then the details of the failure + * can be found in the failureInfo property. Possible values include: 'success', 'failure' */ result?: TaskExecutionResult; } /** - * @interface * An interface representing CloudTaskListSubtasksResult. * @summary The result of listing the subtasks of a task. - * */ export interface CloudTaskListSubtasksResult { /** - * @member {SubtaskInformation[]} [value] The list of subtasks. + * The list of subtasks. */ value?: SubtaskInformation[]; } /** - * @interface * An interface representing TaskInformation. * @summary Information about a task running on a compute node. - * */ export interface TaskInformation { /** - * @member {string} [taskUrl] The URL of the task. + * The URL of the task. */ taskUrl?: string; /** - * @member {string} [jobId] The ID of the job to which the task belongs. + * The ID of the job to which the task belongs. */ jobId?: string; /** - * @member {string} [taskId] The ID of the task. + * The ID of the task. */ taskId?: string; /** - * @member {number} [subtaskId] The ID of the subtask if the task is a - * multi-instance task. + * The ID of the subtask if the task is a multi-instance task. */ subtaskId?: number; /** - * @member {TaskState} taskState The current state of the task. Possible - * values include: 'active', 'preparing', 'running', 'completed' + * The current state of the task. Possible values include: 'active', 'preparing', 'running', + * 'completed' */ taskState: TaskState; /** - * @member {TaskExecutionInformation} [executionInfo] Information about the - * execution of the task. + * Information about the execution of the task. */ executionInfo?: TaskExecutionInformation; } /** - * @interface * An interface representing StartTaskInformation. * @summary Information about a start task running on a compute node. - * */ export interface StartTaskInformation { /** - * @member {StartTaskState} state The state of the start task on the compute - * node. Possible values include: 'running', 'completed' + * The state of the start task on the compute node. Possible values include: 'running', + * 'completed' */ state: StartTaskState; /** - * @member {Date} startTime The time at which the start task started running. - * This value is reset every time the task is restarted or retried (that is, - * this is the most recent time at which the start task started running). + * The time at which the start task started running. This value is reset every time the task is + * restarted or retried (that is, this is the most recent time at which the start task started + * running). */ startTime: Date; /** - * @member {Date} [endTime] The time at which the start task stopped running. - * This is the end time of the most recent run of the start task, if that run - * has completed (even if that run failed and a retry is pending). This - * element is not present if the start task is currently running. + * The time at which the start task stopped running. This is the end time of the most recent run + * of the start task, if that run has completed (even if that run failed and a retry is pending). + * This element is not present if the start task is currently running. */ endTime?: Date; /** - * @member {number} [exitCode] The exit code of the program specified on the - * start task command line. This property is set only if the start task is in - * the completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the start task (due to - * timeout, or user termination via the API) you may see an operating + * The exit code of the program specified on the start task command line. This property is set + * only if the start task is in the completed state. In general, the exit code for a process + * reflects the specific convention implemented by the application developer for that process. If + * you use the exit code value to make decisions in your code, be sure that you know the exit + * code convention used by the application process. However, if the Batch service terminates the + * start task (due to timeout, or user termination via the API) you may see an operating * system-defined exit code. */ exitCode?: number; /** - * @member {TaskContainerExecutionInformation} [containerInfo] Information - * about the container under which the task is executing. This property is - * set only if the task runs in a container context. + * Information about the container under which the task is executing. This property is set only + * if the task runs in a container context. */ containerInfo?: TaskContainerExecutionInformation; /** - * @member {TaskFailureInformation} [failureInfo] Information describing the - * task failure, if any. This property is set only if the task is in the - * completed state and encountered a failure. + * Information describing the task failure, if any. This property is set only if the task is in + * the completed state and encountered a failure. */ failureInfo?: TaskFailureInformation; /** - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. + * The number of times the task has been retried by the Batch service. Task application failures + * (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file + * upload errors are not retried. The Batch service will retry the task up to the limit specified + * by the constraints. */ retryCount: number; /** - * @member {Date} [lastRetryTime] The most recent time at which a retry of - * the task started running. This element is present only if the task was - * retried (i.e. retryCount is nonzero). If present, this is typically the - * same as startTime, but may be different if the task has been restarted for - * reasons other than retry; for example, if the compute node was rebooted - * during a retry, then the startTime is updated but the lastRetryTime is - * not. + * The most recent time at which a retry of the task started running. This element is present + * only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the + * same as startTime, but may be different if the task has been restarted for reasons other than + * retry; for example, if the compute node was rebooted during a retry, then the startTime is + * updated but the lastRetryTime is not. */ lastRetryTime?: Date; /** - * @member {TaskExecutionResult} [result] The result of the task execution. - * If the value is 'failed', then the details of the failure can be found in - * the failureInfo property. Possible values include: 'success', 'failure' + * The result of the task execution. If the value is 'failed', then the details of the failure + * can be found in the failureInfo property. Possible values include: 'success', 'failure' */ result?: TaskExecutionResult; } /** - * @interface * An interface representing ComputeNodeError. * @summary An error encountered by a compute node. - * */ export interface ComputeNodeError { /** - * @member {string} [code] An identifier for the compute node error. Codes - * are invariant and are intended to be consumed programmatically. + * An identifier for the compute node error. Codes are invariant and are intended to be consumed + * programmatically. */ code?: string; /** - * @member {string} [message] A message describing the compute node error, - * intended to be suitable for display in a user interface. + * A message describing the compute node error, intended to be suitable for display in a user + * interface. */ message?: string; /** - * @member {NameValuePair[]} [errorDetails] The list of additional error - * details related to the compute node error. + * The list of additional error details related to the compute node error. */ errorDetails?: NameValuePair[]; } /** - * @interface * An interface representing InboundEndpoint. * @summary An inbound endpoint on a compute node. - * */ export interface InboundEndpoint { /** - * @member {string} name The name of the endpoint. + * The name of the endpoint. */ name: string; /** - * @member {InboundEndpointProtocol} protocol The protocol of the endpoint. - * Possible values include: 'tcp', 'udp' + * The protocol of the endpoint. Possible values include: 'tcp', 'udp' */ protocol: InboundEndpointProtocol; /** - * @member {string} publicIPAddress The public IP address of the compute - * node. + * The public IP address of the compute node. */ publicIPAddress: string; /** - * @member {string} publicFQDN The public fully qualified domain name for the - * compute node. + * The public fully qualified domain name for the compute node. */ publicFQDN: string; /** - * @member {number} frontendPort The public port number of the endpoint. + * The public port number of the endpoint. */ frontendPort: number; /** - * @member {number} backendPort The backend port number of the endpoint. + * The backend port number of the endpoint. */ backendPort: number; } /** - * @interface * An interface representing ComputeNodeEndpointConfiguration. * @summary The endpoint configuration for the compute node. - * */ export interface ComputeNodeEndpointConfiguration { /** - * @member {InboundEndpoint[]} inboundEndpoints The list of inbound endpoints - * that are accessible on the compute node. + * The list of inbound endpoints that are accessible on the compute node. */ inboundEndpoints: InboundEndpoint[]; } /** - * @interface * An interface representing ComputeNode. * @summary A compute node in the Batch service. - * */ export interface ComputeNode { /** - * @member {string} [id] The ID of the compute node. Every node that is added - * to a pool is assigned a unique ID. Whenever a node is removed from a pool, - * all of its local files are deleted, and the ID is reclaimed and could be - * reused for new nodes. + * The ID of the compute node. Every node that is added to a pool is assigned a unique ID. + * Whenever a node is removed from a pool, all of its local files are deleted, and the ID is + * reclaimed and could be reused for new nodes. */ id?: string; /** - * @member {string} [url] The URL of the compute node. + * The URL of the compute node. */ url?: string; /** - * @member {ComputeNodeState} [state] The current state of the compute node. - * The low-priority node has been preempted. Tasks which were running on the - * node when it was pre-empted will be rescheduled when another node becomes - * available. Possible values include: 'idle', 'rebooting', 'reimaging', - * 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', - * 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted' + * The current state of the compute node. The low-priority node has been preempted. Tasks which + * were running on the node when it was preempted will be rescheduled when another node becomes + * available. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', + * 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', + * 'offline', 'preempted' */ state?: ComputeNodeState; /** - * @member {SchedulingState} [schedulingState] Whether the compute node is - * available for task scheduling. Possible values include: 'enabled', + * Whether the compute node is available for task scheduling. Possible values include: 'enabled', * 'disabled' */ schedulingState?: SchedulingState; /** - * @member {Date} [stateTransitionTime] The time at which the compute node - * entered its current state. + * The time at which the compute node entered its current state. */ stateTransitionTime?: Date; /** - * @member {Date} [lastBootTime] The time at which the compute node was - * started. This property may not be present if the node state is unusable. + * The last time at which the compute node was started. This property may not be present if the + * node state is unusable. */ lastBootTime?: Date; /** - * @member {Date} [allocationTime] The time at which this compute node was - * allocated to the pool. + * The time at which this compute node was allocated to the pool. This is the time when the node + * was initially allocated and doesn't change once set. It is not updated when the node is + * service healed or preempted. */ allocationTime?: Date; /** - * @member {string} [ipAddress] The IP address that other compute nodes can - * use to communicate with this compute node. Every node that is added to a - * pool is assigned a unique IP address. Whenever a node is removed from a - * pool, all of its local files are deleted, and the IP address is reclaimed - * and could be reused for new nodes. + * The IP address that other compute nodes can use to communicate with this compute node. Every + * node that is added to a pool is assigned a unique IP address. Whenever a node is removed from + * a pool, all of its local files are deleted, and the IP address is reclaimed and could be + * reused for new nodes. */ ipAddress?: string; /** - * @member {string} [affinityId] An identifier which can be passed when - * adding a task to request that the task be scheduled on this node. Note - * that this is just a soft affinity. If the target node is busy or - * unavailable at the time the task is scheduled, then the task will be - * scheduled elsewhere. + * An identifier which can be passed when adding a task to request that the task be scheduled on + * this node. Note that this is just a soft affinity. If the target node is busy or unavailable + * at the time the task is scheduled, then the task will be scheduled elsewhere. */ affinityId?: string; /** - * @member {string} [vmSize] The size of the virtual machine hosting the - * compute node. For information about available sizes of virtual machines in - * pools, see Choose a VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + * The size of the virtual machine hosting the compute node. For information about available + * sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch + * pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */ vmSize?: string; /** - * @member {number} [totalTasksRun] The total number of job tasks completed - * on the compute node. This includes Job Manager tasks and normal tasks, but - * not Job Preparation, Job Release or Start tasks. + * The total number of job tasks completed on the compute node. This includes Job Manager tasks + * and normal tasks, but not Job Preparation, Job Release or Start tasks. */ totalTasksRun?: number; /** - * @member {number} [runningTasksCount] The total number of currently running - * job tasks on the compute node. This includes Job Manager tasks and normal - * tasks, but not Job Preparation, Job Release or Start tasks. + * The total number of currently running job tasks on the compute node. This includes Job Manager + * tasks and normal tasks, but not Job Preparation, Job Release or Start tasks. */ runningTasksCount?: number; /** - * @member {number} [totalTasksSucceeded] The total number of job tasks which - * completed successfully (with exitCode 0) on the compute node. This - * includes Job Manager tasks and normal tasks, but not Job Preparation, Job - * Release or Start tasks. + * The total number of job tasks which completed successfully (with exitCode 0) on the compute + * node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release + * or Start tasks. */ totalTasksSucceeded?: number; /** - * @member {TaskInformation[]} [recentTasks] A list of tasks whose state has - * recently changed. This property is present only if at least one task has - * run on this node since it was assigned to the pool. + * A list of tasks whose state has recently changed. This property is present only if at least + * one task has run on this node since it was assigned to the pool. */ recentTasks?: TaskInformation[]; /** - * @member {StartTask} [startTask] The task specified to run on the compute - * node as it joins the pool. + * The task specified to run on the compute node as it joins the pool. */ startTask?: StartTask; /** - * @member {StartTaskInformation} [startTaskInfo] Runtime information about - * the execution of the start task on the compute node. + * Runtime information about the execution of the start task on the compute node. */ startTaskInfo?: StartTaskInformation; /** - * @member {CertificateReference[]} [certificateReferences] The list of - * certificates installed on the compute node. For Windows compute nodes, the - * Batch service installs the certificates to the specified certificate store - * and location. For Linux compute nodes, the certificates are stored in a - * directory inside the task working directory and an environment variable - * AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - * location. For certificates with visibility of 'remoteUser', a 'certs' - * directory is created in the user's home directory (e.g., - * /home/{user-name}/certs) and certificates are placed in that directory. + * The list of certificates installed on the compute node. For Windows compute nodes, the Batch + * service installs the certificates to the specified certificate store and location. For Linux + * compute nodes, the certificates are stored in a directory inside the task working directory + * and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for + * this location. For certificates with visibility of 'remoteUser', a 'certs' directory is + * created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are + * placed in that directory. */ certificateReferences?: CertificateReference[]; /** - * @member {ComputeNodeError[]} [errors] The list of errors that are - * currently being encountered by the compute node. + * The list of errors that are currently being encountered by the compute node. */ errors?: ComputeNodeError[]; /** - * @member {boolean} [isDedicated] Whether this compute node is a dedicated - * node. If false, the node is a low-priority node. + * Whether this compute node is a dedicated node. If false, the node is a low-priority node. */ isDedicated?: boolean; /** - * @member {ComputeNodeEndpointConfiguration} [endpointConfiguration] The - * endpoint configuration for the compute node. + * The endpoint configuration for the compute node. */ endpointConfiguration?: ComputeNodeEndpointConfiguration; /** - * @member {NodeAgentInformation} [nodeAgentInfo] Information about the node - * agent version and the time the node upgraded to a new version. + * Information about the node agent version and the time the node upgraded to a new version. */ nodeAgentInfo?: NodeAgentInformation; } /** - * @interface * An interface representing ComputeNodeUser. * @summary A user account for RDP or SSH access on a compute node. - * */ export interface ComputeNodeUser { /** - * @member {string} name The user name of the account. + * The user name of the account. */ name: string; /** - * @member {boolean} [isAdmin] Whether the account should be an administrator - * on the compute node. The default value is false. + * Whether the account should be an administrator on the compute node. The default value is + * false. */ isAdmin?: boolean; /** - * @member {Date} [expiryTime] The time at which the account should expire. - * If omitted, the default is 1 day from the current time. For Linux compute - * nodes, the expiryTime has a precision up to a day. + * The time at which the account should expire. If omitted, the default is 1 day from the current + * time. For Linux compute nodes, the expiryTime has a precision up to a day. */ expiryTime?: Date; /** - * @member {string} [password] The password of the account. The password is - * required for Windows nodes (those created with - * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' - * using a Windows image reference). For Linux compute nodes, the password - * can optionally be specified along with the sshPublicKey property. + * The password of the account. The password is required for Windows nodes (those created with + * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows + * image reference). For Linux compute nodes, the password can optionally be specified along with + * the sshPublicKey property. */ password?: string; /** - * @member {string} [sshPublicKey] The SSH public key that can be used for - * remote login to the compute node. The public key should be compatible with - * OpenSSH encoding and should be base 64 encoded. This property can be - * specified only for Linux nodes. If this is specified for a Windows node, - * then the Batch service rejects the request; if you are calling the REST - * API directly, the HTTP status code is 400 (Bad Request). + * The SSH public key that can be used for remote login to the compute node. The public key + * should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be + * specified only for Linux nodes. If this is specified for a Windows node, then the Batch + * service rejects the request; if you are calling the REST API directly, the HTTP status code is + * 400 (Bad Request). */ sshPublicKey?: string; } /** - * @interface * An interface representing ComputeNodeGetRemoteLoginSettingsResult. * @summary The remote login settings for a compute node. - * */ export interface ComputeNodeGetRemoteLoginSettingsResult { /** - * @member {string} remoteLoginIPAddress The IP address used for remote login - * to the compute node. + * The IP address used for remote login to the compute node. */ remoteLoginIPAddress: string; /** - * @member {number} remoteLoginPort The port used for remote login to the - * compute node. + * The port used for remote login to the compute node. */ remoteLoginPort: number; } /** - * @interface * An interface representing JobSchedulePatchParameter. * @summary The set of changes to be made to a job schedule. - * */ export interface JobSchedulePatchParameter { /** - * @member {Schedule} [schedule] The schedule according to which jobs will be - * created. If you do not specify this element, the existing schedule is left - * unchanged. + * The schedule according to which jobs will be created. If you do not specify this element, the + * existing schedule is left unchanged. */ schedule?: Schedule; /** - * @member {JobSpecification} [jobSpecification] The details of the jobs to - * be created on this schedule. Updates affect only jobs that are started - * after the update has taken place. Any currently active job continues with - * the older specification. + * The details of the jobs to be created on this schedule. Updates affect only jobs that are + * started after the update has taken place. Any currently active job continues with the older + * specification. */ jobSpecification?: JobSpecification; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job schedule as metadata. If you do not specify this element, - * existing metadata is left unchanged. + * A list of name-value pairs associated with the job schedule as metadata. If you do not specify + * this element, existing metadata is left unchanged. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing JobScheduleUpdateParameter. * @summary The set of changes to be made to a job schedule. - * */ export interface JobScheduleUpdateParameter { /** - * @member {Schedule} schedule The schedule according to which jobs will be - * created. If you do not specify this element, it is equivalent to passing - * the default schedule: that is, a single job scheduled to run immediately. + * The schedule according to which jobs will be created. If you do not specify this element, it + * is equivalent to passing the default schedule: that is, a single job scheduled to run + * immediately. */ schedule: Schedule; /** - * @member {JobSpecification} jobSpecification Details of the jobs to be - * created on this schedule. Updates affect only jobs that are started after - * the update has taken place. Any currently active job continues with the - * older specification. + * Details of the jobs to be created on this schedule. Updates affect only jobs that are started + * after the update has taken place. Any currently active job continues with the older + * specification. */ jobSpecification: JobSpecification; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job schedule as metadata. If you do not specify this element, it - * takes the default value of an empty list; in effect, any existing metadata - * is deleted. + * A list of name-value pairs associated with the job schedule as metadata. If you do not specify + * this element, it takes the default value of an empty list; in effect, any existing metadata is + * deleted. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing JobDisableParameter. * @summary Options when disabling a job. - * */ export interface JobDisableParameter { /** - * @member {DisableJobOption} disableTasks What to do with active tasks - * associated with the job. Possible values include: 'requeue', 'terminate', - * 'wait' + * What to do with active tasks associated with the job. Possible values include: 'requeue', + * 'terminate', 'wait' */ disableTasks: DisableJobOption; } /** - * @interface * An interface representing JobTerminateParameter. * @summary Options when terminating a job. - * */ export interface JobTerminateParameter { /** - * @member {string} [terminateReason] The text you want to appear as the - * job's TerminateReason. The default is 'UserTerminate'. + * The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'. */ terminateReason?: string; } /** - * @interface * An interface representing JobPatchParameter. * @summary The set of changes to be made to a job. - * */ export interface JobPatchParameter { /** - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. If omitted, the priority of the job is left - * unchanged. + * The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the + * lowest priority and 1000 being the highest priority. If omitted, the priority of the job is + * left unchanged. */ priority?: number; /** - * @member {OnAllTasksComplete} [onAllTasksComplete] The action the Batch - * service should take when all tasks in the job are in the completed state. - * If omitted, the completion behavior is left unchanged. You may not change - * the value from terminatejob to noaction - that is, once you have engaged - * automatic job termination, you cannot turn it off again. If you try to do - * this, the request fails with an 'invalid property value' error response; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). Possible values include: 'noAction', 'terminateJob' + * The action the Batch service should take when all tasks in the job are in the completed state. + * If omitted, the completion behavior is left unchanged. You may not change the value from + * terminatejob to noaction - that is, once you have engaged automatic job termination, you + * cannot turn it off again. If you try to do this, the request fails with an 'invalid property + * value' error response; if you are calling the REST API directly, the HTTP status code is 400 + * (Bad Request). Possible values include: 'noAction', 'terminateJob' */ onAllTasksComplete?: OnAllTasksComplete; /** - * @member {JobConstraints} [constraints] The execution constraints for the - * job. If omitted, the existing execution constraints are left unchanged. + * The execution constraints for the job. If omitted, the existing execution constraints are left + * unchanged. */ constraints?: JobConstraints; /** - * @member {PoolInformation} [poolInfo] The pool on which the Batch service - * runs the job's tasks. You may change the pool for a job only when the job - * is disabled. The Patch Job call will fail if you include the poolInfo - * element and the job is not disabled. If you specify an - * autoPoolSpecification specification in the poolInfo, only the keepAlive - * property can be updated, and then only if the auto pool has a - * poolLifetimeOption of job. If omitted, the job continues to run on its - * current pool. + * The pool on which the Batch service runs the job's tasks. You may change the pool for a job + * only when the job is disabled. The Patch Job call will fail if you include the poolInfo + * element and the job is not disabled. If you specify an autoPoolSpecification specification in + * the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a + * poolLifetimeOption of job. If omitted, the job continues to run on its current pool. */ poolInfo?: PoolInformation; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job as metadata. If omitted, the existing job metadata is left - * unchanged. + * A list of name-value pairs associated with the job as metadata. If omitted, the existing job + * metadata is left unchanged. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing JobUpdateParameter. * @summary The set of changes to be made to a job. - * */ export interface JobUpdateParameter { /** - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. If omitted, it is set to the default value 0. + * The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the + * lowest priority and 1000 being the highest priority. If omitted, it is set to the default + * value 0. */ priority?: number; /** - * @member {JobConstraints} [constraints] The execution constraints for the - * job. If omitted, the constraints are cleared. + * The execution constraints for the job. If omitted, the constraints are cleared. */ constraints?: JobConstraints; /** - * @member {PoolInformation} poolInfo The pool on which the Batch service - * runs the job's tasks. You may change the pool for a job only when the job - * is disabled. The Update Job call will fail if you include the poolInfo - * element and the job is not disabled. If you specify an - * autoPoolSpecification specification in the poolInfo, only the keepAlive - * property can be updated, and then only if the auto pool has a + * The pool on which the Batch service runs the job's tasks. You may change the pool for a job + * only when the job is disabled. The Update Job call will fail if you include the poolInfo + * element and the job is not disabled. If you specify an autoPoolSpecification specification in + * the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a * poolLifetimeOption of job. */ poolInfo: PoolInformation; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the job as metadata. If omitted, it takes the default value of an - * empty list; in effect, any existing metadata is deleted. + * A list of name-value pairs associated with the job as metadata. If omitted, it takes the + * default value of an empty list; in effect, any existing metadata is deleted. */ metadata?: MetadataItem[]; /** - * @member {OnAllTasksComplete} [onAllTasksComplete] The action the Batch - * service should take when all tasks in the job are in the completed state. - * If omitted, the completion behavior is set to noaction. If the current - * value is terminatejob, this is an error because a job's completion - * behavior may not be changed from terminatejob to noaction. You may not - * change the value from terminatejob to noaction - that is, once you have - * engaged automatic job termination, you cannot turn it off again. If you - * try to do this, the request fails and Batch returns status code 400 (Bad - * Request) and an 'invalid property value' error response. If you do not - * specify this element in a PUT request, it is equivalent to passing - * noaction. This is an error if the current value is terminatejob. Possible - * values include: 'noAction', 'terminateJob' + * The action the Batch service should take when all tasks in the job are in the completed state. + * If omitted, the completion behavior is set to noaction. If the current value is terminatejob, + * this is an error because a job's completion behavior may not be changed from terminatejob to + * noaction. You may not change the value from terminatejob to noaction - that is, once you have + * engaged automatic job termination, you cannot turn it off again. If you try to do this, the + * request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' + * error response. If you do not specify this element in a PUT request, it is equivalent to + * passing noaction. This is an error if the current value is terminatejob. Possible values + * include: 'noAction', 'terminateJob' */ onAllTasksComplete?: OnAllTasksComplete; } /** - * @interface * An interface representing PoolEnableAutoScaleParameter. * @summary Options for enabling automatic scaling on a pool. - * */ export interface PoolEnableAutoScaleParameter { /** - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. The formula is checked for validity before it - * is applied to the pool. If the formula is not valid, the Batch service - * rejects the request with detailed error information. For more information - * about specifying this formula, see Automatically scale compute nodes in an - * Azure Batch pool + * The formula for the desired number of compute nodes in the pool. The formula is checked for + * validity before it is applied to the pool. If the formula is not valid, the Batch service + * rejects the request with detailed error information. For more information about specifying + * this formula, see Automatically scale compute nodes in an Azure Batch pool * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). */ autoScaleFormula?: string; /** - * @member {string} [autoScaleEvaluationInterval] The time interval at which - * to automatically adjust the pool size according to the autoscale formula. - * The default value is 15 minutes. The minimum and maximum value are 5 - * minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). If you specify a new - * interval, then the existing autoscale evaluation schedule will be stopped - * and a new autoscale evaluation schedule will be started, with its starting - * time being the time when this request was issued. + * The time interval at which to automatically adjust the pool size according to the autoscale + * formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 + * hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the + * Batch service rejects the request with an invalid property value error; if you are calling the + * REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, + * then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation + * schedule will be started, with its starting time being the time when this request was issued. */ autoScaleEvaluationInterval?: string; } /** - * @interface * An interface representing PoolEvaluateAutoScaleParameter. * @summary Options for evaluating an automatic scaling formula on a pool. - * */ export interface PoolEvaluateAutoScaleParameter { /** - * @member {string} autoScaleFormula The formula for the desired number of - * compute nodes in the pool. The formula is validated and its results - * calculated, but it is not applied to the pool. To apply the formula to the - * pool, 'Enable automatic scaling on a pool'. For more information about - * specifying this formula, see Automatically scale compute nodes in an Azure - * Batch pool + * The formula for the desired number of compute nodes in the pool. The formula is validated and + * its results calculated, but it is not applied to the pool. To apply the formula to the pool, + * 'Enable automatic scaling on a pool'. For more information about specifying this formula, see + * Automatically scale compute nodes in an Azure Batch pool * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). */ autoScaleFormula: string; } /** - * @interface * An interface representing PoolResizeParameter. * @summary Options for changing the size of a pool. - * */ export interface PoolResizeParameter { /** - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. + * The desired number of dedicated compute nodes in the pool. */ targetDedicatedNodes?: number; /** - * @member {number} [targetLowPriorityNodes] The desired number of - * low-priority compute nodes in the pool. + * The desired number of low-priority compute nodes in the pool. */ targetLowPriorityNodes?: number; /** - * @member {string} [resizeTimeout] The timeout for allocation of compute - * nodes to the pool or removal of compute nodes from the pool. The default - * value is 15 minutes. The minimum value is 5 minutes. If you specify a - * value less than 5 minutes, the Batch service returns an error; if you are - * calling the REST API directly, the HTTP status code is 400 (Bad Request). + * The timeout for allocation of compute nodes to the pool or removal of compute nodes from the + * pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value + * less than 5 minutes, the Batch service returns an error; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). */ resizeTimeout?: string; /** - * @member {ComputeNodeDeallocationOption} [nodeDeallocationOption] - * Determines what to do with a node and its running task(s) if the pool size - * is decreasing. The default value is requeue. Possible values include: - * 'requeue', 'terminate', 'taskCompletion', 'retainedData' + * Determines what to do with a node and its running task(s) if the pool size is decreasing. The + * default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', + * 'retainedData' */ nodeDeallocationOption?: ComputeNodeDeallocationOption; } /** - * @interface * An interface representing PoolUpdatePropertiesParameter. * @summary The set of changes to be made to a pool. - * */ export interface PoolUpdatePropertiesParameter { /** - * @member {StartTask} [startTask] A task to run on each compute node as it - * joins the pool. The task runs when the node is added to the pool or when - * the node is restarted. If this element is present, it overwrites any - * existing start task. If omitted, any existing start task is removed from - * the pool. + * A task to run on each compute node as it joins the pool. The task runs when the node is added + * to the pool or when the node is restarted. If this element is present, it overwrites any + * existing start task. If omitted, any existing start task is removed from the pool. */ startTask?: StartTask; /** - * @member {CertificateReference[]} certificateReferences A list of - * certificates to be installed on each compute node in the pool. This list - * replaces any existing certificate references configured on the pool. If - * you specify an empty collection, any existing certificate references are - * removed from the pool. For Windows compute nodes, the Batch service - * installs the certificates to the specified certificate store and location. - * For Linux compute nodes, the certificates are stored in a directory inside - * the task working directory and an environment variable - * AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - * location. For certificates with visibility of 'remoteUser', a 'certs' - * directory is created in the user's home directory (e.g., - * /home/{user-name}/certs) and certificates are placed in that directory. + * A list of certificates to be installed on each compute node in the pool. This list replaces + * any existing certificate references configured on the pool. If you specify an empty + * collection, any existing certificate references are removed from the pool. For Windows compute + * nodes, the Batch service installs the certificates to the specified certificate store and + * location. For Linux compute nodes, the certificates are stored in a directory inside the task + * working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the + * task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' + * directory is created in the user's home directory (e.g., /home/{user-name}/certs) and + * certificates are placed in that directory. */ certificateReferences: CertificateReference[]; /** - * @member {ApplicationPackageReference[]} applicationPackageReferences A - * list of application packages to be installed on each compute node in the - * pool. The list replaces any existing application package references on the - * pool. Changes to application package references affect all new compute - * nodes joining the pool, but do not affect compute nodes that are already - * in the pool until they are rebooted or reimaged. If omitted, or if you - * specify an empty collection, any existing application packages references - * are removed from the pool. + * The list of application packages to be installed on each compute node in the pool. The list + * replaces any existing application package references on the pool. Changes to application + * package references affect all new compute nodes joining the pool, but do not affect compute + * nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of + * 10 application package references on any given pool. If omitted, or if you specify an empty + * collection, any existing application packages references are removed from the pool. */ applicationPackageReferences: ApplicationPackageReference[]; /** - * @member {MetadataItem[]} metadata A list of name-value pairs associated - * with the pool as metadata. This list replaces any existing metadata - * configured on the pool. If omitted, or if you specify an empty collection, + * A list of name-value pairs associated with the pool as metadata. This list replaces any + * existing metadata configured on the pool. If omitted, or if you specify an empty collection, * any existing metadata is removed from the pool. */ metadata: MetadataItem[]; } /** - * @interface - * An interface representing PoolUpgradeOSParameter. - * @summary Options for upgrading the operating system of compute nodes in a - * pool. - * - */ -export interface PoolUpgradeOSParameter { - /** - * @member {string} targetOSVersion The Azure Guest OS version to be - * installed on the virtual machines in the pool. - */ - targetOSVersion: string; -} - -/** - * @interface * An interface representing PoolPatchParameter. * @summary The set of changes to be made to a pool. - * */ export interface PoolPatchParameter { /** - * @member {StartTask} [startTask] A task to run on each compute node as it - * joins the pool. The task runs when the node is added to the pool or when - * the node is restarted. If this element is present, it overwrites any - * existing start task. If omitted, any existing start task is left - * unchanged. + * A task to run on each compute node as it joins the pool. The task runs when the node is added + * to the pool or when the node is restarted. If this element is present, it overwrites any + * existing start task. If omitted, any existing start task is left unchanged. */ startTask?: StartTask; /** - * @member {CertificateReference[]} [certificateReferences] A list of - * certificates to be installed on each compute node in the pool. If this - * element is present, it replaces any existing certificate references - * configured on the pool. If omitted, any existing certificate references - * are left unchanged. For Windows compute nodes, the Batch service installs - * the certificates to the specified certificate store and location. For - * Linux compute nodes, the certificates are stored in a directory inside the - * task working directory and an environment variable - * AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - * location. For certificates with visibility of 'remoteUser', a 'certs' - * directory is created in the user's home directory (e.g., - * /home/{user-name}/certs) and certificates are placed in that directory. + * A list of certificates to be installed on each compute node in the pool. If this element is + * present, it replaces any existing certificate references configured on the pool. If omitted, + * any existing certificate references are left unchanged. For Windows compute nodes, the Batch + * service installs the certificates to the specified certificate store and location. For Linux + * compute nodes, the certificates are stored in a directory inside the task working directory + * and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for + * this location. For certificates with visibility of 'remoteUser', a 'certs' directory is + * created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are + * placed in that directory. */ certificateReferences?: CertificateReference[]; /** - * @member {ApplicationPackageReference[]} [applicationPackageReferences] A - * list of application packages to be installed on each compute node in the - * pool. Changes to application package references affect all new compute - * nodes joining the pool, but do not affect compute nodes that are already - * in the pool until they are rebooted or reimaged. If this element is - * present, it replaces any existing application package references. If you - * specify an empty collection, then all application package references are - * removed from the pool. If omitted, any existing application package - * references are left unchanged. + * The list of application packages to be installed on each compute node in the pool. The list + * replaces any existing application package references on the pool. Changes to application + * package references affect all new compute nodes joining the pool, but do not affect compute + * nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of + * 10 application package references on any given pool. If omitted, any existing application + * package references are left unchanged. */ applicationPackageReferences?: ApplicationPackageReference[]; /** - * @member {MetadataItem[]} [metadata] A list of name-value pairs associated - * with the pool as metadata. If this element is present, it replaces any - * existing metadata configured on the pool. If you specify an empty - * collection, any metadata is removed from the pool. If omitted, any - * existing metadata is left unchanged. + * A list of name-value pairs associated with the pool as metadata. If this element is present, + * it replaces any existing metadata configured on the pool. If you specify an empty collection, + * any metadata is removed from the pool. If omitted, any existing metadata is left unchanged. */ metadata?: MetadataItem[]; } /** - * @interface * An interface representing TaskUpdateParameter. * @summary The set of changes to be made to a task. - * */ export interface TaskUpdateParameter { /** - * @member {TaskConstraints} [constraints] Constraints that apply to this - * task. If omitted, the task is given the default constraints. For - * multi-instance tasks, updating the retention time applies only to the - * primary task and not subtasks. + * Constraints that apply to this task. If omitted, the task is given the default constraints. + * For multi-instance tasks, updating the retention time applies only to the primary task and not + * subtasks. */ constraints?: TaskConstraints; } /** - * @interface * An interface representing NodeUpdateUserParameter. * @summary The set of changes to be made to a user account on a node. - * */ export interface NodeUpdateUserParameter { /** - * @member {string} [password] The password of the account. The password is - * required for Windows nodes (those created with - * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' - * using a Windows image reference). For Linux compute nodes, the password - * can optionally be specified along with the sshPublicKey property. If - * omitted, any existing password is removed. + * The password of the account. The password is required for Windows nodes (those created with + * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows + * image reference). For Linux compute nodes, the password can optionally be specified along with + * the sshPublicKey property. If omitted, any existing password is removed. */ password?: string; /** - * @member {Date} [expiryTime] The time at which the account should expire. - * If omitted, the default is 1 day from the current time. For Linux compute - * nodes, the expiryTime has a precision up to a day. + * The time at which the account should expire. If omitted, the default is 1 day from the current + * time. For Linux compute nodes, the expiryTime has a precision up to a day. */ expiryTime?: Date; /** - * @member {string} [sshPublicKey] The SSH public key that can be used for - * remote login to the compute node. The public key should be compatible with - * OpenSSH encoding and should be base 64 encoded. This property can be - * specified only for Linux nodes. If this is specified for a Windows node, - * then the Batch service rejects the request; if you are calling the REST - * API directly, the HTTP status code is 400 (Bad Request). If omitted, any - * existing SSH public key is removed. + * The SSH public key that can be used for remote login to the compute node. The public key + * should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be + * specified only for Linux nodes. If this is specified for a Windows node, then the Batch + * service rejects the request; if you are calling the REST API directly, the HTTP status code is + * 400 (Bad Request). If omitted, any existing SSH public key is removed. */ sshPublicKey?: string; } /** - * @interface * An interface representing NodeRebootParameter. * @summary Options for rebooting a compute node. - * */ export interface NodeRebootParameter { /** - * @member {ComputeNodeRebootOption} [nodeRebootOption] When to reboot the - * compute node and what to do with currently running tasks. The default - * value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion', 'retainedData' + * When to reboot the compute node and what to do with currently running tasks. The default value + * is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' */ nodeRebootOption?: ComputeNodeRebootOption; } /** - * @interface * An interface representing NodeReimageParameter. * @summary Options for reimaging a compute node. - * */ export interface NodeReimageParameter { /** - * @member {ComputeNodeReimageOption} [nodeReimageOption] When to reimage the - * compute node and what to do with currently running tasks. The default - * value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion', 'retainedData' + * When to reimage the compute node and what to do with currently running tasks. The default + * value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', + * 'retainedData' */ nodeReimageOption?: ComputeNodeReimageOption; } /** - * @interface * An interface representing NodeDisableSchedulingParameter. * @summary Options for disabling scheduling on a compute node. - * */ export interface NodeDisableSchedulingParameter { /** - * @member {DisableComputeNodeSchedulingOption} [nodeDisableSchedulingOption] - * What to do with currently running tasks when disabling task scheduling on - * the compute node. The default value is requeue. Possible values include: - * 'requeue', 'terminate', 'taskCompletion' + * What to do with currently running tasks when disabling task scheduling on the compute node. + * The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion' */ nodeDisableSchedulingOption?: DisableComputeNodeSchedulingOption; } /** - * @interface * An interface representing NodeRemoveParameter. * @summary Options for removing compute nodes from a pool. - * */ export interface NodeRemoveParameter { /** - * @member {string[]} nodeList A list containing the IDs of the compute nodes - * to be removed from the specified pool. + * A list containing the IDs of the compute nodes to be removed from the specified pool. */ nodeList: string[]; /** - * @member {string} [resizeTimeout] The timeout for removal of compute nodes - * to the pool. The default value is 15 minutes. The minimum value is 5 - * minutes. If you specify a value less than 5 minutes, the Batch service - * returns an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). + * The timeout for removal of compute nodes to the pool. The default value is 15 minutes. The + * minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service + * returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad + * Request). */ resizeTimeout?: string; /** - * @member {ComputeNodeDeallocationOption} [nodeDeallocationOption] - * Determines what to do with a node and its running task(s) after it has - * been selected for deallocation. The default value is requeue. Possible - * values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' + * Determines what to do with a node and its running task(s) after it has been selected for + * deallocation. The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion', 'retainedData' */ nodeDeallocationOption?: ComputeNodeDeallocationOption; } /** - * @interface * An interface representing UploadBatchServiceLogsConfiguration. - * @summary The Azure Batch service log files upload configuration for a - * compute node. - * + * @summary The Azure Batch service log files upload configuration for a compute node. */ export interface UploadBatchServiceLogsConfiguration { /** - * @member {string} containerUrl The URL of the container within Azure Blob - * Storage to which to upload the Batch Service log file(s). The URL must - * include a Shared Access Signature (SAS) granting write permissions to the - * container. The SAS duration must allow enough time for the upload to - * finish. The start time for SAS is optional and recommended to not be - * specified. + * The URL of the container within Azure Blob Storage to which to upload the Batch Service log + * file(s). The URL must include a Shared Access Signature (SAS) granting write permissions to + * the container. The SAS duration must allow enough time for the upload to finish. The start + * time for SAS is optional and recommended to not be specified. */ containerUrl: string; /** - * @member {Date} startTime The start of the time range from which to upload - * Batch Service log file(s). Any log file containing a log message in the - * time range will be uploaded. This means that the operation might retrieve - * more logs than have been requested since the entire log file is always - * uploaded, but the operation should not retrieve fewer logs than have been - * requested. + * The start of the time range from which to upload Batch Service log file(s). Any log file + * containing a log message in the time range will be uploaded. This means that the operation + * might retrieve more logs than have been requested since the entire log file is always + * uploaded, but the operation should not retrieve fewer logs than have been requested. */ startTime: Date; /** - * @member {Date} [endTime] The end of the time range from which to upload - * Batch Service log file(s). Any log file containing a log message in the - * time range will be uploaded. This means that the operation might retrieve - * more logs than have been requested since the entire log file is always - * uploaded, but the operation should not retrieve fewer logs than have been - * requested. If omitted, the default is to upload all logs available after - * the startTime. + * The end of the time range from which to upload Batch Service log file(s). Any log file + * containing a log message in the time range will be uploaded. This means that the operation + * might retrieve more logs than have been requested since the entire log file is always + * uploaded, but the operation should not retrieve fewer logs than have been requested. If + * omitted, the default is to upload all logs available after the startTime. */ endTime?: Date; } /** - * @interface * An interface representing UploadBatchServiceLogsResult. - * @summary The result of uploading Batch service log files from a specific - * compute node. - * + * @summary The result of uploading Batch service log files from a specific compute node. */ export interface UploadBatchServiceLogsResult { /** - * @member {string} virtualDirectoryName The virtual directory within Azure - * Blob Storage container to which the Batch Service log file(s) will be - * uploaded. The virtual directory name is part of the blob name for each log - * file uploaded, and it is built based poolId, nodeId and a unique - * identifier. + * The virtual directory within Azure Blob Storage container to which the Batch Service log + * file(s) will be uploaded. The virtual directory name is part of the blob name for each log + * file uploaded, and it is built based poolId, nodeId and a unique identifier. */ virtualDirectoryName: string; /** - * @member {number} numberOfFilesUploaded The number of log files which will - * be uploaded. + * The number of log files which will be uploaded. */ numberOfFilesUploaded: number; } /** - * @interface * An interface representing NodeCounts. * @summary The number of nodes in each node state. - * */ export interface NodeCounts { /** - * @member {number} creating The number of nodes in the creating state. + * The number of nodes in the creating state. */ creating: number; /** - * @member {number} idle The number of nodes in the idle state. + * The number of nodes in the idle state. */ idle: number; /** - * @member {number} offline The number of nodes in the offline state. + * The number of nodes in the offline state. */ offline: number; /** - * @member {number} preempted The number of nodes in the preempted state. + * The number of nodes in the preempted state. */ preempted: number; /** - * @member {number} rebooting The count of nodes in the rebooting state. + * The count of nodes in the rebooting state. */ rebooting: number; /** - * @member {number} reimaging The number of nodes in the reimaging state. + * The number of nodes in the reimaging state. */ reimaging: number; /** - * @member {number} running The number of nodes in the running state. + * The number of nodes in the running state. */ running: number; /** - * @member {number} starting The number of nodes in the starting state. + * The number of nodes in the starting state. */ starting: number; /** - * @member {number} startTaskFailed The number of nodes in the - * startTaskFailed state. + * The number of nodes in the startTaskFailed state. */ startTaskFailed: number; /** - * @member {number} leavingPool The number of nodes in the leavingPool state. + * The number of nodes in the leavingPool state. */ leavingPool: number; /** - * @member {number} unknown The number of nodes in the unknown state. + * The number of nodes in the unknown state. */ unknown: number; /** - * @member {number} unusable The number of nodes in the unusable state. + * The number of nodes in the unusable state. */ unusable: number; /** - * @member {number} waitingForStartTask The number of nodes in the - * waitingForStartTask state. + * The number of nodes in the waitingForStartTask state. */ waitingForStartTask: number; /** - * @member {number} total The total number of nodes. + * The total number of nodes. */ total: number; } /** - * @interface * An interface representing PoolNodeCounts. * @summary The number of nodes in each state for a pool. - * */ export interface PoolNodeCounts { /** - * @member {string} poolId The ID of the pool. + * The ID of the pool. */ poolId: string; /** - * @member {NodeCounts} [dedicated] The number of dedicated nodes in each - * state. + * The number of dedicated nodes in each state. */ dedicated?: NodeCounts; /** - * @member {NodeCounts} [lowPriority] The number of low priority nodes in - * each state. + * The number of low priority nodes in each state. */ lowPriority?: NodeCounts; } /** - * @interface - * An interface representing ApplicationListOptions. * Additional parameters for list operation. - * */ export interface ApplicationListOptions { /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 applications can be returned. Default value: - * 1000 . + * The maximum number of items to return in the response. A maximum of 1000 applications can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ApplicationGetOptions. * Additional parameters for get operation. - * */ export interface ApplicationGetOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolListUsageMetricsOptions. * Additional parameters for listUsageMetrics operation. - * */ export interface PoolListUsageMetricsOptions { /** - * @member {Date} [startTime] The earliest time from which to include - * metrics. This must be at least two and a half hours before the current - * time. If not specified this defaults to the start time of the last + * The earliest time from which to include metrics. This must be at least two and a half hours + * before the current time. If not specified this defaults to the start time of the last * aggregation interval currently available. */ startTime?: Date; /** - * @member {Date} [endTime] The latest time from which to include metrics. - * This must be at least two hours before the current time. If not specified - * this defaults to the end time of the last aggregation interval currently - * available. + * The latest time from which to include metrics. This must be at least two hours before the + * current time. If not specified this defaults to the end time of the last aggregation interval + * currently available. */ endTime?: Date; /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. */ filter?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 - * . + * The maximum number of items to return in the response. A maximum of 1000 results will be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolGetAllLifetimeStatisticsOptions. * Additional parameters for getAllLifetimeStatistics operation. - * */ export interface PoolGetAllLifetimeStatisticsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolAddOptions. * Additional parameters for add operation. - * */ export interface PoolAddOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolListOptions. * Additional parameters for list operation. - * */ export interface PoolListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 pools can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 pools can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolDeleteMethodOptions. * Additional parameters for deleteMethod operation. - * */ export interface PoolDeleteMethodOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolExistsOptions. * Additional parameters for exists operation. - * */ export interface PoolExistsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolGetOptions. * Additional parameters for get operation. - * */ export interface PoolGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolPatchOptions. * Additional parameters for patch operation. - * */ export interface PoolPatchOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolDisableAutoScaleOptions. * Additional parameters for disableAutoScale operation. - * */ export interface PoolDisableAutoScaleOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolEnableAutoScaleOptions. * Additional parameters for enableAutoScale operation. - * */ export interface PoolEnableAutoScaleOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolEvaluateAutoScaleOptions. * Additional parameters for evaluateAutoScale operation. - * */ export interface PoolEvaluateAutoScaleOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolResizeOptions. * Additional parameters for resize operation. - * */ export interface PoolResizeOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolStopResizeOptions. * Additional parameters for stopResize operation. - * */ export interface PoolStopResizeOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolUpdatePropertiesOptions. * Additional parameters for updateProperties operation. - * */ export interface PoolUpdatePropertiesOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - */ - timeout?: number; - /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - */ - clientRequestId?: string; - /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - */ - returnClientRequestId?: boolean; - /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - */ - ocpDate?: Date; -} - -/** - * @interface - * An interface representing PoolUpgradeOSOptions. - * Additional parameters for upgradeOS operation. - * - */ -export interface PoolUpgradeOSOptions { - /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; - /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value - * specified by the client. - */ - ifMatch?: string; - /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value - * specified by the client. - */ - ifNoneMatch?: string; - /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - */ - ifModifiedSince?: Date; - /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since - * the specified time. - */ - ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing PoolRemoveNodesOptions. * Additional parameters for removeNodes operation. - * */ export interface PoolRemoveNodesOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing AccountListNodeAgentSkusOptions. * Additional parameters for listNodeAgentSkus operation. - * */ export interface AccountListNodeAgentSkusOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. */ filter?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 - * . + * The maximum number of items to return in the response. A maximum of 1000 results will be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing AccountListPoolNodeCountsOptions. * Additional parameters for listPoolNodeCounts operation. - * */ export interface AccountListPoolNodeCountsOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. */ filter?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. Default value: 10 . + * The maximum number of items to return in the response. Default value: 10. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobGetAllLifetimeStatisticsOptions. * Additional parameters for getAllLifetimeStatistics operation. - * */ export interface JobGetAllLifetimeStatisticsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobDeleteMethodOptions. * Additional parameters for deleteMethod operation. - * */ export interface JobDeleteMethodOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobGetOptions. * Additional parameters for get operation. - * */ export interface JobGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobPatchOptions. * Additional parameters for patch operation. - * */ export interface JobPatchOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobUpdateOptions. * Additional parameters for update operation. - * */ export interface JobUpdateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobDisableOptions. * Additional parameters for disable operation. - * */ export interface JobDisableOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobEnableOptions. * Additional parameters for enable operation. - * */ export interface JobEnableOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobTerminateOptions. * Additional parameters for terminate operation. - * */ export interface JobTerminateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobAddOptions. * Additional parameters for add operation. - * */ export interface JobAddOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListOptions. * Additional parameters for list operation. - * */ export interface JobListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. + * Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListFromJobScheduleOptions. * Additional parameters for listFromJobSchedule operation. - * */ export interface JobListFromJobScheduleOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. + * Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListPreparationAndReleaseTaskStatusOptions. * Additional parameters for listPreparationAndReleaseTaskStatus operation. - * */ export interface JobListPreparationAndReleaseTaskStatusOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 tasks can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobGetTaskCountsOptions. * Additional parameters for getTaskCounts operation. - * */ export interface JobGetTaskCountsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateAddOptions. * Additional parameters for add operation. - * */ export interface CertificateAddOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateListOptions. * Additional parameters for list operation. - * */ export interface CertificateListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 certificates can be returned. Default value: - * 1000 . + * The maximum number of items to return in the response. A maximum of 1000 certificates can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateCancelDeletionOptions. * Additional parameters for cancelDeletion operation. - * */ export interface CertificateCancelDeletionOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateDeleteMethodOptions. * Additional parameters for deleteMethod operation. - * */ export interface CertificateDeleteMethodOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateGetOptions. * Additional parameters for get operation. - * */ export interface CertificateGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileDeleteFromTaskOptions. * Additional parameters for deleteFromTask operation. - * */ export interface FileDeleteFromTaskOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileGetFromTaskOptions. * Additional parameters for getFromTask operation. - * */ export interface FileGetFromTaskOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. + * The byte range to be retrieved. The default is to retrieve the entire file. The format is + * bytes=startRange-endRange. */ ocpRange?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing FileGetPropertiesFromTaskOptions. * Additional parameters for getPropertiesFromTask operation. - * */ export interface FileGetPropertiesFromTaskOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing FileDeleteFromComputeNodeOptions. * Additional parameters for deleteFromComputeNode operation. - * */ export interface FileDeleteFromComputeNodeOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileGetFromComputeNodeOptions. * Additional parameters for getFromComputeNode operation. - * */ export interface FileGetFromComputeNodeOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. + * The byte range to be retrieved. The default is to retrieve the entire file. The format is + * bytes=startRange-endRange. */ ocpRange?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing FileGetPropertiesFromComputeNodeOptions. * Additional parameters for getPropertiesFromComputeNode operation. - * */ export interface FileGetPropertiesFromComputeNodeOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing FileListFromTaskOptions. * Additional parameters for listFromTask operation. - * */ export interface FileListFromTaskOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. */ filter?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 files can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileListFromComputeNodeOptions. * Additional parameters for listFromComputeNode operation. - * */ export interface FileListFromComputeNodeOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. */ filter?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 files can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobScheduleExistsOptions. * Additional parameters for exists operation. - * */ export interface JobScheduleExistsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleDeleteMethodOptions. * Additional parameters for deleteMethod operation. - * */ export interface JobScheduleDeleteMethodOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleGetOptions. * Additional parameters for get operation. - * */ export interface JobScheduleGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobSchedulePatchOptions. * Additional parameters for patch operation. - * */ export interface JobSchedulePatchOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleUpdateOptions. * Additional parameters for update operation. - * */ export interface JobScheduleUpdateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleDisableOptions. * Additional parameters for disable operation. - * */ export interface JobScheduleDisableOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleEnableOptions. * Additional parameters for enable operation. - * */ export interface JobScheduleEnableOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleTerminateOptions. * Additional parameters for terminate operation. - * */ export interface JobScheduleTerminateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing JobScheduleAddOptions. * Additional parameters for add operation. - * */ export interface JobScheduleAddOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobScheduleListOptions. * Additional parameters for list operation. - * */ export interface JobScheduleListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 job schedules can be returned. Default value: - * 1000 . + * The maximum number of items to return in the response. A maximum of 1000 job schedules can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskAddOptions. * Additional parameters for add operation. - * */ export interface TaskAddOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskListOptions. * Additional parameters for list operation. - * */ export interface TaskListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 tasks can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskAddCollectionOptions. * Additional parameters for addCollection operation. - * */ export interface TaskAddCollectionOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskDeleteMethodOptions. * Additional parameters for deleteMethod operation. - * */ export interface TaskDeleteMethodOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing TaskGetOptions. * Additional parameters for get operation. - * */ export interface TaskGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {string} [expand] An OData $expand clause. + * An OData $expand clause. */ expand?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing TaskUpdateOptions. * Additional parameters for update operation. - * */ export interface TaskUpdateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing TaskListSubtasksOptions. * Additional parameters for listSubtasks operation. - * */ export interface TaskListSubtasksOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskTerminateOptions. * Additional parameters for terminate operation. - * */ export interface TaskTerminateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing TaskReactivateOptions. * Additional parameters for reactivate operation. - * */ export interface TaskReactivateOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; /** - * @member {string} [ifMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service exactly matches the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value * specified by the client. */ ifMatch?: string; /** - * @member {string} [ifNoneMatch] An ETag value associated with the version - * of the resource known to the client. The operation will be performed only - * if the resource's current ETag on the service does not match the value + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value * specified by the client. */ ifNoneMatch?: string; /** - * @member {Date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. */ ifModifiedSince?: Date; /** - * @member {Date} [ifUnmodifiedSince] A timestamp indicating the last - * modified time of the resource known to the client. The operation will be - * performed only if the resource on the service has not been modified since + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since * the specified time. */ ifUnmodifiedSince?: Date; } /** - * @interface - * An interface representing ComputeNodeAddUserOptions. * Additional parameters for addUser operation. - * */ export interface ComputeNodeAddUserOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeDeleteUserOptions. * Additional parameters for deleteUser operation. - * */ export interface ComputeNodeDeleteUserOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeUpdateUserOptions. * Additional parameters for updateUser operation. - * */ export interface ComputeNodeUpdateUserOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeGetOptions. * Additional parameters for get operation. - * */ export interface ComputeNodeGetOptions { /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeRebootOptions. * Additional parameters for reboot operation. - * */ export interface ComputeNodeRebootOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeReimageOptions. * Additional parameters for reimage operation. - * */ export interface ComputeNodeReimageOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeDisableSchedulingOptions. * Additional parameters for disableScheduling operation. - * */ export interface ComputeNodeDisableSchedulingOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeEnableSchedulingOptions. * Additional parameters for enableScheduling operation. - * */ export interface ComputeNodeEnableSchedulingOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeGetRemoteLoginSettingsOptions. * Additional parameters for getRemoteLoginSettings operation. - * */ export interface ComputeNodeGetRemoteLoginSettingsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeGetRemoteDesktopOptions. * Additional parameters for getRemoteDesktop operation. - * */ export interface ComputeNodeGetRemoteDesktopOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeUploadBatchServiceLogsOptions. * Additional parameters for uploadBatchServiceLogs operation. - * */ export interface ComputeNodeUploadBatchServiceLogsOptions { /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeListOptions. * Additional parameters for list operation. - * */ export interface ComputeNodeListOptions { /** - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * An OData $filter clause. For more information on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. */ filter?: string; /** - * @member {string} [select] An OData $select clause. + * An OData $select clause. */ select?: string; /** - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 nodes can be returned. Default value: 1000 . + * The maximum number of items to return in the response. A maximum of 1000 nodes can be + * returned. Default value: 1000. */ maxResults?: number; /** - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. Default value: 30. */ timeout?: number; /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ApplicationListNextOptions. * Additional parameters for listNext operation. - * */ export interface ApplicationListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolListUsageMetricsNextOptions. * Additional parameters for listUsageMetricsNext operation. - * */ export interface PoolListUsageMetricsNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing PoolListNextOptions. * Additional parameters for listNext operation. - * */ export interface PoolListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing AccountListNodeAgentSkusNextOptions. * Additional parameters for listNodeAgentSkusNext operation. - * */ export interface AccountListNodeAgentSkusNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing AccountListPoolNodeCountsNextOptions. * Additional parameters for listPoolNodeCountsNext operation. - * */ export interface AccountListPoolNodeCountsNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListNextOptions. * Additional parameters for listNext operation. - * */ export interface JobListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListFromJobScheduleNextOptions. * Additional parameters for listFromJobScheduleNext operation. - * */ export interface JobListFromJobScheduleNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobListPreparationAndReleaseTaskStatusNextOptions. * Additional parameters for listPreparationAndReleaseTaskStatusNext operation. - * */ export interface JobListPreparationAndReleaseTaskStatusNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing CertificateListNextOptions. * Additional parameters for listNext operation. - * */ export interface CertificateListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileListFromTaskNextOptions. * Additional parameters for listFromTaskNext operation. - * */ export interface FileListFromTaskNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing FileListFromComputeNodeNextOptions. * Additional parameters for listFromComputeNodeNext operation. - * */ export interface FileListFromComputeNodeNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing JobScheduleListNextOptions. * Additional parameters for listNext operation. - * */ export interface JobScheduleListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing TaskListNextOptions. * Additional parameters for listNext operation. - * */ export interface TaskListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ComputeNodeListNextOptions. * Additional parameters for listNext operation. - * */ export interface ComputeNodeListNextOptions { /** - * @member {string} [clientRequestId] The caller-generated request identity, - * in the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. */ clientRequestId?: string; /** - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . + * Whether the server should return the client-request-id in the response. Default value: false. */ returnClientRequestId?: boolean; /** - * @member {Date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. */ ocpDate?: Date; } /** - * @interface - * An interface representing ApplicationListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ApplicationListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ApplicationListOptions} [applicationListOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ applicationListOptions?: ApplicationListOptions; } /** - * @interface - * An interface representing ApplicationGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ApplicationGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ApplicationGetOptions} [applicationGetOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ applicationGetOptions?: ApplicationGetOptions; } /** - * @interface - * An interface representing ApplicationListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ApplicationListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ApplicationListNextOptions} [applicationListNextOptions] * Additional parameters for the operation */ applicationListNextOptions?: ApplicationListNextOptions; } /** - * @interface - * An interface representing PoolListUsageMetricsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolListUsageMetricsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolListUsageMetricsOptions} [poolListUsageMetricsOptions] * Additional parameters for the operation */ poolListUsageMetricsOptions?: PoolListUsageMetricsOptions; } /** - * @interface - * An interface representing PoolGetAllLifetimeStatisticsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolGetAllLifetimeStatisticsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolGetAllLifetimeStatisticsOptions} - * [poolGetAllLifetimeStatisticsOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ poolGetAllLifetimeStatisticsOptions?: PoolGetAllLifetimeStatisticsOptions; } /** - * @interface - * An interface representing PoolAddOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolAddOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolAddOptions} [poolAddOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ poolAddOptions?: PoolAddOptions; } /** - * @interface - * An interface representing PoolListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolListOptions} [poolListOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ poolListOptions?: PoolListOptions; } /** - * @interface - * An interface representing PoolDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolDeleteMethodOptions} [poolDeleteMethodOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ poolDeleteMethodOptions?: PoolDeleteMethodOptions; } /** - * @interface - * An interface representing PoolExistsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolExistsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolExistsOptions} [poolExistsOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ poolExistsOptions?: PoolExistsOptions; } /** - * @interface - * An interface representing PoolGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolGetOptions} [poolGetOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ poolGetOptions?: PoolGetOptions; } /** - * @interface - * An interface representing PoolPatchOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolPatchOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolPatchOptions} [poolPatchOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ poolPatchOptions?: PoolPatchOptions; } /** - * @interface - * An interface representing PoolDisableAutoScaleOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolDisableAutoScaleOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolDisableAutoScaleOptions} [poolDisableAutoScaleOptions] * Additional parameters for the operation */ poolDisableAutoScaleOptions?: PoolDisableAutoScaleOptions; } /** - * @interface - * An interface representing PoolEnableAutoScaleOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolEnableAutoScaleOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolEnableAutoScaleOptions} [poolEnableAutoScaleOptions] * Additional parameters for the operation */ poolEnableAutoScaleOptions?: PoolEnableAutoScaleOptions; } /** - * @interface - * An interface representing PoolEvaluateAutoScaleOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolEvaluateAutoScaleOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolEvaluateAutoScaleOptions} [poolEvaluateAutoScaleOptions] * Additional parameters for the operation */ poolEvaluateAutoScaleOptions?: PoolEvaluateAutoScaleOptions; } /** - * @interface - * An interface representing PoolResizeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolResizeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolResizeOptions} [poolResizeOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ poolResizeOptions?: PoolResizeOptions; } /** - * @interface - * An interface representing PoolStopResizeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolStopResizeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolStopResizeOptions} [poolStopResizeOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ poolStopResizeOptions?: PoolStopResizeOptions; } /** - * @interface - * An interface representing PoolUpdatePropertiesOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolUpdatePropertiesOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolUpdatePropertiesOptions} [poolUpdatePropertiesOptions] * Additional parameters for the operation */ poolUpdatePropertiesOptions?: PoolUpdatePropertiesOptions; } /** - * @interface - * An interface representing PoolUpgradeOSOptionalParams. - * Optional Parameters. - * - * @extends RequestOptionsBase - */ -export interface PoolUpgradeOSOptionalParams extends msRest.RequestOptionsBase { - /** - * @member {PoolUpgradeOSOptions} [poolUpgradeOSOptions] Additional - * parameters for the operation - */ - poolUpgradeOSOptions?: PoolUpgradeOSOptions; -} - -/** - * @interface - * An interface representing PoolRemoveNodesOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolRemoveNodesOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolRemoveNodesOptions} [poolRemoveNodesOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ poolRemoveNodesOptions?: PoolRemoveNodesOptions; } /** - * @interface - * An interface representing PoolListUsageMetricsNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolListUsageMetricsNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolListUsageMetricsNextOptions} - * [poolListUsageMetricsNextOptions] Additional parameters for the operation + * Additional parameters for the operation */ poolListUsageMetricsNextOptions?: PoolListUsageMetricsNextOptions; } /** - * @interface - * An interface representing PoolListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface PoolListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {PoolListNextOptions} [poolListNextOptions] Additional parameters - * for the operation + * Additional parameters for the operation */ poolListNextOptions?: PoolListNextOptions; } /** - * @interface - * An interface representing AccountListNodeAgentSkusOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface AccountListNodeAgentSkusOptionalParams extends msRest.RequestOptionsBase { /** - * @member {AccountListNodeAgentSkusOptions} - * [accountListNodeAgentSkusOptions] Additional parameters for the operation + * Additional parameters for the operation */ accountListNodeAgentSkusOptions?: AccountListNodeAgentSkusOptions; } /** - * @interface - * An interface representing AccountListPoolNodeCountsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface AccountListPoolNodeCountsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {AccountListPoolNodeCountsOptions} - * [accountListPoolNodeCountsOptions] Additional parameters for the operation + * Additional parameters for the operation */ accountListPoolNodeCountsOptions?: AccountListPoolNodeCountsOptions; } /** - * @interface - * An interface representing AccountListNodeAgentSkusNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface AccountListNodeAgentSkusNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {AccountListNodeAgentSkusNextOptions} - * [accountListNodeAgentSkusNextOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ accountListNodeAgentSkusNextOptions?: AccountListNodeAgentSkusNextOptions; } /** - * @interface - * An interface representing AccountListPoolNodeCountsNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface AccountListPoolNodeCountsNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {AccountListPoolNodeCountsNextOptions} - * [accountListPoolNodeCountsNextOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ accountListPoolNodeCountsNextOptions?: AccountListPoolNodeCountsNextOptions; } /** - * @interface - * An interface representing JobGetAllLifetimeStatisticsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobGetAllLifetimeStatisticsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobGetAllLifetimeStatisticsOptions} - * [jobGetAllLifetimeStatisticsOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobGetAllLifetimeStatisticsOptions?: JobGetAllLifetimeStatisticsOptions; } /** - * @interface - * An interface representing JobDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobDeleteMethodOptions} [jobDeleteMethodOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobDeleteMethodOptions?: JobDeleteMethodOptions; } /** - * @interface - * An interface representing JobGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobGetOptions} [jobGetOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobGetOptions?: JobGetOptions; } /** - * @interface - * An interface representing JobPatchOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobPatchOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobPatchOptions} [jobPatchOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobPatchOptions?: JobPatchOptions; } /** - * @interface - * An interface representing JobUpdateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobUpdateOptions} [jobUpdateOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ jobUpdateOptions?: JobUpdateOptions; } /** - * @interface - * An interface representing JobDisableOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobDisableOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobDisableOptions} [jobDisableOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ jobDisableOptions?: JobDisableOptions; } /** - * @interface - * An interface representing JobEnableOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobEnableOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobEnableOptions} [jobEnableOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ jobEnableOptions?: JobEnableOptions; } /** - * @interface - * An interface representing JobTerminateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobTerminateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [terminateReason] The text you want to appear as the - * job's TerminateReason. The default is 'UserTerminate'. + * The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'. */ terminateReason?: string; /** - * @member {JobTerminateOptions} [jobTerminateOptions] Additional parameters - * for the operation + * Additional parameters for the operation */ jobTerminateOptions?: JobTerminateOptions; } /** - * @interface - * An interface representing JobAddOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobAddOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobAddOptions} [jobAddOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobAddOptions?: JobAddOptions; } /** - * @interface - * An interface representing JobListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListOptions} [jobListOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobListOptions?: JobListOptions; } /** - * @interface - * An interface representing JobListFromJobScheduleOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListFromJobScheduleOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListFromJobScheduleOptions} [jobListFromJobScheduleOptions] * Additional parameters for the operation */ jobListFromJobScheduleOptions?: JobListFromJobScheduleOptions; } /** - * @interface - * An interface representing JobListPreparationAndReleaseTaskStatusOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListPreparationAndReleaseTaskStatusOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListPreparationAndReleaseTaskStatusOptions} - * [jobListPreparationAndReleaseTaskStatusOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ jobListPreparationAndReleaseTaskStatusOptions?: JobListPreparationAndReleaseTaskStatusOptions; } /** - * @interface - * An interface representing JobGetTaskCountsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobGetTaskCountsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobGetTaskCountsOptions} [jobGetTaskCountsOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobGetTaskCountsOptions?: JobGetTaskCountsOptions; } /** - * @interface - * An interface representing JobListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListNextOptions} [jobListNextOptions] Additional parameters - * for the operation + * Additional parameters for the operation */ jobListNextOptions?: JobListNextOptions; } /** - * @interface - * An interface representing JobListFromJobScheduleNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListFromJobScheduleNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListFromJobScheduleNextOptions} - * [jobListFromJobScheduleNextOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ jobListFromJobScheduleNextOptions?: JobListFromJobScheduleNextOptions; } /** - * @interface - * An interface representing JobListPreparationAndReleaseTaskStatusNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobListPreparationAndReleaseTaskStatusNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobListPreparationAndReleaseTaskStatusNextOptions} - * [jobListPreparationAndReleaseTaskStatusNextOptions] Additional parameters - * for the operation + * Additional parameters for the operation */ jobListPreparationAndReleaseTaskStatusNextOptions?: JobListPreparationAndReleaseTaskStatusNextOptions; } /** - * @interface - * An interface representing CertificateAddOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateAddOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateAddOptions} [certificateAddOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ certificateAddOptions?: CertificateAddOptions; } /** - * @interface - * An interface representing CertificateListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateListOptions} [certificateListOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ certificateListOptions?: CertificateListOptions; } /** - * @interface - * An interface representing CertificateCancelDeletionOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateCancelDeletionOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateCancelDeletionOptions} - * [certificateCancelDeletionOptions] Additional parameters for the operation + * Additional parameters for the operation */ certificateCancelDeletionOptions?: CertificateCancelDeletionOptions; } /** - * @interface - * An interface representing CertificateDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateDeleteMethodOptions} [certificateDeleteMethodOptions] * Additional parameters for the operation */ certificateDeleteMethodOptions?: CertificateDeleteMethodOptions; } /** - * @interface - * An interface representing CertificateGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateGetOptions} [certificateGetOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ certificateGetOptions?: CertificateGetOptions; } /** - * @interface - * An interface representing CertificateListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface CertificateListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {CertificateListNextOptions} [certificateListNextOptions] * Additional parameters for the operation */ certificateListNextOptions?: CertificateListNextOptions; } /** - * @interface - * An interface representing FileDeleteFromTaskOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileDeleteFromTaskOptionalParams extends msRest.RequestOptionsBase { /** - * @member {boolean} [recursive] Whether to delete children of a directory. - * If the filePath parameter represents a directory instead of a file, you - * can set recursive to true to delete the directory and all of the files and - * subdirectories in it. If recursive is false then the directory must be - * empty or deletion will fail. + * Whether to delete children of a directory. If the filePath parameter represents a directory + * instead of a file, you can set recursive to true to delete the directory and all of the files + * and subdirectories in it. If recursive is false then the directory must be empty or deletion + * will fail. */ recursive?: boolean; /** - * @member {FileDeleteFromTaskOptions} [fileDeleteFromTaskOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ fileDeleteFromTaskOptions?: FileDeleteFromTaskOptions; } /** - * @interface - * An interface representing FileGetFromTaskOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileGetFromTaskOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileGetFromTaskOptions} [fileGetFromTaskOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ fileGetFromTaskOptions?: FileGetFromTaskOptions; } /** - * @interface - * An interface representing FileGetPropertiesFromTaskOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileGetPropertiesFromTaskOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileGetPropertiesFromTaskOptions} - * [fileGetPropertiesFromTaskOptions] Additional parameters for the operation + * Additional parameters for the operation */ fileGetPropertiesFromTaskOptions?: FileGetPropertiesFromTaskOptions; } /** - * @interface - * An interface representing FileDeleteFromComputeNodeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileDeleteFromComputeNodeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {boolean} [recursive] Whether to delete children of a directory. - * If the filePath parameter represents a directory instead of a file, you - * can set recursive to true to delete the directory and all of the files and - * subdirectories in it. If recursive is false then the directory must be - * empty or deletion will fail. + * Whether to delete children of a directory. If the filePath parameter represents a directory + * instead of a file, you can set recursive to true to delete the directory and all of the files + * and subdirectories in it. If recursive is false then the directory must be empty or deletion + * will fail. */ recursive?: boolean; /** - * @member {FileDeleteFromComputeNodeOptions} - * [fileDeleteFromComputeNodeOptions] Additional parameters for the operation + * Additional parameters for the operation */ fileDeleteFromComputeNodeOptions?: FileDeleteFromComputeNodeOptions; } /** - * @interface - * An interface representing FileGetFromComputeNodeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileGetFromComputeNodeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileGetFromComputeNodeOptions} [fileGetFromComputeNodeOptions] * Additional parameters for the operation */ fileGetFromComputeNodeOptions?: FileGetFromComputeNodeOptions; } /** - * @interface - * An interface representing FileGetPropertiesFromComputeNodeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileGetPropertiesFromComputeNodeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileGetPropertiesFromComputeNodeOptions} - * [fileGetPropertiesFromComputeNodeOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ fileGetPropertiesFromComputeNodeOptions?: FileGetPropertiesFromComputeNodeOptions; } /** - * @interface - * An interface representing FileListFromTaskOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileListFromTaskOptionalParams extends msRest.RequestOptionsBase { /** - * @member {boolean} [recursive] Whether to list children of the task - * directory. This parameter can be used in combination with the filter - * parameter to list specific type of files. + * Whether to list children of the task directory. This parameter can be used in combination with + * the filter parameter to list specific type of files. */ recursive?: boolean; /** - * @member {FileListFromTaskOptions} [fileListFromTaskOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ fileListFromTaskOptions?: FileListFromTaskOptions; } /** - * @interface - * An interface representing FileListFromComputeNodeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileListFromComputeNodeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {boolean} [recursive] Whether to list children of a directory. + * Whether to list children of a directory. */ recursive?: boolean; /** - * @member {FileListFromComputeNodeOptions} [fileListFromComputeNodeOptions] * Additional parameters for the operation */ fileListFromComputeNodeOptions?: FileListFromComputeNodeOptions; } /** - * @interface - * An interface representing FileListFromTaskNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileListFromTaskNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileListFromTaskNextOptions} [fileListFromTaskNextOptions] * Additional parameters for the operation */ fileListFromTaskNextOptions?: FileListFromTaskNextOptions; } /** - * @interface - * An interface representing FileListFromComputeNodeNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface FileListFromComputeNodeNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {FileListFromComputeNodeNextOptions} - * [fileListFromComputeNodeNextOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ fileListFromComputeNodeNextOptions?: FileListFromComputeNodeNextOptions; } /** - * @interface - * An interface representing JobScheduleExistsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleExistsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleExistsOptions} [jobScheduleExistsOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleExistsOptions?: JobScheduleExistsOptions; } /** - * @interface - * An interface representing JobScheduleDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleDeleteMethodOptions} [jobScheduleDeleteMethodOptions] * Additional parameters for the operation */ jobScheduleDeleteMethodOptions?: JobScheduleDeleteMethodOptions; } /** - * @interface - * An interface representing JobScheduleGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleGetOptions} [jobScheduleGetOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleGetOptions?: JobScheduleGetOptions; } /** - * @interface - * An interface representing JobSchedulePatchOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobSchedulePatchOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobSchedulePatchOptions} [jobSchedulePatchOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobSchedulePatchOptions?: JobSchedulePatchOptions; } /** - * @interface - * An interface representing JobScheduleUpdateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleUpdateOptions} [jobScheduleUpdateOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleUpdateOptions?: JobScheduleUpdateOptions; } /** - * @interface - * An interface representing JobScheduleDisableOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleDisableOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleDisableOptions} [jobScheduleDisableOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleDisableOptions?: JobScheduleDisableOptions; } /** - * @interface - * An interface representing JobScheduleEnableOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleEnableOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleEnableOptions} [jobScheduleEnableOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleEnableOptions?: JobScheduleEnableOptions; } /** - * @interface - * An interface representing JobScheduleTerminateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleTerminateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleTerminateOptions} [jobScheduleTerminateOptions] * Additional parameters for the operation */ jobScheduleTerminateOptions?: JobScheduleTerminateOptions; } /** - * @interface - * An interface representing JobScheduleAddOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleAddOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleAddOptions} [jobScheduleAddOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleAddOptions?: JobScheduleAddOptions; } /** - * @interface - * An interface representing JobScheduleListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleListOptions} [jobScheduleListOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ jobScheduleListOptions?: JobScheduleListOptions; } /** - * @interface - * An interface representing JobScheduleListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface JobScheduleListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {JobScheduleListNextOptions} [jobScheduleListNextOptions] * Additional parameters for the operation */ jobScheduleListNextOptions?: JobScheduleListNextOptions; } /** - * @interface - * An interface representing TaskAddOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskAddOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskAddOptions} [taskAddOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ taskAddOptions?: TaskAddOptions; } /** - * @interface - * An interface representing TaskListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskListOptions} [taskListOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ taskListOptions?: TaskListOptions; } /** - * @interface - * An interface representing TaskAddCollectionOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskAddCollectionOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskAddCollectionOptions} [taskAddCollectionOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ taskAddCollectionOptions?: TaskAddCollectionOptions; } /** - * @interface - * An interface representing TaskDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskDeleteMethodOptions} [taskDeleteMethodOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ taskDeleteMethodOptions?: TaskDeleteMethodOptions; } /** - * @interface - * An interface representing TaskGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskGetOptions} [taskGetOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ taskGetOptions?: TaskGetOptions; } /** - * @interface - * An interface representing TaskUpdateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskConstraints} [constraints] Constraints that apply to this - * task. If omitted, the task is given the default constraints. For - * multi-instance tasks, updating the retention time applies only to the - * primary task and not subtasks. + * Constraints that apply to this task. If omitted, the task is given the default constraints. + * For multi-instance tasks, updating the retention time applies only to the primary task and not + * subtasks. */ constraints?: TaskConstraints; /** - * @member {TaskUpdateOptions} [taskUpdateOptions] Additional parameters for - * the operation + * Additional parameters for the operation */ taskUpdateOptions?: TaskUpdateOptions; } /** - * @interface - * An interface representing TaskListSubtasksOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskListSubtasksOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskListSubtasksOptions} [taskListSubtasksOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ taskListSubtasksOptions?: TaskListSubtasksOptions; } /** - * @interface - * An interface representing TaskTerminateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskTerminateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskTerminateOptions} [taskTerminateOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ taskTerminateOptions?: TaskTerminateOptions; } /** - * @interface - * An interface representing TaskReactivateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskReactivateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskReactivateOptions} [taskReactivateOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ taskReactivateOptions?: TaskReactivateOptions; } /** - * @interface - * An interface representing TaskListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface TaskListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {TaskListNextOptions} [taskListNextOptions] Additional parameters - * for the operation + * Additional parameters for the operation */ taskListNextOptions?: TaskListNextOptions; } /** - * @interface - * An interface representing ComputeNodeAddUserOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeAddUserOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeAddUserOptions} [computeNodeAddUserOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ computeNodeAddUserOptions?: ComputeNodeAddUserOptions; } /** - * @interface - * An interface representing ComputeNodeDeleteUserOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeDeleteUserOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeDeleteUserOptions} [computeNodeDeleteUserOptions] * Additional parameters for the operation */ computeNodeDeleteUserOptions?: ComputeNodeDeleteUserOptions; } /** - * @interface - * An interface representing ComputeNodeUpdateUserOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeUpdateUserOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeUpdateUserOptions} [computeNodeUpdateUserOptions] * Additional parameters for the operation */ computeNodeUpdateUserOptions?: ComputeNodeUpdateUserOptions; } /** - * @interface - * An interface representing ComputeNodeGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeGetOptions} [computeNodeGetOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ computeNodeGetOptions?: ComputeNodeGetOptions; } /** - * @interface - * An interface representing ComputeNodeRebootOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeRebootOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeRebootOption} [nodeRebootOption] When to reboot the - * compute node and what to do with currently running tasks. The default - * value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion', 'retainedData' + * When to reboot the compute node and what to do with currently running tasks. The default value + * is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' */ nodeRebootOption?: ComputeNodeRebootOption; /** - * @member {ComputeNodeRebootOptions} [computeNodeRebootOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ computeNodeRebootOptions?: ComputeNodeRebootOptions; } /** - * @interface - * An interface representing ComputeNodeReimageOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeReimageOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeReimageOption} [nodeReimageOption] When to reimage the - * compute node and what to do with currently running tasks. The default - * value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion', 'retainedData' + * When to reimage the compute node and what to do with currently running tasks. The default + * value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', + * 'retainedData' */ nodeReimageOption?: ComputeNodeReimageOption; /** - * @member {ComputeNodeReimageOptions} [computeNodeReimageOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ computeNodeReimageOptions?: ComputeNodeReimageOptions; } /** - * @interface - * An interface representing ComputeNodeDisableSchedulingOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeDisableSchedulingOptionalParams extends msRest.RequestOptionsBase { /** - * @member {DisableComputeNodeSchedulingOption} [nodeDisableSchedulingOption] - * What to do with currently running tasks when disabling task scheduling on - * the compute node. The default value is requeue. Possible values include: - * 'requeue', 'terminate', 'taskCompletion' + * What to do with currently running tasks when disabling task scheduling on the compute node. + * The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion' */ nodeDisableSchedulingOption?: DisableComputeNodeSchedulingOption; /** - * @member {ComputeNodeDisableSchedulingOptions} - * [computeNodeDisableSchedulingOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ computeNodeDisableSchedulingOptions?: ComputeNodeDisableSchedulingOptions; } /** - * @interface - * An interface representing ComputeNodeEnableSchedulingOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeEnableSchedulingOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeEnableSchedulingOptions} - * [computeNodeEnableSchedulingOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ computeNodeEnableSchedulingOptions?: ComputeNodeEnableSchedulingOptions; } /** - * @interface - * An interface representing ComputeNodeGetRemoteLoginSettingsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeGetRemoteLoginSettingsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeGetRemoteLoginSettingsOptions} - * [computeNodeGetRemoteLoginSettingsOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ computeNodeGetRemoteLoginSettingsOptions?: ComputeNodeGetRemoteLoginSettingsOptions; } /** - * @interface - * An interface representing ComputeNodeGetRemoteDesktopOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeGetRemoteDesktopOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeGetRemoteDesktopOptions} - * [computeNodeGetRemoteDesktopOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ computeNodeGetRemoteDesktopOptions?: ComputeNodeGetRemoteDesktopOptions; } /** - * @interface - * An interface representing ComputeNodeUploadBatchServiceLogsOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeUploadBatchServiceLogsOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeUploadBatchServiceLogsOptions} - * [computeNodeUploadBatchServiceLogsOptions] Additional parameters for the - * operation + * Additional parameters for the operation */ computeNodeUploadBatchServiceLogsOptions?: ComputeNodeUploadBatchServiceLogsOptions; } /** - * @interface - * An interface representing ComputeNodeListOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeListOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeListOptions} [computeNodeListOptions] Additional - * parameters for the operation + * Additional parameters for the operation */ computeNodeListOptions?: ComputeNodeListOptions; } /** - * @interface - * An interface representing ComputeNodeListNextOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface ComputeNodeListNextOptionalParams extends msRest.RequestOptionsBase { /** - * @member {ComputeNodeListNextOptions} [computeNodeListNextOptions] * Additional parameters for the operation */ computeNodeListNextOptions?: ComputeNodeListNextOptions; } /** - * @interface - * An interface representing BatchServiceClientOptions. - * @extends AzureServiceClientOptions - */ -export interface BatchServiceClientOptions extends AzureServiceClientOptions { - /** - * @member {string} [baseUri] - */ - baseUri?: string; -} - -/** - * @interface - * An interface representing ApplicationListHeaders. * Defines headers for List operation. - * */ export interface ApplicationListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing ApplicationGetHeaders. * Defines headers for Get operation. - * */ export interface ApplicationGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing PoolListUsageMetricsHeaders. * Defines headers for ListUsageMetrics operation. - * */ export interface PoolListUsageMetricsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing AccountListNodeAgentSkusHeaders. * Defines headers for ListNodeAgentSkus operation. - * */ export interface AccountListNodeAgentSkusHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing AccountListPoolNodeCountsHeaders. * Defines headers for ListPoolNodeCounts operation. - * */ export interface AccountListPoolNodeCountsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing PoolGetAllLifetimeStatisticsHeaders. * Defines headers for GetAllLifetimeStatistics operation. - * */ export interface PoolGetAllLifetimeStatisticsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobGetAllLifetimeStatisticsHeaders. * Defines headers for GetAllLifetimeStatistics operation. - * */ export interface JobGetAllLifetimeStatisticsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing CertificateAddHeaders. * Defines headers for Add operation. - * */ export interface CertificateAddHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing CertificateListHeaders. * Defines headers for List operation. - * */ export interface CertificateListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing CertificateCancelDeletionHeaders. * Defines headers for CancelDeletion operation. - * */ export interface CertificateCancelDeletionHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing CertificateDeleteHeaders. * Defines headers for Delete operation. - * */ export interface CertificateDeleteHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing CertificateGetHeaders. * Defines headers for Get operation. - * */ export interface CertificateGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing FileDeleteFromTaskHeaders. * Defines headers for DeleteFromTask operation. - * */ export interface FileDeleteFromTaskHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing FileGetFromTaskHeaders. * Defines headers for GetFromTask operation. - * */ export interface FileGetFromTaskHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {Date} [ocpCreationTime] The file creation time. + * The file creation time. */ ocpCreationTime: Date; /** - * @member {boolean} [ocpBatchFileIsdirectory] Whether the object represents - * a directory. + * Whether the object represents a directory. */ ocpBatchFileIsdirectory: boolean; /** - * @member {string} [ocpBatchFileUrl] The URL of the file. + * The URL of the file. */ ocpBatchFileUrl: string; /** - * @member {string} [ocpBatchFileMode] The file mode attribute in octal - * format. + * The file mode attribute in octal format. */ ocpBatchFileMode: string; /** - * @member {string} [contentType] The content type of the file. + * The content type of the file. */ contentType: string; /** - * @member {number} [contentLength] The length of the file. + * The length of the file. */ contentLength: number; } /** - * @interface - * An interface representing FileGetPropertiesFromTaskHeaders. * Defines headers for GetPropertiesFromTask operation. - * */ export interface FileGetPropertiesFromTaskHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {Date} [ocpCreationTime] The file creation time. + * The file creation time. */ ocpCreationTime: Date; /** - * @member {boolean} [ocpBatchFileIsdirectory] Whether the object represents - * a directory. + * Whether the object represents a directory. */ ocpBatchFileIsdirectory: boolean; /** - * @member {string} [ocpBatchFileUrl] The URL of the file. + * The URL of the file. */ ocpBatchFileUrl: string; /** - * @member {string} [ocpBatchFileMode] The file mode attribute in octal - * format. + * The file mode attribute in octal format. */ ocpBatchFileMode: string; /** - * @member {string} [contentType] The content type of the file. + * The content type of the file. */ contentType: string; /** - * @member {number} [contentLength] The length of the file. + * The length of the file. */ contentLength: number; } /** - * @interface - * An interface representing FileDeleteFromComputeNodeHeaders. * Defines headers for DeleteFromComputeNode operation. - * */ export interface FileDeleteFromComputeNodeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing FileGetFromComputeNodeHeaders. * Defines headers for GetFromComputeNode operation. - * */ export interface FileGetFromComputeNodeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {Date} [ocpCreationTime] The file creation time. + * The file creation time. */ ocpCreationTime: Date; /** - * @member {boolean} [ocpBatchFileIsdirectory] Whether the object represents - * a directory. + * Whether the object represents a directory. */ ocpBatchFileIsdirectory: boolean; /** - * @member {string} [ocpBatchFileUrl] The URL of the file. + * The URL of the file. */ ocpBatchFileUrl: string; /** - * @member {string} [ocpBatchFileMode] The file mode attribute in octal - * format. + * The file mode attribute in octal format. */ ocpBatchFileMode: string; /** - * @member {string} [contentType] The content type of the file. + * The content type of the file. */ contentType: string; /** - * @member {number} [contentLength] The length of the file. + * The length of the file. */ contentLength: number; } /** - * @interface - * An interface representing FileGetPropertiesFromComputeNodeHeaders. * Defines headers for GetPropertiesFromComputeNode operation. - * */ export interface FileGetPropertiesFromComputeNodeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {Date} [ocpCreationTime] The file creation time. + * The file creation time. */ ocpCreationTime: Date; /** - * @member {boolean} [ocpBatchFileIsdirectory] Whether the object represents - * a directory. + * Whether the object represents a directory. */ ocpBatchFileIsdirectory: boolean; /** - * @member {string} [ocpBatchFileUrl] The URL of the file. + * The URL of the file. */ ocpBatchFileUrl: string; /** - * @member {string} [ocpBatchFileMode] The file mode attribute in octal - * format. + * The file mode attribute in octal format. */ ocpBatchFileMode: string; /** - * @member {string} [contentType] The content type of the file. + * The content type of the file. */ contentType: string; /** - * @member {number} [contentLength] The length of the file. + * The length of the file. */ contentLength: number; } /** - * @interface - * An interface representing FileListFromTaskHeaders. * Defines headers for ListFromTask operation. - * */ export interface FileListFromTaskHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing FileListFromComputeNodeHeaders. * Defines headers for ListFromComputeNode operation. - * */ export interface FileListFromComputeNodeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobScheduleExistsHeaders. * Defines headers for Exists operation. - * */ export interface JobScheduleExistsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobScheduleDeleteHeaders. * Defines headers for Delete operation. - * */ export interface JobScheduleDeleteHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing JobScheduleGetHeaders. * Defines headers for Get operation. - * */ export interface JobScheduleGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTagHeader] The ETag HTTP response header. This is an - * opaque string. You can use it to detect whether the resource has changed - * between requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTagHeader: string; /** - * @member {Date} [lastModifiedHeader] The time at which the resource was - * last modified. + * The time at which the resource was last modified. */ lastModifiedHeader: Date; } /** - * @interface - * An interface representing JobSchedulePatchHeaders. * Defines headers for Patch operation. - * */ export interface JobSchedulePatchHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleUpdateHeaders. * Defines headers for Update operation. - * */ export interface JobScheduleUpdateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleDisableHeaders. * Defines headers for Disable operation. - * */ export interface JobScheduleDisableHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleEnableHeaders. * Defines headers for Enable operation. - * */ export interface JobScheduleEnableHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleTerminateHeaders. * Defines headers for Terminate operation. - * */ export interface JobScheduleTerminateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleAddHeaders. * Defines headers for Add operation. - * */ export interface JobScheduleAddHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobScheduleListHeaders. * Defines headers for List operation. - * */ export interface JobScheduleListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobDeleteHeaders. * Defines headers for Delete operation. - * */ export interface JobDeleteHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing JobGetHeaders. * Defines headers for Get operation. - * */ export interface JobGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTagHeader] The ETag HTTP response header. This is an - * opaque string. You can use it to detect whether the resource has changed - * between requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTagHeader: string; /** - * @member {Date} [lastModifiedHeader] The time at which the resource was - * last modified. + * The time at which the resource was last modified. */ lastModifiedHeader: Date; } /** - * @interface - * An interface representing JobPatchHeaders. * Defines headers for Patch operation. - * */ export interface JobPatchHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobUpdateHeaders. * Defines headers for Update operation. - * */ export interface JobUpdateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobDisableHeaders. * Defines headers for Disable operation. - * */ export interface JobDisableHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobEnableHeaders. * Defines headers for Enable operation. - * */ export interface JobEnableHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobTerminateHeaders. * Defines headers for Terminate operation. - * */ export interface JobTerminateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobAddHeaders. * Defines headers for Add operation. - * */ export interface JobAddHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing JobListHeaders. * Defines headers for List operation. - * */ export interface JobListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobListFromJobScheduleHeaders. * Defines headers for ListFromJobSchedule operation. - * */ export interface JobListFromJobScheduleHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobListPreparationAndReleaseTaskStatusHeaders. * Defines headers for ListPreparationAndReleaseTaskStatus operation. - * */ export interface JobListPreparationAndReleaseTaskStatusHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing JobGetTaskCountsHeaders. * Defines headers for GetTaskCounts operation. - * */ export interface JobGetTaskCountsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing PoolAddHeaders. * Defines headers for Add operation. - * */ export interface PoolAddHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolListHeaders. * Defines headers for List operation. - * */ export interface PoolListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing PoolDeleteHeaders. * Defines headers for Delete operation. - * */ export interface PoolDeleteHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing PoolExistsHeaders. * Defines headers for Exists operation. - * */ export interface PoolExistsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing PoolGetHeaders. * Defines headers for Get operation. - * */ export interface PoolGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTagHeader] The ETag HTTP response header. This is an - * opaque string. You can use it to detect whether the resource has changed - * between requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTagHeader: string; /** - * @member {Date} [lastModifiedHeader] The time at which the resource was - * last modified. + * The time at which the resource was last modified. */ lastModifiedHeader: Date; } /** - * @interface - * An interface representing PoolPatchHeaders. * Defines headers for Patch operation. - * */ export interface PoolPatchHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolDisableAutoScaleHeaders. * Defines headers for DisableAutoScale operation. - * */ export interface PoolDisableAutoScaleHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolEnableAutoScaleHeaders. * Defines headers for EnableAutoScale operation. - * */ export interface PoolEnableAutoScaleHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolEvaluateAutoScaleHeaders. * Defines headers for EvaluateAutoScale operation. - * */ export interface PoolEvaluateAutoScaleHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolResizeHeaders. * Defines headers for Resize operation. - * */ export interface PoolResizeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolStopResizeHeaders. * Defines headers for StopResize operation. - * */ export interface PoolStopResizeHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolUpdatePropertiesHeaders. * Defines headers for UpdateProperties operation. - * */ export interface PoolUpdatePropertiesHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. - */ - clientRequestId: string; - /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. - */ - requestId: string; - /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the - * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. - */ - eTag: string; - /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. - */ - lastModified: Date; - /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. - */ - dataServiceId: string; -} - -/** - * @interface - * An interface representing PoolUpgradeOSHeaders. - * Defines headers for UpgradeOS operation. - * - */ -export interface PoolUpgradeOSHeaders { - /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing PoolRemoveNodesHeaders. * Defines headers for RemoveNodes operation. - * */ export interface PoolRemoveNodesHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing TaskAddHeaders. * Defines headers for Add operation. - * */ export interface TaskAddHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing TaskListHeaders. * Defines headers for List operation. - * */ export interface TaskListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing TaskAddCollectionHeaders. * Defines headers for AddCollection operation. - * */ export interface TaskAddCollectionHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing TaskDeleteHeaders. * Defines headers for Delete operation. - * */ export interface TaskDeleteHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing TaskGetHeaders. * Defines headers for Get operation. - * */ export interface TaskGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTagHeader] The ETag HTTP response header. This is an - * opaque string. You can use it to detect whether the resource has changed - * between requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTagHeader: string; /** - * @member {Date} [lastModifiedHeader] The time at which the resource was - * last modified. + * The time at which the resource was last modified. */ lastModifiedHeader: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing TaskUpdateHeaders. * Defines headers for Update operation. - * */ export interface TaskUpdateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing TaskListSubtasksHeaders. * Defines headers for ListSubtasks operation. - * */ export interface TaskListSubtasksHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing TaskTerminateHeaders. * Defines headers for Terminate operation. - * */ export interface TaskTerminateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing TaskReactivateHeaders. * Defines headers for Reactivate operation. - * */ export interface TaskReactivateHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeAddUserHeaders. * Defines headers for AddUser operation. - * */ export interface ComputeNodeAddUserHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeDeleteUserHeaders. * Defines headers for DeleteUser operation. - * */ export interface ComputeNodeDeleteUserHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing ComputeNodeUpdateUserHeaders. * Defines headers for UpdateUser operation. - * */ export interface ComputeNodeUpdateUserHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeGetHeaders. * Defines headers for Get operation. - * */ export interface ComputeNodeGetHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing ComputeNodeRebootHeaders. * Defines headers for Reboot operation. - * */ export interface ComputeNodeRebootHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeReimageHeaders. * Defines headers for Reimage operation. - * */ export interface ComputeNodeReimageHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeDisableSchedulingHeaders. * Defines headers for DisableScheduling operation. - * */ export interface ComputeNodeDisableSchedulingHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeEnableSchedulingHeaders. * Defines headers for EnableScheduling operation. - * */ export interface ComputeNodeEnableSchedulingHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; /** - * @member {string} [dataServiceId] The OData ID of the resource to which the - * request applied. + * The OData ID of the resource to which the request applied. */ dataServiceId: string; } /** - * @interface - * An interface representing ComputeNodeGetRemoteLoginSettingsHeaders. * Defines headers for GetRemoteLoginSettings operation. - * */ export interface ComputeNodeGetRemoteLoginSettingsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing ComputeNodeGetRemoteDesktopHeaders. * Defines headers for GetRemoteDesktop operation. - * */ export interface ComputeNodeGetRemoteDesktopHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } /** - * @interface - * An interface representing ComputeNodeUploadBatchServiceLogsHeaders. * Defines headers for UploadBatchServiceLogs operation. - * */ export interface ComputeNodeUploadBatchServiceLogsHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; } /** - * @interface - * An interface representing ComputeNodeListHeaders. * Defines headers for List operation. - * */ export interface ComputeNodeListHeaders { /** - * @member {string} [clientRequestId] The client-request-id provided by the - * client during the request. This will be returned only if the - * return-client-request-id parameter was set to true. + * The client-request-id provided by the client during the request. This will be returned only if + * the return-client-request-id parameter was set to true. */ clientRequestId: string; /** - * @member {string} [requestId] A unique identifier for the request that was - * made to the Batch service. If a request is consistently failing and you - * have verified that the request is properly formulated, you may use this - * value to report the error to Microsoft. In your report, include the value - * of this request ID, the approximate time that the request was made, the - * Batch account against which the request was made, and the region that - * account resides in. + * A unique identifier for the request that was made to the Batch service. If a request is + * consistently failing and you have verified that the request is properly formulated, you may + * use this value to report the error to Microsoft. In your report, include the value of this + * request ID, the approximate time that the request was made, the Batch account against which + * the request was made, and the region that account resides in. */ requestId: string; /** - * @member {string} [eTag] The ETag HTTP response header. This is an opaque - * string. You can use it to detect whether the resource has changed between - * requests. In particular, you can pass the ETag to one of the + * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the + * resource has changed between requests. In particular, you can pass the ETag to one of the * If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. */ eTag: string; /** - * @member {Date} [lastModified] The time at which the resource was last - * modified. + * The time at which the resource was last modified. */ lastModified: Date; } - /** * @interface * An interface representing the ApplicationListResult. * @summary The result of listing the applications available in an account. - * * @extends Array */ export interface ApplicationListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14196,13 +11205,9 @@ export interface ApplicationListResult extends Array { * @interface * An interface representing the PoolListUsageMetricsResult. * @summary The result of a listing the usage metrics for an account. - * * @extends Array */ export interface PoolListUsageMetricsResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14210,13 +11215,9 @@ export interface PoolListUsageMetricsResult extends Array { * @interface * An interface representing the CloudPoolListResult. * @summary The result of listing the pools in an account. - * * @extends Array */ export interface CloudPoolListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14224,13 +11225,9 @@ export interface CloudPoolListResult extends Array { * @interface * An interface representing the AccountListNodeAgentSkusResult. * @summary The result of listing the supported node agent SKUs. - * * @extends Array */ export interface AccountListNodeAgentSkusResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14238,13 +11235,9 @@ export interface AccountListNodeAgentSkusResult extends Array { * @interface * An interface representing the PoolNodeCountsListResult. * @summary The result of listing the node counts in the account. - * * @extends Array */ export interface PoolNodeCountsListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14252,28 +11245,20 @@ export interface PoolNodeCountsListResult extends Array { * @interface * An interface representing the CloudJobListResult. * @summary The result of listing the jobs in an account. - * * @extends Array */ export interface CloudJobListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } /** * @interface * An interface representing the CloudJobListPreparationAndReleaseTaskStatusResult. - * @summary The result of listing the status of the Job Preparation and Job - * Release tasks for a job. - * + * @summary The result of listing the status of the Job Preparation and Job Release tasks for a + * job. * @extends Array */ export interface CloudJobListPreparationAndReleaseTaskStatusResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14281,28 +11266,20 @@ export interface CloudJobListPreparationAndReleaseTaskStatusResult extends Array * @interface * An interface representing the CertificateListResult. * @summary The result of listing the certificates in the account. - * * @extends Array */ export interface CertificateListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } /** * @interface * An interface representing the NodeFileListResult. - * @summary The result of listing the files on a compute node, or the files - * associated with a task on a node. - * + * @summary The result of listing the files on a compute node, or the files associated with a task + * on a node. * @extends Array */ export interface NodeFileListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14310,13 +11287,9 @@ export interface NodeFileListResult extends Array { * @interface * An interface representing the CloudJobScheduleListResult. * @summary The result of listing the job schedules in an account. - * * @extends Array */ export interface CloudJobScheduleListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14324,13 +11297,9 @@ export interface CloudJobScheduleListResult extends Array { * @interface * An interface representing the CloudTaskListResult. * @summary The result of listing the tasks in a job. - * * @extends Array */ export interface CloudTaskListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14338,13 +11307,9 @@ export interface CloudTaskListResult extends Array { * @interface * An interface representing the ComputeNodeListResult. * @summary The result of listing the compute nodes in a pool. - * * @extends Array */ export interface ComputeNodeListResult extends Array { - /** - * @member {string} [odatanextLink] - */ odatanextLink?: string; } @@ -14412,6 +11377,14 @@ export type AutoUserScope = 'task' | 'pool'; */ export type ElevationLevel = 'nonadmin' | 'admin'; +/** + * Defines values for LoginMode. + * Possible values include: 'batch', 'interactive' + * @readonly + * @enum {string} + */ +export type LoginMode = 'batch' | 'interactive'; + /** * Defines values for OutputFileUploadCondition. * Possible values include: 'taskSuccess', 'taskFailure', 'taskCompletion' @@ -14460,6 +11433,14 @@ export type CachingType = 'none' | 'readonly' | 'readwrite'; */ export type StorageAccountType = 'standard_lrs' | 'premium_lrs'; +/** + * Defines values for DynamicVNetAssignmentScope. + * Possible values include: 'none', 'job' + * @readonly + * @enum {string} + */ +export type DynamicVNetAssignmentScope = 'none' | 'job'; + /** * Defines values for InboundEndpointProtocol. * Possible values include: 'tcp', 'udp' @@ -14551,11 +11532,11 @@ export type JobReleaseTaskState = 'running' | 'completed'; /** * Defines values for PoolState. - * Possible values include: 'active', 'deleting', 'upgrading' + * Possible values include: 'active', 'deleting' * @readonly * @enum {string} */ -export type PoolState = 'active' | 'deleting' | 'upgrading'; +export type PoolState = 'active' | 'deleting'; /** * Defines values for AllocationState. @@ -14667,10 +11648,12 @@ export type ApplicationListResponse = ApplicationListResult & ApplicationListHea * The parsed HTTP response headers. */ parsedHeaders: ApplicationListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14690,10 +11673,12 @@ export type ApplicationGetResponse = ApplicationSummary & ApplicationGetHeaders * The parsed HTTP response headers. */ parsedHeaders: ApplicationGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14713,10 +11698,12 @@ export type PoolListUsageMetricsResponse = PoolListUsageMetricsResult & PoolList * The parsed HTTP response headers. */ parsedHeaders: PoolListUsageMetricsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14736,10 +11723,12 @@ export type PoolGetAllLifetimeStatisticsResponse = PoolStatistics & PoolGetAllLi * The parsed HTTP response headers. */ parsedHeaders: PoolGetAllLifetimeStatisticsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14774,10 +11763,12 @@ export type PoolListResponse = CloudPoolListResult & PoolListHeaders & { * The parsed HTTP response headers. */ parsedHeaders: PoolListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14808,6 +11799,7 @@ export type PoolExistsResponse = PoolExistsHeaders & { * The parsed response body. */ body: boolean; + /** * The underlying HTTP response. */ @@ -14816,10 +11808,12 @@ export type PoolExistsResponse = PoolExistsHeaders & { * The parsed HTTP response headers. */ parsedHeaders: PoolExistsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14839,10 +11833,12 @@ export type PoolGetResponse = CloudPool & PoolGetHeaders & { * The parsed HTTP response headers. */ parsedHeaders: PoolGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14907,10 +11903,12 @@ export type PoolEvaluateAutoScaleResponse = AutoScaleRun & PoolEvaluateAutoScale * The parsed HTTP response headers. */ parsedHeaders: PoolEvaluateAutoScaleHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -14963,21 +11961,6 @@ export type PoolUpdatePropertiesResponse = PoolUpdatePropertiesHeaders & { }; }; -/** - * Contains response data for the upgradeOS operation. - */ -export type PoolUpgradeOSResponse = PoolUpgradeOSHeaders & { - /** - * The underlying HTTP response. - */ - _response: msRest.HttpResponse & { - /** - * The parsed HTTP response headers. - */ - parsedHeaders: PoolUpgradeOSHeaders; - }; -}; - /** * Contains response data for the removeNodes operation. */ @@ -15005,10 +11988,12 @@ export type AccountListNodeAgentSkusResponse = AccountListNodeAgentSkusResult & * The parsed HTTP response headers. */ parsedHeaders: AccountListNodeAgentSkusHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15028,10 +12013,12 @@ export type AccountListPoolNodeCountsResponse = PoolNodeCountsListResult & Accou * The parsed HTTP response headers. */ parsedHeaders: AccountListPoolNodeCountsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15051,10 +12038,12 @@ export type JobGetAllLifetimeStatisticsResponse = JobStatistics & JobGetAllLifet * The parsed HTTP response headers. */ parsedHeaders: JobGetAllLifetimeStatisticsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15089,10 +12078,12 @@ export type JobGetResponse = CloudJob & JobGetHeaders & { * The parsed HTTP response headers. */ parsedHeaders: JobGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15202,10 +12193,12 @@ export type JobListResponse = CloudJobListResult & JobListHeaders & { * The parsed HTTP response headers. */ parsedHeaders: JobListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15225,10 +12218,12 @@ export type JobListFromJobScheduleResponse = CloudJobListResult & JobListFromJob * The parsed HTTP response headers. */ parsedHeaders: JobListFromJobScheduleHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15248,10 +12243,12 @@ export type JobListPreparationAndReleaseTaskStatusResponse = CloudJobListPrepara * The parsed HTTP response headers. */ parsedHeaders: JobListPreparationAndReleaseTaskStatusHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15271,10 +12268,12 @@ export type JobGetTaskCountsResponse = TaskCounts & JobGetTaskCountsHeaders & { * The parsed HTTP response headers. */ parsedHeaders: JobGetTaskCountsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15309,10 +12308,12 @@ export type CertificateListResponse = CertificateListResult & CertificateListHea * The parsed HTTP response headers. */ parsedHeaders: CertificateListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15362,10 +12363,12 @@ export type CertificateGetResponse = Certificate & CertificateGetHeaders & { * The parsed HTTP response headers. */ parsedHeaders: CertificateGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15399,6 +12402,7 @@ export type FileGetFromTaskResponse = FileGetFromTaskHeaders & { * Always undefined in node.js. */ blobBody?: Promise; + /** * NODEJS ONLY * @@ -15406,6 +12410,7 @@ export type FileGetFromTaskResponse = FileGetFromTaskHeaders & { * Always undefined in the browser. */ readableStreamBody?: NodeJS.ReadableStream; + /** * The underlying HTTP response. */ @@ -15458,6 +12463,7 @@ export type FileGetFromComputeNodeResponse = FileGetFromComputeNodeHeaders & { * Always undefined in node.js. */ blobBody?: Promise; + /** * NODEJS ONLY * @@ -15465,6 +12471,7 @@ export type FileGetFromComputeNodeResponse = FileGetFromComputeNodeHeaders & { * Always undefined in the browser. */ readableStreamBody?: NodeJS.ReadableStream; + /** * The underlying HTTP response. */ @@ -15503,10 +12510,12 @@ export type FileListFromTaskResponse = NodeFileListResult & FileListFromTaskHead * The parsed HTTP response headers. */ parsedHeaders: FileListFromTaskHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15526,10 +12535,12 @@ export type FileListFromComputeNodeResponse = NodeFileListResult & FileListFromC * The parsed HTTP response headers. */ parsedHeaders: FileListFromComputeNodeHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15545,6 +12556,7 @@ export type JobScheduleExistsResponse = JobScheduleExistsHeaders & { * The parsed response body. */ body: boolean; + /** * The underlying HTTP response. */ @@ -15553,10 +12565,12 @@ export type JobScheduleExistsResponse = JobScheduleExistsHeaders & { * The parsed HTTP response headers. */ parsedHeaders: JobScheduleExistsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15591,10 +12605,12 @@ export type JobScheduleGetResponse = CloudJobSchedule & JobScheduleGetHeaders & * The parsed HTTP response headers. */ parsedHeaders: JobScheduleGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15704,10 +12720,12 @@ export type JobScheduleListResponse = CloudJobScheduleListResult & JobScheduleLi * The parsed HTTP response headers. */ parsedHeaders: JobScheduleListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15742,10 +12760,12 @@ export type TaskListResponse = CloudTaskListResult & TaskListHeaders & { * The parsed HTTP response headers. */ parsedHeaders: TaskListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15765,10 +12785,12 @@ export type TaskAddCollectionResponse = TaskAddCollectionResult & TaskAddCollect * The parsed HTTP response headers. */ parsedHeaders: TaskAddCollectionHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15803,10 +12825,12 @@ export type TaskGetResponse = CloudTask & TaskGetHeaders & { * The parsed HTTP response headers. */ parsedHeaders: TaskGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15841,10 +12865,12 @@ export type TaskListSubtasksResponse = CloudTaskListSubtasksResult & TaskListSub * The parsed HTTP response headers. */ parsedHeaders: TaskListSubtasksHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -15939,10 +12965,12 @@ export type ComputeNodeGetResponse = ComputeNode & ComputeNodeGetHeaders & { * The parsed HTTP response headers. */ parsedHeaders: ComputeNodeGetHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -16022,10 +13050,12 @@ export type ComputeNodeGetRemoteLoginSettingsResponse = ComputeNodeGetRemoteLogi * The parsed HTTP response headers. */ parsedHeaders: ComputeNodeGetRemoteLoginSettingsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -16044,6 +13074,7 @@ export type ComputeNodeGetRemoteDesktopResponse = ComputeNodeGetRemoteDesktopHea * Always undefined in node.js. */ blobBody?: Promise; + /** * NODEJS ONLY * @@ -16051,6 +13082,7 @@ export type ComputeNodeGetRemoteDesktopResponse = ComputeNodeGetRemoteDesktopHea * Always undefined in the browser. */ readableStreamBody?: NodeJS.ReadableStream; + /** * The underlying HTTP response. */ @@ -16074,10 +13106,12 @@ export type ComputeNodeUploadBatchServiceLogsResponse = UploadBatchServiceLogsRe * The parsed HTTP response headers. */ parsedHeaders: ComputeNodeUploadBatchServiceLogsHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -16097,10 +13131,12 @@ export type ComputeNodeListResponse = ComputeNodeListResult & ComputeNodeListHea * The parsed HTTP response headers. */ parsedHeaders: ComputeNodeListHeaders; + /** * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ diff --git a/sdk/batch/batch/src/models/jobMappers.ts b/sdk/batch/batch/src/models/jobMappers.ts index 371d5e7a8e9a..3a5170c80824 100644 --- a/sdk/batch/batch/src/models/jobMappers.ts +++ b/sdk/batch/batch/src/models/jobMappers.ts @@ -1,84 +1,82 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - JobStatistics, - JobGetAllLifetimeStatisticsHeaders, + ApplicationPackageReference, + AuthenticationTokenSettings, + AutoPoolSpecification, + AutoUserSpecification, BatchError, - ErrorMessage, BatchErrorDetail, - JobDeleteHeaders, + CertificateReference, CloudJob, - JobConstraints, - JobManagerTask, - TaskContainerSettings, + CloudJobListPreparationAndReleaseTaskStatusResult, + CloudJobListResult, + CloudServiceConfiguration, + ContainerConfiguration, ContainerRegistry, - ResourceFile, - OutputFile, - OutputFileDestination, - OutputFileBlobContainerDestination, - OutputFileUploadOptions, + DataDisk, EnvironmentSetting, - TaskConstraints, - UserIdentity, - AutoUserSpecification, - ApplicationPackageReference, - AuthenticationTokenSettings, - JobPreparationTask, - JobReleaseTask, - PoolInformation, - AutoPoolSpecification, - PoolSpecification, - CloudServiceConfiguration, - VirtualMachineConfiguration, + ErrorMessage, ImageReference, - OSDisk, - WindowsConfiguration, - DataDisk, - ContainerConfiguration, - TaskSchedulingPolicy, - NetworkConfiguration, - PoolEndpointConfiguration, InboundNATPool, - NetworkSecurityGroupRule, - StartTask, - CertificateReference, - UserAccount, - LinuxUserConfiguration, - MetadataItem, - JobExecutionInformation, - JobSchedulingError, - NameValuePair, - JobGetHeaders, - JobPatchParameter, - JobPatchHeaders, - JobUpdateParameter, - JobUpdateHeaders, - JobDisableParameter, + JobAddHeaders, + JobAddParameter, + JobConstraints, + JobDeleteHeaders, JobDisableHeaders, + JobDisableParameter, JobEnableHeaders, - JobTerminateParameter, - JobTerminateHeaders, - JobAddParameter, - JobAddHeaders, - CloudJobListResult, - JobListHeaders, + JobExecutionInformation, + JobGetAllLifetimeStatisticsHeaders, + JobGetHeaders, + JobGetTaskCountsHeaders, JobListFromJobScheduleHeaders, - CloudJobListPreparationAndReleaseTaskStatusResult, + JobListHeaders, + JobListPreparationAndReleaseTaskStatusHeaders, + JobManagerTask, + JobNetworkConfiguration, + JobPatchHeaders, + JobPatchParameter, JobPreparationAndReleaseTaskExecutionInformation, + JobPreparationTask, JobPreparationTaskExecutionInformation, - TaskContainerExecutionInformation, - TaskFailureInformation, + JobReleaseTask, JobReleaseTaskExecutionInformation, - JobListPreparationAndReleaseTaskStatusHeaders, + JobSchedulingError, + JobStatistics, + JobTerminateHeaders, + JobTerminateParameter, + JobUpdateHeaders, + JobUpdateParameter, + LinuxUserConfiguration, + MetadataItem, + NameValuePair, + NetworkConfiguration, + NetworkSecurityGroupRule, + OutputFile, + OutputFileBlobContainerDestination, + OutputFileDestination, + OutputFileUploadOptions, + PoolEndpointConfiguration, + PoolInformation, + PoolSpecification, + ResourceFile, + StartTask, + TaskConstraints, + TaskContainerExecutionInformation, + TaskContainerSettings, TaskCounts, - JobGetTaskCountsHeaders + TaskFailureInformation, + TaskSchedulingPolicy, + UserAccount, + UserIdentity, + VirtualMachineConfiguration, + WindowsConfiguration, + WindowsUserConfiguration } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/jobScheduleMappers.ts b/sdk/batch/batch/src/models/jobScheduleMappers.ts index 5587978dc8e7..fd98823fb518 100644 --- a/sdk/batch/batch/src/models/jobScheduleMappers.ts +++ b/sdk/batch/batch/src/models/jobScheduleMappers.ts @@ -1,73 +1,71 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - JobScheduleExistsHeaders, + ApplicationPackageReference, + AuthenticationTokenSettings, + AutoPoolSpecification, + AutoUserSpecification, BatchError, - ErrorMessage, BatchErrorDetail, - JobScheduleDeleteHeaders, + CertificateReference, CloudJobSchedule, - Schedule, - JobSpecification, + CloudJobScheduleListResult, + CloudServiceConfiguration, + ContainerConfiguration, + ContainerRegistry, + DataDisk, + EnvironmentSetting, + ErrorMessage, + ImageReference, + InboundNATPool, JobConstraints, JobManagerTask, - TaskContainerSettings, - ContainerRegistry, - ResourceFile, + JobNetworkConfiguration, + JobPreparationTask, + JobReleaseTask, + JobScheduleAddHeaders, + JobScheduleAddParameter, + JobScheduleDeleteHeaders, + JobScheduleDisableHeaders, + JobScheduleEnableHeaders, + JobScheduleExecutionInformation, + JobScheduleExistsHeaders, + JobScheduleGetHeaders, + JobScheduleListHeaders, + JobSchedulePatchHeaders, + JobSchedulePatchParameter, + JobScheduleStatistics, + JobScheduleTerminateHeaders, + JobScheduleUpdateHeaders, + JobScheduleUpdateParameter, + JobSpecification, + LinuxUserConfiguration, + MetadataItem, + NetworkConfiguration, + NetworkSecurityGroupRule, OutputFile, - OutputFileDestination, OutputFileBlobContainerDestination, + OutputFileDestination, OutputFileUploadOptions, - EnvironmentSetting, - TaskConstraints, - UserIdentity, - AutoUserSpecification, - ApplicationPackageReference, - AuthenticationTokenSettings, - JobPreparationTask, - JobReleaseTask, + PoolEndpointConfiguration, PoolInformation, - AutoPoolSpecification, PoolSpecification, - CloudServiceConfiguration, - VirtualMachineConfiguration, - ImageReference, - OSDisk, - WindowsConfiguration, - DataDisk, - ContainerConfiguration, - TaskSchedulingPolicy, - NetworkConfiguration, - PoolEndpointConfiguration, - InboundNATPool, - NetworkSecurityGroupRule, + RecentJob, + ResourceFile, + Schedule, StartTask, - CertificateReference, + TaskConstraints, + TaskContainerSettings, + TaskSchedulingPolicy, UserAccount, - LinuxUserConfiguration, - MetadataItem, - JobScheduleExecutionInformation, - RecentJob, - JobScheduleStatistics, - JobScheduleGetHeaders, - JobSchedulePatchParameter, - JobSchedulePatchHeaders, - JobScheduleUpdateParameter, - JobScheduleUpdateHeaders, - JobScheduleDisableHeaders, - JobScheduleEnableHeaders, - JobScheduleTerminateHeaders, - JobScheduleAddParameter, - JobScheduleAddHeaders, - CloudJobScheduleListResult, - JobScheduleListHeaders + UserIdentity, + VirtualMachineConfiguration, + WindowsConfiguration, + WindowsUserConfiguration } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/mappers.ts b/sdk/batch/batch/src/models/mappers.ts index cb5e1fdd584d..80c68b714832 100644 --- a/sdk/batch/batch/src/models/mappers.ts +++ b/sdk/batch/batch/src/models/mappers.ts @@ -1,11 +1,9 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; @@ -54,20 +52,6 @@ export const PoolUsageMetrics: msRest.CompositeMapper = { type: { name: "Number" } - }, - dataIngressGiB: { - required: true, - serializedName: "dataIngressGiB", - type: { - name: "Number" - } - }, - dataEgressGiB: { - required: true, - serializedName: "dataEgressGiB", - type: { - name: "Number" - } } } } @@ -830,6 +814,23 @@ export const JobConstraints: msRest.CompositeMapper = { } }; +export const JobNetworkConfiguration: msRest.CompositeMapper = { + serializedName: "JobNetworkConfiguration", + type: { + name: "Composite", + className: "JobNetworkConfiguration", + modelProperties: { + subnetId: { + required: true, + serializedName: "subnetId", + type: { + name: "String" + } + } + } + } +}; + export const ContainerRegistry: msRest.CompositeMapper = { serializedName: "ContainerRegistry", type: { @@ -896,15 +897,31 @@ export const ResourceFile: msRest.CompositeMapper = { name: "Composite", className: "ResourceFile", modelProperties: { - blobSource: { - required: true, - serializedName: "blobSource", + autoStorageContainerName: { + serializedName: "autoStorageContainerName", + type: { + name: "String" + } + }, + storageContainerUrl: { + serializedName: "storageContainerUrl", + type: { + name: "String" + } + }, + httpUrl: { + serializedName: "httpUrl", + type: { + name: "String" + } + }, + blobPrefix: { + serializedName: "blobPrefix", type: { name: "String" } }, filePath: { - required: true, serializedName: "filePath", type: { name: "String" @@ -1167,6 +1184,26 @@ export const LinuxUserConfiguration: msRest.CompositeMapper = { } }; +export const WindowsUserConfiguration: msRest.CompositeMapper = { + serializedName: "WindowsUserConfiguration", + type: { + name: "Composite", + className: "WindowsUserConfiguration", + modelProperties: { + loginMode: { + serializedName: "loginMode", + type: { + name: "Enum", + allowedValues: [ + "batch", + "interactive" + ] + } + } + } + } +}; + export const UserAccount: msRest.CompositeMapper = { serializedName: "UserAccount", type: { @@ -1203,6 +1240,13 @@ export const UserAccount: msRest.CompositeMapper = { name: "Composite", className: "LinuxUserConfiguration" } + }, + windowsUserConfiguration: { + serializedName: "windowsUserConfiguration", + type: { + name: "Composite", + className: "WindowsUserConfiguration" + } } } } @@ -1789,15 +1833,8 @@ export const CloudServiceConfiguration: msRest.CompositeMapper = { name: "String" } }, - targetOSVersion: { - serializedName: "targetOSVersion", - type: { - name: "String" - } - }, - currentOSVersion: { - readOnly: true, - serializedName: "currentOSVersion", + osVersion: { + serializedName: "osVersion", type: { name: "String" } @@ -1806,27 +1843,6 @@ export const CloudServiceConfiguration: msRest.CompositeMapper = { } }; -export const OSDisk: msRest.CompositeMapper = { - serializedName: "OSDisk", - type: { - name: "Composite", - className: "OSDisk", - modelProperties: { - caching: { - serializedName: "caching", - type: { - name: "Enum", - allowedValues: [ - "none", - "readonly", - "readwrite" - ] - } - } - } - } -}; - export const WindowsConfiguration: msRest.CompositeMapper = { serializedName: "WindowsConfiguration", type: { @@ -1944,13 +1960,6 @@ export const VirtualMachineConfiguration: msRest.CompositeMapper = { className: "ImageReference" } }, - osDisk: { - serializedName: "osDisk", - type: { - name: "Composite", - className: "OSDisk" - } - }, nodeAgentSKUId: { required: true, serializedName: "nodeAgentSKUId", @@ -2125,6 +2134,16 @@ export const NetworkConfiguration: msRest.CompositeMapper = { name: "String" } }, + dynamicVNetAssignmentScope: { + serializedName: "dynamicVNetAssignmentScope", + type: { + name: "Enum", + allowedValues: [ + "none", + "job" + ] + } + }, endpointConfiguration: { serializedName: "endpointConfiguration", type: { @@ -2408,6 +2427,13 @@ export const JobSpecification: msRest.CompositeMapper = { ] } }, + networkConfiguration: { + serializedName: "networkConfiguration", + type: { + name: "Composite", + className: "JobNetworkConfiguration" + } + }, constraints: { serializedName: "constraints", type: { @@ -3058,6 +3084,13 @@ export const CloudJob: msRest.CompositeMapper = { ] } }, + networkConfiguration: { + serializedName: "networkConfiguration", + type: { + name: "Composite", + className: "JobNetworkConfiguration" + } + }, metadata: { serializedName: "metadata", type: { @@ -3199,6 +3232,13 @@ export const JobAddParameter: msRest.CompositeMapper = { type: { name: "Boolean" } + }, + networkConfiguration: { + serializedName: "networkConfiguration", + type: { + name: "Composite", + className: "JobNetworkConfiguration" + } } } } @@ -3675,8 +3715,7 @@ export const CloudPool: msRest.CompositeMapper = { name: "Enum", allowedValues: [ "active", - "deleting", - "upgrading" + "deleting" ] } }, @@ -5898,23 +5937,6 @@ export const PoolUpdatePropertiesParameter: msRest.CompositeMapper = { } }; -export const PoolUpgradeOSParameter: msRest.CompositeMapper = { - serializedName: "PoolUpgradeOSParameter", - type: { - name: "Composite", - className: "PoolUpgradeOSParameter", - modelProperties: { - targetOSVersion: { - required: true, - serializedName: "targetOSVersion", - type: { - name: "String" - } - } - } - } -}; - export const PoolPatchParameter: msRest.CompositeMapper = { serializedName: "PoolPatchParameter", type: { @@ -7008,57 +7030,6 @@ export const PoolUpdatePropertiesOptions: msRest.CompositeMapper = { } }; -export const PoolUpgradeOSOptions: msRest.CompositeMapper = { - type: { - name: "Composite", - className: "PoolUpgradeOSOptions", - modelProperties: { - timeout: { - defaultValue: 30, - type: { - name: "Number" - } - }, - clientRequestId: { - type: { - name: "Uuid" - } - }, - returnClientRequestId: { - defaultValue: false, - type: { - name: "Boolean" - } - }, - ocpDate: { - type: { - name: "DateTimeRfc1123" - } - }, - ifMatch: { - type: { - name: "String" - } - }, - ifNoneMatch: { - type: { - name: "String" - } - }, - ifModifiedSince: { - type: { - name: "DateTimeRfc1123" - } - }, - ifUnmodifiedSince: { - type: { - name: "DateTimeRfc1123" - } - } - } - } -}; - export const PoolRemoveNodesOptions: msRest.CompositeMapper = { type: { name: "Composite", @@ -11988,46 +11959,6 @@ export const PoolUpdatePropertiesHeaders: msRest.CompositeMapper = { } }; -export const PoolUpgradeOSHeaders: msRest.CompositeMapper = { - serializedName: "pool-upgradeos-headers", - type: { - name: "Composite", - className: "PoolUpgradeOSHeaders", - modelProperties: { - clientRequestId: { - serializedName: "client-request-id", - type: { - name: "Uuid" - } - }, - requestId: { - serializedName: "request-id", - type: { - name: "Uuid" - } - }, - eTag: { - serializedName: "etag", - type: { - name: "String" - } - }, - lastModified: { - serializedName: "last-modified", - type: { - name: "DateTimeRfc1123" - } - }, - dataServiceId: { - serializedName: "dataserviceid", - type: { - name: "String" - } - } - } - } -}; - export const PoolRemoveNodesHeaders: msRest.CompositeMapper = { serializedName: "pool-removenodes-headers", type: { diff --git a/sdk/batch/batch/src/models/parameters.ts b/sdk/batch/batch/src/models/parameters.ts index c51942fbfcc3..4c80b2d3ecf2 100644 --- a/sdk/batch/batch/src/models/parameters.ts +++ b/sdk/batch/batch/src/models/parameters.ts @@ -40,6 +40,18 @@ export const applicationId: msRest.OperationURLParameter = { } } }; +export const batchUrl: msRest.OperationURLParameter = { + parameterPath: "batchUrl", + mapper: { + required: true, + serializedName: "batchUrl", + defaultValue: '', + type: { + name: "String" + } + }, + skipEncoding: true +}; export const clientRequestId0: msRest.OperationParameter = { parameterPath: [ "options", @@ -160,7 +172,7 @@ export const clientRequestId16: msRest.OperationParameter = { export const clientRequestId17: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "clientRequestId" ], mapper: { @@ -173,7 +185,7 @@ export const clientRequestId17: msRest.OperationParameter = { export const clientRequestId18: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "poolListUsageMetricsNextOptions", "clientRequestId" ], mapper: { @@ -186,7 +198,7 @@ export const clientRequestId18: msRest.OperationParameter = { export const clientRequestId19: msRest.OperationParameter = { parameterPath: [ "options", - "poolListUsageMetricsNextOptions", + "poolListNextOptions", "clientRequestId" ], mapper: { @@ -212,7 +224,7 @@ export const clientRequestId2: msRest.OperationParameter = { export const clientRequestId20: msRest.OperationParameter = { parameterPath: [ "options", - "poolListNextOptions", + "accountListNodeAgentSkusOptions", "clientRequestId" ], mapper: { @@ -225,7 +237,7 @@ export const clientRequestId20: msRest.OperationParameter = { export const clientRequestId21: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusOptions", + "accountListPoolNodeCountsOptions", "clientRequestId" ], mapper: { @@ -238,7 +250,7 @@ export const clientRequestId21: msRest.OperationParameter = { export const clientRequestId22: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsOptions", + "accountListNodeAgentSkusNextOptions", "clientRequestId" ], mapper: { @@ -251,7 +263,7 @@ export const clientRequestId22: msRest.OperationParameter = { export const clientRequestId23: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusNextOptions", + "accountListPoolNodeCountsNextOptions", "clientRequestId" ], mapper: { @@ -264,7 +276,7 @@ export const clientRequestId23: msRest.OperationParameter = { export const clientRequestId24: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsNextOptions", + "jobGetAllLifetimeStatisticsOptions", "clientRequestId" ], mapper: { @@ -277,7 +289,7 @@ export const clientRequestId24: msRest.OperationParameter = { export const clientRequestId25: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetAllLifetimeStatisticsOptions", + "jobDeleteMethodOptions", "clientRequestId" ], mapper: { @@ -290,7 +302,7 @@ export const clientRequestId25: msRest.OperationParameter = { export const clientRequestId26: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "clientRequestId" ], mapper: { @@ -303,7 +315,7 @@ export const clientRequestId26: msRest.OperationParameter = { export const clientRequestId27: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "clientRequestId" ], mapper: { @@ -316,7 +328,7 @@ export const clientRequestId27: msRest.OperationParameter = { export const clientRequestId28: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "clientRequestId" ], mapper: { @@ -329,7 +341,7 @@ export const clientRequestId28: msRest.OperationParameter = { export const clientRequestId29: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "clientRequestId" ], mapper: { @@ -355,7 +367,7 @@ export const clientRequestId3: msRest.OperationParameter = { export const clientRequestId30: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "clientRequestId" ], mapper: { @@ -368,7 +380,7 @@ export const clientRequestId30: msRest.OperationParameter = { export const clientRequestId31: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "clientRequestId" ], mapper: { @@ -381,7 +393,7 @@ export const clientRequestId31: msRest.OperationParameter = { export const clientRequestId32: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobAddOptions", "clientRequestId" ], mapper: { @@ -394,7 +406,7 @@ export const clientRequestId32: msRest.OperationParameter = { export const clientRequestId33: msRest.OperationParameter = { parameterPath: [ "options", - "jobAddOptions", + "jobListOptions", "clientRequestId" ], mapper: { @@ -407,7 +419,7 @@ export const clientRequestId33: msRest.OperationParameter = { export const clientRequestId34: msRest.OperationParameter = { parameterPath: [ "options", - "jobListOptions", + "jobListFromJobScheduleOptions", "clientRequestId" ], mapper: { @@ -420,7 +432,7 @@ export const clientRequestId34: msRest.OperationParameter = { export const clientRequestId35: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleOptions", + "jobListPreparationAndReleaseTaskStatusOptions", "clientRequestId" ], mapper: { @@ -433,7 +445,7 @@ export const clientRequestId35: msRest.OperationParameter = { export const clientRequestId36: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusOptions", + "jobGetTaskCountsOptions", "clientRequestId" ], mapper: { @@ -446,7 +458,7 @@ export const clientRequestId36: msRest.OperationParameter = { export const clientRequestId37: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetTaskCountsOptions", + "jobListNextOptions", "clientRequestId" ], mapper: { @@ -459,7 +471,7 @@ export const clientRequestId37: msRest.OperationParameter = { export const clientRequestId38: msRest.OperationParameter = { parameterPath: [ "options", - "jobListNextOptions", + "jobListFromJobScheduleNextOptions", "clientRequestId" ], mapper: { @@ -472,7 +484,7 @@ export const clientRequestId38: msRest.OperationParameter = { export const clientRequestId39: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleNextOptions", + "jobListPreparationAndReleaseTaskStatusNextOptions", "clientRequestId" ], mapper: { @@ -498,7 +510,7 @@ export const clientRequestId4: msRest.OperationParameter = { export const clientRequestId40: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusNextOptions", + "certificateAddOptions", "clientRequestId" ], mapper: { @@ -511,7 +523,7 @@ export const clientRequestId40: msRest.OperationParameter = { export const clientRequestId41: msRest.OperationParameter = { parameterPath: [ "options", - "certificateAddOptions", + "certificateListOptions", "clientRequestId" ], mapper: { @@ -524,7 +536,7 @@ export const clientRequestId41: msRest.OperationParameter = { export const clientRequestId42: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListOptions", + "certificateCancelDeletionOptions", "clientRequestId" ], mapper: { @@ -537,7 +549,7 @@ export const clientRequestId42: msRest.OperationParameter = { export const clientRequestId43: msRest.OperationParameter = { parameterPath: [ "options", - "certificateCancelDeletionOptions", + "certificateDeleteMethodOptions", "clientRequestId" ], mapper: { @@ -550,7 +562,7 @@ export const clientRequestId43: msRest.OperationParameter = { export const clientRequestId44: msRest.OperationParameter = { parameterPath: [ "options", - "certificateDeleteMethodOptions", + "certificateGetOptions", "clientRequestId" ], mapper: { @@ -563,7 +575,7 @@ export const clientRequestId44: msRest.OperationParameter = { export const clientRequestId45: msRest.OperationParameter = { parameterPath: [ "options", - "certificateGetOptions", + "certificateListNextOptions", "clientRequestId" ], mapper: { @@ -576,7 +588,7 @@ export const clientRequestId45: msRest.OperationParameter = { export const clientRequestId46: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListNextOptions", + "fileDeleteFromTaskOptions", "clientRequestId" ], mapper: { @@ -589,7 +601,7 @@ export const clientRequestId46: msRest.OperationParameter = { export const clientRequestId47: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromTaskOptions", + "fileGetFromTaskOptions", "clientRequestId" ], mapper: { @@ -602,7 +614,7 @@ export const clientRequestId47: msRest.OperationParameter = { export const clientRequestId48: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "clientRequestId" ], mapper: { @@ -615,7 +627,7 @@ export const clientRequestId48: msRest.OperationParameter = { export const clientRequestId49: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileDeleteFromComputeNodeOptions", "clientRequestId" ], mapper: { @@ -641,7 +653,7 @@ export const clientRequestId5: msRest.OperationParameter = { export const clientRequestId50: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromComputeNodeOptions", + "fileGetFromComputeNodeOptions", "clientRequestId" ], mapper: { @@ -654,7 +666,7 @@ export const clientRequestId50: msRest.OperationParameter = { export const clientRequestId51: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "clientRequestId" ], mapper: { @@ -667,7 +679,7 @@ export const clientRequestId51: msRest.OperationParameter = { export const clientRequestId52: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "fileListFromTaskOptions", "clientRequestId" ], mapper: { @@ -680,7 +692,7 @@ export const clientRequestId52: msRest.OperationParameter = { export const clientRequestId53: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskOptions", + "fileListFromComputeNodeOptions", "clientRequestId" ], mapper: { @@ -693,7 +705,7 @@ export const clientRequestId53: msRest.OperationParameter = { export const clientRequestId54: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeOptions", + "fileListFromTaskNextOptions", "clientRequestId" ], mapper: { @@ -706,7 +718,7 @@ export const clientRequestId54: msRest.OperationParameter = { export const clientRequestId55: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskNextOptions", + "fileListFromComputeNodeNextOptions", "clientRequestId" ], mapper: { @@ -719,7 +731,7 @@ export const clientRequestId55: msRest.OperationParameter = { export const clientRequestId56: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeNextOptions", + "jobScheduleExistsOptions", "clientRequestId" ], mapper: { @@ -732,7 +744,7 @@ export const clientRequestId56: msRest.OperationParameter = { export const clientRequestId57: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "clientRequestId" ], mapper: { @@ -745,7 +757,7 @@ export const clientRequestId57: msRest.OperationParameter = { export const clientRequestId58: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "clientRequestId" ], mapper: { @@ -758,7 +770,7 @@ export const clientRequestId58: msRest.OperationParameter = { export const clientRequestId59: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "clientRequestId" ], mapper: { @@ -784,7 +796,7 @@ export const clientRequestId6: msRest.OperationParameter = { export const clientRequestId60: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "clientRequestId" ], mapper: { @@ -797,7 +809,7 @@ export const clientRequestId60: msRest.OperationParameter = { export const clientRequestId61: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "clientRequestId" ], mapper: { @@ -810,7 +822,7 @@ export const clientRequestId61: msRest.OperationParameter = { export const clientRequestId62: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "clientRequestId" ], mapper: { @@ -823,7 +835,7 @@ export const clientRequestId62: msRest.OperationParameter = { export const clientRequestId63: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "clientRequestId" ], mapper: { @@ -836,7 +848,7 @@ export const clientRequestId63: msRest.OperationParameter = { export const clientRequestId64: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "jobScheduleAddOptions", "clientRequestId" ], mapper: { @@ -849,7 +861,7 @@ export const clientRequestId64: msRest.OperationParameter = { export const clientRequestId65: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleAddOptions", + "jobScheduleListOptions", "clientRequestId" ], mapper: { @@ -862,7 +874,7 @@ export const clientRequestId65: msRest.OperationParameter = { export const clientRequestId66: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListOptions", + "jobScheduleListNextOptions", "clientRequestId" ], mapper: { @@ -875,7 +887,7 @@ export const clientRequestId66: msRest.OperationParameter = { export const clientRequestId67: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListNextOptions", + "taskAddOptions", "clientRequestId" ], mapper: { @@ -888,7 +900,7 @@ export const clientRequestId67: msRest.OperationParameter = { export const clientRequestId68: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddOptions", + "taskListOptions", "clientRequestId" ], mapper: { @@ -901,7 +913,7 @@ export const clientRequestId68: msRest.OperationParameter = { export const clientRequestId69: msRest.OperationParameter = { parameterPath: [ "options", - "taskListOptions", + "taskAddCollectionOptions", "clientRequestId" ], mapper: { @@ -927,7 +939,7 @@ export const clientRequestId7: msRest.OperationParameter = { export const clientRequestId70: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddCollectionOptions", + "taskDeleteMethodOptions", "clientRequestId" ], mapper: { @@ -940,7 +952,7 @@ export const clientRequestId70: msRest.OperationParameter = { export const clientRequestId71: msRest.OperationParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "clientRequestId" ], mapper: { @@ -953,7 +965,7 @@ export const clientRequestId71: msRest.OperationParameter = { export const clientRequestId72: msRest.OperationParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "clientRequestId" ], mapper: { @@ -966,7 +978,7 @@ export const clientRequestId72: msRest.OperationParameter = { export const clientRequestId73: msRest.OperationParameter = { parameterPath: [ "options", - "taskUpdateOptions", + "taskListSubtasksOptions", "clientRequestId" ], mapper: { @@ -979,7 +991,7 @@ export const clientRequestId73: msRest.OperationParameter = { export const clientRequestId74: msRest.OperationParameter = { parameterPath: [ "options", - "taskListSubtasksOptions", + "taskTerminateOptions", "clientRequestId" ], mapper: { @@ -992,7 +1004,7 @@ export const clientRequestId74: msRest.OperationParameter = { export const clientRequestId75: msRest.OperationParameter = { parameterPath: [ "options", - "taskTerminateOptions", + "taskReactivateOptions", "clientRequestId" ], mapper: { @@ -1005,7 +1017,7 @@ export const clientRequestId75: msRest.OperationParameter = { export const clientRequestId76: msRest.OperationParameter = { parameterPath: [ "options", - "taskReactivateOptions", + "taskListNextOptions", "clientRequestId" ], mapper: { @@ -1018,7 +1030,7 @@ export const clientRequestId76: msRest.OperationParameter = { export const clientRequestId77: msRest.OperationParameter = { parameterPath: [ "options", - "taskListNextOptions", + "computeNodeAddUserOptions", "clientRequestId" ], mapper: { @@ -1031,7 +1043,7 @@ export const clientRequestId77: msRest.OperationParameter = { export const clientRequestId78: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeAddUserOptions", + "computeNodeDeleteUserOptions", "clientRequestId" ], mapper: { @@ -1044,7 +1056,7 @@ export const clientRequestId78: msRest.OperationParameter = { export const clientRequestId79: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDeleteUserOptions", + "computeNodeUpdateUserOptions", "clientRequestId" ], mapper: { @@ -1070,7 +1082,7 @@ export const clientRequestId8: msRest.OperationParameter = { export const clientRequestId80: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUpdateUserOptions", + "computeNodeGetOptions", "clientRequestId" ], mapper: { @@ -1083,7 +1095,7 @@ export const clientRequestId80: msRest.OperationParameter = { export const clientRequestId81: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetOptions", + "computeNodeRebootOptions", "clientRequestId" ], mapper: { @@ -1096,7 +1108,7 @@ export const clientRequestId81: msRest.OperationParameter = { export const clientRequestId82: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeRebootOptions", + "computeNodeReimageOptions", "clientRequestId" ], mapper: { @@ -1109,7 +1121,7 @@ export const clientRequestId82: msRest.OperationParameter = { export const clientRequestId83: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeReimageOptions", + "computeNodeDisableSchedulingOptions", "clientRequestId" ], mapper: { @@ -1122,7 +1134,7 @@ export const clientRequestId83: msRest.OperationParameter = { export const clientRequestId84: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDisableSchedulingOptions", + "computeNodeEnableSchedulingOptions", "clientRequestId" ], mapper: { @@ -1135,7 +1147,7 @@ export const clientRequestId84: msRest.OperationParameter = { export const clientRequestId85: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeEnableSchedulingOptions", + "computeNodeGetRemoteLoginSettingsOptions", "clientRequestId" ], mapper: { @@ -1148,7 +1160,7 @@ export const clientRequestId85: msRest.OperationParameter = { export const clientRequestId86: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteLoginSettingsOptions", + "computeNodeGetRemoteDesktopOptions", "clientRequestId" ], mapper: { @@ -1161,7 +1173,7 @@ export const clientRequestId86: msRest.OperationParameter = { export const clientRequestId87: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteDesktopOptions", + "computeNodeUploadBatchServiceLogsOptions", "clientRequestId" ], mapper: { @@ -1174,7 +1186,7 @@ export const clientRequestId87: msRest.OperationParameter = { export const clientRequestId88: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUploadBatchServiceLogsOptions", + "computeNodeListOptions", "clientRequestId" ], mapper: { @@ -1187,7 +1199,7 @@ export const clientRequestId88: msRest.OperationParameter = { export const clientRequestId89: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeListOptions", + "computeNodeListNextOptions", "clientRequestId" ], mapper: { @@ -1210,19 +1222,6 @@ export const clientRequestId9: msRest.OperationParameter = { } } }; -export const clientRequestId90: msRest.OperationParameter = { - parameterPath: [ - "options", - "computeNodeListNextOptions", - "clientRequestId" - ], - mapper: { - serializedName: "client-request-id", - type: { - name: "Uuid" - } - } -}; export const endTime: msRest.OperationQueryParameter = { parameterPath: [ "options", @@ -1561,7 +1560,7 @@ export const ifMatch1: msRest.OperationParameter = { export const ifMatch10: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "ifMatch" ], mapper: { @@ -1574,7 +1573,7 @@ export const ifMatch10: msRest.OperationParameter = { export const ifMatch11: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "ifMatch" ], mapper: { @@ -1587,7 +1586,7 @@ export const ifMatch11: msRest.OperationParameter = { export const ifMatch12: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "ifMatch" ], mapper: { @@ -1600,7 +1599,7 @@ export const ifMatch12: msRest.OperationParameter = { export const ifMatch13: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "ifMatch" ], mapper: { @@ -1613,7 +1612,7 @@ export const ifMatch13: msRest.OperationParameter = { export const ifMatch14: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "ifMatch" ], mapper: { @@ -1626,7 +1625,7 @@ export const ifMatch14: msRest.OperationParameter = { export const ifMatch15: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobScheduleExistsOptions", "ifMatch" ], mapper: { @@ -1639,7 +1638,7 @@ export const ifMatch15: msRest.OperationParameter = { export const ifMatch16: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "ifMatch" ], mapper: { @@ -1652,7 +1651,7 @@ export const ifMatch16: msRest.OperationParameter = { export const ifMatch17: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "ifMatch" ], mapper: { @@ -1665,7 +1664,7 @@ export const ifMatch17: msRest.OperationParameter = { export const ifMatch18: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "ifMatch" ], mapper: { @@ -1678,7 +1677,7 @@ export const ifMatch18: msRest.OperationParameter = { export const ifMatch19: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "ifMatch" ], mapper: { @@ -1702,19 +1701,6 @@ export const ifMatch2: msRest.OperationParameter = { } }; export const ifMatch20: msRest.OperationParameter = { - parameterPath: [ - "options", - "jobScheduleUpdateOptions", - "ifMatch" - ], - mapper: { - serializedName: "If-Match", - type: { - name: "String" - } - } -}; -export const ifMatch21: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleDisableOptions", @@ -1727,7 +1713,7 @@ export const ifMatch21: msRest.OperationParameter = { } } }; -export const ifMatch22: msRest.OperationParameter = { +export const ifMatch21: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleEnableOptions", @@ -1740,7 +1726,7 @@ export const ifMatch22: msRest.OperationParameter = { } } }; -export const ifMatch23: msRest.OperationParameter = { +export const ifMatch22: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleTerminateOptions", @@ -1753,7 +1739,7 @@ export const ifMatch23: msRest.OperationParameter = { } } }; -export const ifMatch24: msRest.OperationParameter = { +export const ifMatch23: msRest.OperationParameter = { parameterPath: [ "options", "taskDeleteMethodOptions", @@ -1766,7 +1752,7 @@ export const ifMatch24: msRest.OperationParameter = { } } }; -export const ifMatch25: msRest.OperationParameter = { +export const ifMatch24: msRest.OperationParameter = { parameterPath: [ "options", "taskGetOptions", @@ -1779,7 +1765,7 @@ export const ifMatch25: msRest.OperationParameter = { } } }; -export const ifMatch26: msRest.OperationParameter = { +export const ifMatch25: msRest.OperationParameter = { parameterPath: [ "options", "taskUpdateOptions", @@ -1792,7 +1778,7 @@ export const ifMatch26: msRest.OperationParameter = { } } }; -export const ifMatch27: msRest.OperationParameter = { +export const ifMatch26: msRest.OperationParameter = { parameterPath: [ "options", "taskTerminateOptions", @@ -1805,7 +1791,7 @@ export const ifMatch27: msRest.OperationParameter = { } } }; -export const ifMatch28: msRest.OperationParameter = { +export const ifMatch27: msRest.OperationParameter = { parameterPath: [ "options", "taskReactivateOptions", @@ -1873,7 +1859,7 @@ export const ifMatch6: msRest.OperationParameter = { export const ifMatch7: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "ifMatch" ], mapper: { @@ -1886,7 +1872,7 @@ export const ifMatch7: msRest.OperationParameter = { export const ifMatch8: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "jobDeleteMethodOptions", "ifMatch" ], mapper: { @@ -1899,7 +1885,7 @@ export const ifMatch8: msRest.OperationParameter = { export const ifMatch9: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "ifMatch" ], mapper: { @@ -1938,7 +1924,7 @@ export const ifModifiedSince1: msRest.OperationParameter = { export const ifModifiedSince10: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "ifModifiedSince" ], mapper: { @@ -1951,7 +1937,7 @@ export const ifModifiedSince10: msRest.OperationParameter = { export const ifModifiedSince11: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "ifModifiedSince" ], mapper: { @@ -1964,7 +1950,7 @@ export const ifModifiedSince11: msRest.OperationParameter = { export const ifModifiedSince12: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "ifModifiedSince" ], mapper: { @@ -1977,7 +1963,7 @@ export const ifModifiedSince12: msRest.OperationParameter = { export const ifModifiedSince13: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "ifModifiedSince" ], mapper: { @@ -1990,7 +1976,7 @@ export const ifModifiedSince13: msRest.OperationParameter = { export const ifModifiedSince14: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "ifModifiedSince" ], mapper: { @@ -2003,7 +1989,7 @@ export const ifModifiedSince14: msRest.OperationParameter = { export const ifModifiedSince15: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "fileGetFromTaskOptions", "ifModifiedSince" ], mapper: { @@ -2016,7 +2002,7 @@ export const ifModifiedSince15: msRest.OperationParameter = { export const ifModifiedSince16: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "ifModifiedSince" ], mapper: { @@ -2029,7 +2015,7 @@ export const ifModifiedSince16: msRest.OperationParameter = { export const ifModifiedSince17: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileGetFromComputeNodeOptions", "ifModifiedSince" ], mapper: { @@ -2042,7 +2028,7 @@ export const ifModifiedSince17: msRest.OperationParameter = { export const ifModifiedSince18: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "ifModifiedSince" ], mapper: { @@ -2055,7 +2041,7 @@ export const ifModifiedSince18: msRest.OperationParameter = { export const ifModifiedSince19: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "jobScheduleExistsOptions", "ifModifiedSince" ], mapper: { @@ -2081,7 +2067,7 @@ export const ifModifiedSince2: msRest.OperationParameter = { export const ifModifiedSince20: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "ifModifiedSince" ], mapper: { @@ -2094,7 +2080,7 @@ export const ifModifiedSince20: msRest.OperationParameter = { export const ifModifiedSince21: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "ifModifiedSince" ], mapper: { @@ -2107,7 +2093,7 @@ export const ifModifiedSince21: msRest.OperationParameter = { export const ifModifiedSince22: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "ifModifiedSince" ], mapper: { @@ -2120,7 +2106,7 @@ export const ifModifiedSince22: msRest.OperationParameter = { export const ifModifiedSince23: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "ifModifiedSince" ], mapper: { @@ -2133,7 +2119,7 @@ export const ifModifiedSince23: msRest.OperationParameter = { export const ifModifiedSince24: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "ifModifiedSince" ], mapper: { @@ -2146,7 +2132,7 @@ export const ifModifiedSince24: msRest.OperationParameter = { export const ifModifiedSince25: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "ifModifiedSince" ], mapper: { @@ -2159,7 +2145,7 @@ export const ifModifiedSince25: msRest.OperationParameter = { export const ifModifiedSince26: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "ifModifiedSince" ], mapper: { @@ -2172,7 +2158,7 @@ export const ifModifiedSince26: msRest.OperationParameter = { export const ifModifiedSince27: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "taskDeleteMethodOptions", "ifModifiedSince" ], mapper: { @@ -2185,7 +2171,7 @@ export const ifModifiedSince27: msRest.OperationParameter = { export const ifModifiedSince28: msRest.OperationParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "ifModifiedSince" ], mapper: { @@ -2198,7 +2184,7 @@ export const ifModifiedSince28: msRest.OperationParameter = { export const ifModifiedSince29: msRest.OperationParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "ifModifiedSince" ], mapper: { @@ -2222,19 +2208,6 @@ export const ifModifiedSince3: msRest.OperationParameter = { } }; export const ifModifiedSince30: msRest.OperationParameter = { - parameterPath: [ - "options", - "taskUpdateOptions", - "ifModifiedSince" - ], - mapper: { - serializedName: "If-Modified-Since", - type: { - name: "DateTimeRfc1123" - } - } -}; -export const ifModifiedSince31: msRest.OperationParameter = { parameterPath: [ "options", "taskTerminateOptions", @@ -2247,7 +2220,7 @@ export const ifModifiedSince31: msRest.OperationParameter = { } } }; -export const ifModifiedSince32: msRest.OperationParameter = { +export const ifModifiedSince31: msRest.OperationParameter = { parameterPath: [ "options", "taskReactivateOptions", @@ -2302,7 +2275,7 @@ export const ifModifiedSince6: msRest.OperationParameter = { export const ifModifiedSince7: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "ifModifiedSince" ], mapper: { @@ -2315,7 +2288,7 @@ export const ifModifiedSince7: msRest.OperationParameter = { export const ifModifiedSince8: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "jobDeleteMethodOptions", "ifModifiedSince" ], mapper: { @@ -2328,7 +2301,7 @@ export const ifModifiedSince8: msRest.OperationParameter = { export const ifModifiedSince9: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "ifModifiedSince" ], mapper: { @@ -2367,7 +2340,7 @@ export const ifNoneMatch1: msRest.OperationParameter = { export const ifNoneMatch10: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "ifNoneMatch" ], mapper: { @@ -2380,7 +2353,7 @@ export const ifNoneMatch10: msRest.OperationParameter = { export const ifNoneMatch11: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "ifNoneMatch" ], mapper: { @@ -2393,7 +2366,7 @@ export const ifNoneMatch11: msRest.OperationParameter = { export const ifNoneMatch12: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "ifNoneMatch" ], mapper: { @@ -2406,7 +2379,7 @@ export const ifNoneMatch12: msRest.OperationParameter = { export const ifNoneMatch13: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "ifNoneMatch" ], mapper: { @@ -2419,7 +2392,7 @@ export const ifNoneMatch13: msRest.OperationParameter = { export const ifNoneMatch14: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "ifNoneMatch" ], mapper: { @@ -2432,7 +2405,7 @@ export const ifNoneMatch14: msRest.OperationParameter = { export const ifNoneMatch15: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobScheduleExistsOptions", "ifNoneMatch" ], mapper: { @@ -2445,7 +2418,7 @@ export const ifNoneMatch15: msRest.OperationParameter = { export const ifNoneMatch16: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "ifNoneMatch" ], mapper: { @@ -2458,7 +2431,7 @@ export const ifNoneMatch16: msRest.OperationParameter = { export const ifNoneMatch17: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "ifNoneMatch" ], mapper: { @@ -2471,7 +2444,7 @@ export const ifNoneMatch17: msRest.OperationParameter = { export const ifNoneMatch18: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "ifNoneMatch" ], mapper: { @@ -2484,7 +2457,7 @@ export const ifNoneMatch18: msRest.OperationParameter = { export const ifNoneMatch19: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "ifNoneMatch" ], mapper: { @@ -2508,19 +2481,6 @@ export const ifNoneMatch2: msRest.OperationParameter = { } }; export const ifNoneMatch20: msRest.OperationParameter = { - parameterPath: [ - "options", - "jobScheduleUpdateOptions", - "ifNoneMatch" - ], - mapper: { - serializedName: "If-None-Match", - type: { - name: "String" - } - } -}; -export const ifNoneMatch21: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleDisableOptions", @@ -2533,7 +2493,7 @@ export const ifNoneMatch21: msRest.OperationParameter = { } } }; -export const ifNoneMatch22: msRest.OperationParameter = { +export const ifNoneMatch21: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleEnableOptions", @@ -2546,7 +2506,7 @@ export const ifNoneMatch22: msRest.OperationParameter = { } } }; -export const ifNoneMatch23: msRest.OperationParameter = { +export const ifNoneMatch22: msRest.OperationParameter = { parameterPath: [ "options", "jobScheduleTerminateOptions", @@ -2559,7 +2519,7 @@ export const ifNoneMatch23: msRest.OperationParameter = { } } }; -export const ifNoneMatch24: msRest.OperationParameter = { +export const ifNoneMatch23: msRest.OperationParameter = { parameterPath: [ "options", "taskDeleteMethodOptions", @@ -2572,7 +2532,7 @@ export const ifNoneMatch24: msRest.OperationParameter = { } } }; -export const ifNoneMatch25: msRest.OperationParameter = { +export const ifNoneMatch24: msRest.OperationParameter = { parameterPath: [ "options", "taskGetOptions", @@ -2585,7 +2545,7 @@ export const ifNoneMatch25: msRest.OperationParameter = { } } }; -export const ifNoneMatch26: msRest.OperationParameter = { +export const ifNoneMatch25: msRest.OperationParameter = { parameterPath: [ "options", "taskUpdateOptions", @@ -2598,7 +2558,7 @@ export const ifNoneMatch26: msRest.OperationParameter = { } } }; -export const ifNoneMatch27: msRest.OperationParameter = { +export const ifNoneMatch26: msRest.OperationParameter = { parameterPath: [ "options", "taskTerminateOptions", @@ -2611,7 +2571,7 @@ export const ifNoneMatch27: msRest.OperationParameter = { } } }; -export const ifNoneMatch28: msRest.OperationParameter = { +export const ifNoneMatch27: msRest.OperationParameter = { parameterPath: [ "options", "taskReactivateOptions", @@ -2679,7 +2639,7 @@ export const ifNoneMatch6: msRest.OperationParameter = { export const ifNoneMatch7: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "ifNoneMatch" ], mapper: { @@ -2692,7 +2652,7 @@ export const ifNoneMatch7: msRest.OperationParameter = { export const ifNoneMatch8: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "jobDeleteMethodOptions", "ifNoneMatch" ], mapper: { @@ -2705,7 +2665,7 @@ export const ifNoneMatch8: msRest.OperationParameter = { export const ifNoneMatch9: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "ifNoneMatch" ], mapper: { @@ -2744,7 +2704,7 @@ export const ifUnmodifiedSince1: msRest.OperationParameter = { export const ifUnmodifiedSince10: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "ifUnmodifiedSince" ], mapper: { @@ -2757,7 +2717,7 @@ export const ifUnmodifiedSince10: msRest.OperationParameter = { export const ifUnmodifiedSince11: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "ifUnmodifiedSince" ], mapper: { @@ -2770,7 +2730,7 @@ export const ifUnmodifiedSince11: msRest.OperationParameter = { export const ifUnmodifiedSince12: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "ifUnmodifiedSince" ], mapper: { @@ -2783,7 +2743,7 @@ export const ifUnmodifiedSince12: msRest.OperationParameter = { export const ifUnmodifiedSince13: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "ifUnmodifiedSince" ], mapper: { @@ -2796,7 +2756,7 @@ export const ifUnmodifiedSince13: msRest.OperationParameter = { export const ifUnmodifiedSince14: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "ifUnmodifiedSince" ], mapper: { @@ -2809,7 +2769,7 @@ export const ifUnmodifiedSince14: msRest.OperationParameter = { export const ifUnmodifiedSince15: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "fileGetFromTaskOptions", "ifUnmodifiedSince" ], mapper: { @@ -2822,7 +2782,7 @@ export const ifUnmodifiedSince15: msRest.OperationParameter = { export const ifUnmodifiedSince16: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "ifUnmodifiedSince" ], mapper: { @@ -2835,7 +2795,7 @@ export const ifUnmodifiedSince16: msRest.OperationParameter = { export const ifUnmodifiedSince17: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileGetFromComputeNodeOptions", "ifUnmodifiedSince" ], mapper: { @@ -2848,7 +2808,7 @@ export const ifUnmodifiedSince17: msRest.OperationParameter = { export const ifUnmodifiedSince18: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "ifUnmodifiedSince" ], mapper: { @@ -2861,7 +2821,7 @@ export const ifUnmodifiedSince18: msRest.OperationParameter = { export const ifUnmodifiedSince19: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "jobScheduleExistsOptions", "ifUnmodifiedSince" ], mapper: { @@ -2887,7 +2847,7 @@ export const ifUnmodifiedSince2: msRest.OperationParameter = { export const ifUnmodifiedSince20: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "ifUnmodifiedSince" ], mapper: { @@ -2900,7 +2860,7 @@ export const ifUnmodifiedSince20: msRest.OperationParameter = { export const ifUnmodifiedSince21: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "ifUnmodifiedSince" ], mapper: { @@ -2913,7 +2873,7 @@ export const ifUnmodifiedSince21: msRest.OperationParameter = { export const ifUnmodifiedSince22: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "ifUnmodifiedSince" ], mapper: { @@ -2926,7 +2886,7 @@ export const ifUnmodifiedSince22: msRest.OperationParameter = { export const ifUnmodifiedSince23: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "ifUnmodifiedSince" ], mapper: { @@ -2939,7 +2899,7 @@ export const ifUnmodifiedSince23: msRest.OperationParameter = { export const ifUnmodifiedSince24: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "ifUnmodifiedSince" ], mapper: { @@ -2952,7 +2912,7 @@ export const ifUnmodifiedSince24: msRest.OperationParameter = { export const ifUnmodifiedSince25: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "ifUnmodifiedSince" ], mapper: { @@ -2965,7 +2925,7 @@ export const ifUnmodifiedSince25: msRest.OperationParameter = { export const ifUnmodifiedSince26: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "ifUnmodifiedSince" ], mapper: { @@ -2978,7 +2938,7 @@ export const ifUnmodifiedSince26: msRest.OperationParameter = { export const ifUnmodifiedSince27: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "taskDeleteMethodOptions", "ifUnmodifiedSince" ], mapper: { @@ -2991,7 +2951,7 @@ export const ifUnmodifiedSince27: msRest.OperationParameter = { export const ifUnmodifiedSince28: msRest.OperationParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "ifUnmodifiedSince" ], mapper: { @@ -3004,7 +2964,7 @@ export const ifUnmodifiedSince28: msRest.OperationParameter = { export const ifUnmodifiedSince29: msRest.OperationParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "ifUnmodifiedSince" ], mapper: { @@ -3028,19 +2988,6 @@ export const ifUnmodifiedSince3: msRest.OperationParameter = { } }; export const ifUnmodifiedSince30: msRest.OperationParameter = { - parameterPath: [ - "options", - "taskUpdateOptions", - "ifUnmodifiedSince" - ], - mapper: { - serializedName: "If-Unmodified-Since", - type: { - name: "DateTimeRfc1123" - } - } -}; -export const ifUnmodifiedSince31: msRest.OperationParameter = { parameterPath: [ "options", "taskTerminateOptions", @@ -3053,7 +3000,7 @@ export const ifUnmodifiedSince31: msRest.OperationParameter = { } } }; -export const ifUnmodifiedSince32: msRest.OperationParameter = { +export const ifUnmodifiedSince31: msRest.OperationParameter = { parameterPath: [ "options", "taskReactivateOptions", @@ -3108,7 +3055,7 @@ export const ifUnmodifiedSince6: msRest.OperationParameter = { export const ifUnmodifiedSince7: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "ifUnmodifiedSince" ], mapper: { @@ -3121,7 +3068,7 @@ export const ifUnmodifiedSince7: msRest.OperationParameter = { export const ifUnmodifiedSince8: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "jobDeleteMethodOptions", "ifUnmodifiedSince" ], mapper: { @@ -3134,7 +3081,7 @@ export const ifUnmodifiedSince8: msRest.OperationParameter = { export const ifUnmodifiedSince9: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "ifUnmodifiedSince" ], mapper: { @@ -3557,7 +3504,7 @@ export const ocpDate16: msRest.OperationParameter = { export const ocpDate17: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "ocpDate" ], mapper: { @@ -3570,7 +3517,7 @@ export const ocpDate17: msRest.OperationParameter = { export const ocpDate18: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "poolListUsageMetricsNextOptions", "ocpDate" ], mapper: { @@ -3583,7 +3530,7 @@ export const ocpDate18: msRest.OperationParameter = { export const ocpDate19: msRest.OperationParameter = { parameterPath: [ "options", - "poolListUsageMetricsNextOptions", + "poolListNextOptions", "ocpDate" ], mapper: { @@ -3609,7 +3556,7 @@ export const ocpDate2: msRest.OperationParameter = { export const ocpDate20: msRest.OperationParameter = { parameterPath: [ "options", - "poolListNextOptions", + "accountListNodeAgentSkusOptions", "ocpDate" ], mapper: { @@ -3622,7 +3569,7 @@ export const ocpDate20: msRest.OperationParameter = { export const ocpDate21: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusOptions", + "accountListPoolNodeCountsOptions", "ocpDate" ], mapper: { @@ -3635,7 +3582,7 @@ export const ocpDate21: msRest.OperationParameter = { export const ocpDate22: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsOptions", + "accountListNodeAgentSkusNextOptions", "ocpDate" ], mapper: { @@ -3648,7 +3595,7 @@ export const ocpDate22: msRest.OperationParameter = { export const ocpDate23: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusNextOptions", + "accountListPoolNodeCountsNextOptions", "ocpDate" ], mapper: { @@ -3661,7 +3608,7 @@ export const ocpDate23: msRest.OperationParameter = { export const ocpDate24: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsNextOptions", + "jobGetAllLifetimeStatisticsOptions", "ocpDate" ], mapper: { @@ -3674,7 +3621,7 @@ export const ocpDate24: msRest.OperationParameter = { export const ocpDate25: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetAllLifetimeStatisticsOptions", + "jobDeleteMethodOptions", "ocpDate" ], mapper: { @@ -3687,7 +3634,7 @@ export const ocpDate25: msRest.OperationParameter = { export const ocpDate26: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "ocpDate" ], mapper: { @@ -3700,7 +3647,7 @@ export const ocpDate26: msRest.OperationParameter = { export const ocpDate27: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "ocpDate" ], mapper: { @@ -3713,7 +3660,7 @@ export const ocpDate27: msRest.OperationParameter = { export const ocpDate28: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "ocpDate" ], mapper: { @@ -3726,7 +3673,7 @@ export const ocpDate28: msRest.OperationParameter = { export const ocpDate29: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "ocpDate" ], mapper: { @@ -3752,7 +3699,7 @@ export const ocpDate3: msRest.OperationParameter = { export const ocpDate30: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "ocpDate" ], mapper: { @@ -3765,7 +3712,7 @@ export const ocpDate30: msRest.OperationParameter = { export const ocpDate31: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "ocpDate" ], mapper: { @@ -3778,7 +3725,7 @@ export const ocpDate31: msRest.OperationParameter = { export const ocpDate32: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobAddOptions", "ocpDate" ], mapper: { @@ -3791,7 +3738,7 @@ export const ocpDate32: msRest.OperationParameter = { export const ocpDate33: msRest.OperationParameter = { parameterPath: [ "options", - "jobAddOptions", + "jobListOptions", "ocpDate" ], mapper: { @@ -3804,7 +3751,7 @@ export const ocpDate33: msRest.OperationParameter = { export const ocpDate34: msRest.OperationParameter = { parameterPath: [ "options", - "jobListOptions", + "jobListFromJobScheduleOptions", "ocpDate" ], mapper: { @@ -3817,7 +3764,7 @@ export const ocpDate34: msRest.OperationParameter = { export const ocpDate35: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleOptions", + "jobListPreparationAndReleaseTaskStatusOptions", "ocpDate" ], mapper: { @@ -3830,7 +3777,7 @@ export const ocpDate35: msRest.OperationParameter = { export const ocpDate36: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusOptions", + "jobGetTaskCountsOptions", "ocpDate" ], mapper: { @@ -3843,7 +3790,7 @@ export const ocpDate36: msRest.OperationParameter = { export const ocpDate37: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetTaskCountsOptions", + "jobListNextOptions", "ocpDate" ], mapper: { @@ -3856,7 +3803,7 @@ export const ocpDate37: msRest.OperationParameter = { export const ocpDate38: msRest.OperationParameter = { parameterPath: [ "options", - "jobListNextOptions", + "jobListFromJobScheduleNextOptions", "ocpDate" ], mapper: { @@ -3869,7 +3816,7 @@ export const ocpDate38: msRest.OperationParameter = { export const ocpDate39: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleNextOptions", + "jobListPreparationAndReleaseTaskStatusNextOptions", "ocpDate" ], mapper: { @@ -3895,7 +3842,7 @@ export const ocpDate4: msRest.OperationParameter = { export const ocpDate40: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusNextOptions", + "certificateAddOptions", "ocpDate" ], mapper: { @@ -3908,7 +3855,7 @@ export const ocpDate40: msRest.OperationParameter = { export const ocpDate41: msRest.OperationParameter = { parameterPath: [ "options", - "certificateAddOptions", + "certificateListOptions", "ocpDate" ], mapper: { @@ -3921,7 +3868,7 @@ export const ocpDate41: msRest.OperationParameter = { export const ocpDate42: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListOptions", + "certificateCancelDeletionOptions", "ocpDate" ], mapper: { @@ -3934,7 +3881,7 @@ export const ocpDate42: msRest.OperationParameter = { export const ocpDate43: msRest.OperationParameter = { parameterPath: [ "options", - "certificateCancelDeletionOptions", + "certificateDeleteMethodOptions", "ocpDate" ], mapper: { @@ -3947,7 +3894,7 @@ export const ocpDate43: msRest.OperationParameter = { export const ocpDate44: msRest.OperationParameter = { parameterPath: [ "options", - "certificateDeleteMethodOptions", + "certificateGetOptions", "ocpDate" ], mapper: { @@ -3960,7 +3907,7 @@ export const ocpDate44: msRest.OperationParameter = { export const ocpDate45: msRest.OperationParameter = { parameterPath: [ "options", - "certificateGetOptions", + "certificateListNextOptions", "ocpDate" ], mapper: { @@ -3973,7 +3920,7 @@ export const ocpDate45: msRest.OperationParameter = { export const ocpDate46: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListNextOptions", + "fileDeleteFromTaskOptions", "ocpDate" ], mapper: { @@ -3986,7 +3933,7 @@ export const ocpDate46: msRest.OperationParameter = { export const ocpDate47: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromTaskOptions", + "fileGetFromTaskOptions", "ocpDate" ], mapper: { @@ -3999,7 +3946,7 @@ export const ocpDate47: msRest.OperationParameter = { export const ocpDate48: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "ocpDate" ], mapper: { @@ -4012,7 +3959,7 @@ export const ocpDate48: msRest.OperationParameter = { export const ocpDate49: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileDeleteFromComputeNodeOptions", "ocpDate" ], mapper: { @@ -4038,7 +3985,7 @@ export const ocpDate5: msRest.OperationParameter = { export const ocpDate50: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromComputeNodeOptions", + "fileGetFromComputeNodeOptions", "ocpDate" ], mapper: { @@ -4051,7 +3998,7 @@ export const ocpDate50: msRest.OperationParameter = { export const ocpDate51: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "ocpDate" ], mapper: { @@ -4064,7 +4011,7 @@ export const ocpDate51: msRest.OperationParameter = { export const ocpDate52: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "fileListFromTaskOptions", "ocpDate" ], mapper: { @@ -4077,7 +4024,7 @@ export const ocpDate52: msRest.OperationParameter = { export const ocpDate53: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskOptions", + "fileListFromComputeNodeOptions", "ocpDate" ], mapper: { @@ -4090,7 +4037,7 @@ export const ocpDate53: msRest.OperationParameter = { export const ocpDate54: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeOptions", + "fileListFromTaskNextOptions", "ocpDate" ], mapper: { @@ -4103,7 +4050,7 @@ export const ocpDate54: msRest.OperationParameter = { export const ocpDate55: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskNextOptions", + "fileListFromComputeNodeNextOptions", "ocpDate" ], mapper: { @@ -4116,7 +4063,7 @@ export const ocpDate55: msRest.OperationParameter = { export const ocpDate56: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeNextOptions", + "jobScheduleExistsOptions", "ocpDate" ], mapper: { @@ -4129,7 +4076,7 @@ export const ocpDate56: msRest.OperationParameter = { export const ocpDate57: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "ocpDate" ], mapper: { @@ -4142,7 +4089,7 @@ export const ocpDate57: msRest.OperationParameter = { export const ocpDate58: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "ocpDate" ], mapper: { @@ -4155,7 +4102,7 @@ export const ocpDate58: msRest.OperationParameter = { export const ocpDate59: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "ocpDate" ], mapper: { @@ -4181,7 +4128,7 @@ export const ocpDate6: msRest.OperationParameter = { export const ocpDate60: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "ocpDate" ], mapper: { @@ -4194,7 +4141,7 @@ export const ocpDate60: msRest.OperationParameter = { export const ocpDate61: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "ocpDate" ], mapper: { @@ -4207,7 +4154,7 @@ export const ocpDate61: msRest.OperationParameter = { export const ocpDate62: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "ocpDate" ], mapper: { @@ -4220,7 +4167,7 @@ export const ocpDate62: msRest.OperationParameter = { export const ocpDate63: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "ocpDate" ], mapper: { @@ -4233,7 +4180,7 @@ export const ocpDate63: msRest.OperationParameter = { export const ocpDate64: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "jobScheduleAddOptions", "ocpDate" ], mapper: { @@ -4246,7 +4193,7 @@ export const ocpDate64: msRest.OperationParameter = { export const ocpDate65: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleAddOptions", + "jobScheduleListOptions", "ocpDate" ], mapper: { @@ -4259,7 +4206,7 @@ export const ocpDate65: msRest.OperationParameter = { export const ocpDate66: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListOptions", + "jobScheduleListNextOptions", "ocpDate" ], mapper: { @@ -4272,7 +4219,7 @@ export const ocpDate66: msRest.OperationParameter = { export const ocpDate67: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListNextOptions", + "taskAddOptions", "ocpDate" ], mapper: { @@ -4285,7 +4232,7 @@ export const ocpDate67: msRest.OperationParameter = { export const ocpDate68: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddOptions", + "taskListOptions", "ocpDate" ], mapper: { @@ -4298,7 +4245,7 @@ export const ocpDate68: msRest.OperationParameter = { export const ocpDate69: msRest.OperationParameter = { parameterPath: [ "options", - "taskListOptions", + "taskAddCollectionOptions", "ocpDate" ], mapper: { @@ -4324,7 +4271,7 @@ export const ocpDate7: msRest.OperationParameter = { export const ocpDate70: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddCollectionOptions", + "taskDeleteMethodOptions", "ocpDate" ], mapper: { @@ -4337,7 +4284,7 @@ export const ocpDate70: msRest.OperationParameter = { export const ocpDate71: msRest.OperationParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "ocpDate" ], mapper: { @@ -4350,7 +4297,7 @@ export const ocpDate71: msRest.OperationParameter = { export const ocpDate72: msRest.OperationParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "ocpDate" ], mapper: { @@ -4363,7 +4310,7 @@ export const ocpDate72: msRest.OperationParameter = { export const ocpDate73: msRest.OperationParameter = { parameterPath: [ "options", - "taskUpdateOptions", + "taskListSubtasksOptions", "ocpDate" ], mapper: { @@ -4376,7 +4323,7 @@ export const ocpDate73: msRest.OperationParameter = { export const ocpDate74: msRest.OperationParameter = { parameterPath: [ "options", - "taskListSubtasksOptions", + "taskTerminateOptions", "ocpDate" ], mapper: { @@ -4389,7 +4336,7 @@ export const ocpDate74: msRest.OperationParameter = { export const ocpDate75: msRest.OperationParameter = { parameterPath: [ "options", - "taskTerminateOptions", + "taskReactivateOptions", "ocpDate" ], mapper: { @@ -4402,7 +4349,7 @@ export const ocpDate75: msRest.OperationParameter = { export const ocpDate76: msRest.OperationParameter = { parameterPath: [ "options", - "taskReactivateOptions", + "taskListNextOptions", "ocpDate" ], mapper: { @@ -4415,7 +4362,7 @@ export const ocpDate76: msRest.OperationParameter = { export const ocpDate77: msRest.OperationParameter = { parameterPath: [ "options", - "taskListNextOptions", + "computeNodeAddUserOptions", "ocpDate" ], mapper: { @@ -4428,7 +4375,7 @@ export const ocpDate77: msRest.OperationParameter = { export const ocpDate78: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeAddUserOptions", + "computeNodeDeleteUserOptions", "ocpDate" ], mapper: { @@ -4441,7 +4388,7 @@ export const ocpDate78: msRest.OperationParameter = { export const ocpDate79: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDeleteUserOptions", + "computeNodeUpdateUserOptions", "ocpDate" ], mapper: { @@ -4467,7 +4414,7 @@ export const ocpDate8: msRest.OperationParameter = { export const ocpDate80: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUpdateUserOptions", + "computeNodeGetOptions", "ocpDate" ], mapper: { @@ -4480,7 +4427,7 @@ export const ocpDate80: msRest.OperationParameter = { export const ocpDate81: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetOptions", + "computeNodeRebootOptions", "ocpDate" ], mapper: { @@ -4493,7 +4440,7 @@ export const ocpDate81: msRest.OperationParameter = { export const ocpDate82: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeRebootOptions", + "computeNodeReimageOptions", "ocpDate" ], mapper: { @@ -4506,7 +4453,7 @@ export const ocpDate82: msRest.OperationParameter = { export const ocpDate83: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeReimageOptions", + "computeNodeDisableSchedulingOptions", "ocpDate" ], mapper: { @@ -4519,7 +4466,7 @@ export const ocpDate83: msRest.OperationParameter = { export const ocpDate84: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDisableSchedulingOptions", + "computeNodeEnableSchedulingOptions", "ocpDate" ], mapper: { @@ -4532,7 +4479,7 @@ export const ocpDate84: msRest.OperationParameter = { export const ocpDate85: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeEnableSchedulingOptions", + "computeNodeGetRemoteLoginSettingsOptions", "ocpDate" ], mapper: { @@ -4545,7 +4492,7 @@ export const ocpDate85: msRest.OperationParameter = { export const ocpDate86: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteLoginSettingsOptions", + "computeNodeGetRemoteDesktopOptions", "ocpDate" ], mapper: { @@ -4558,7 +4505,7 @@ export const ocpDate86: msRest.OperationParameter = { export const ocpDate87: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteDesktopOptions", + "computeNodeUploadBatchServiceLogsOptions", "ocpDate" ], mapper: { @@ -4571,7 +4518,7 @@ export const ocpDate87: msRest.OperationParameter = { export const ocpDate88: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUploadBatchServiceLogsOptions", + "computeNodeListOptions", "ocpDate" ], mapper: { @@ -4584,7 +4531,7 @@ export const ocpDate88: msRest.OperationParameter = { export const ocpDate89: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeListOptions", + "computeNodeListNextOptions", "ocpDate" ], mapper: { @@ -4607,19 +4554,6 @@ export const ocpDate9: msRest.OperationParameter = { } } }; -export const ocpDate90: msRest.OperationParameter = { - parameterPath: [ - "options", - "computeNodeListNextOptions", - "ocpDate" - ], - mapper: { - serializedName: "ocp-date", - type: { - name: "DateTimeRfc1123" - } - } -}; export const ocpRange0: msRest.OperationParameter = { parameterPath: [ "options", @@ -4797,7 +4731,7 @@ export const returnClientRequestId16: msRest.OperationParameter = { export const returnClientRequestId17: msRest.OperationParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "returnClientRequestId" ], mapper: { @@ -4811,7 +4745,7 @@ export const returnClientRequestId17: msRest.OperationParameter = { export const returnClientRequestId18: msRest.OperationParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "poolListUsageMetricsNextOptions", "returnClientRequestId" ], mapper: { @@ -4825,7 +4759,7 @@ export const returnClientRequestId18: msRest.OperationParameter = { export const returnClientRequestId19: msRest.OperationParameter = { parameterPath: [ "options", - "poolListUsageMetricsNextOptions", + "poolListNextOptions", "returnClientRequestId" ], mapper: { @@ -4853,7 +4787,7 @@ export const returnClientRequestId2: msRest.OperationParameter = { export const returnClientRequestId20: msRest.OperationParameter = { parameterPath: [ "options", - "poolListNextOptions", + "accountListNodeAgentSkusOptions", "returnClientRequestId" ], mapper: { @@ -4867,7 +4801,7 @@ export const returnClientRequestId20: msRest.OperationParameter = { export const returnClientRequestId21: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusOptions", + "accountListPoolNodeCountsOptions", "returnClientRequestId" ], mapper: { @@ -4881,7 +4815,7 @@ export const returnClientRequestId21: msRest.OperationParameter = { export const returnClientRequestId22: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsOptions", + "accountListNodeAgentSkusNextOptions", "returnClientRequestId" ], mapper: { @@ -4895,7 +4829,7 @@ export const returnClientRequestId22: msRest.OperationParameter = { export const returnClientRequestId23: msRest.OperationParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusNextOptions", + "accountListPoolNodeCountsNextOptions", "returnClientRequestId" ], mapper: { @@ -4909,7 +4843,7 @@ export const returnClientRequestId23: msRest.OperationParameter = { export const returnClientRequestId24: msRest.OperationParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsNextOptions", + "jobGetAllLifetimeStatisticsOptions", "returnClientRequestId" ], mapper: { @@ -4923,7 +4857,7 @@ export const returnClientRequestId24: msRest.OperationParameter = { export const returnClientRequestId25: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetAllLifetimeStatisticsOptions", + "jobDeleteMethodOptions", "returnClientRequestId" ], mapper: { @@ -4937,7 +4871,7 @@ export const returnClientRequestId25: msRest.OperationParameter = { export const returnClientRequestId26: msRest.OperationParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "returnClientRequestId" ], mapper: { @@ -4951,7 +4885,7 @@ export const returnClientRequestId26: msRest.OperationParameter = { export const returnClientRequestId27: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "returnClientRequestId" ], mapper: { @@ -4965,7 +4899,7 @@ export const returnClientRequestId27: msRest.OperationParameter = { export const returnClientRequestId28: msRest.OperationParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "returnClientRequestId" ], mapper: { @@ -4979,7 +4913,7 @@ export const returnClientRequestId28: msRest.OperationParameter = { export const returnClientRequestId29: msRest.OperationParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "returnClientRequestId" ], mapper: { @@ -5007,7 +4941,7 @@ export const returnClientRequestId3: msRest.OperationParameter = { export const returnClientRequestId30: msRest.OperationParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "returnClientRequestId" ], mapper: { @@ -5021,7 +4955,7 @@ export const returnClientRequestId30: msRest.OperationParameter = { export const returnClientRequestId31: msRest.OperationParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "returnClientRequestId" ], mapper: { @@ -5035,7 +4969,7 @@ export const returnClientRequestId31: msRest.OperationParameter = { export const returnClientRequestId32: msRest.OperationParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobAddOptions", "returnClientRequestId" ], mapper: { @@ -5049,7 +4983,7 @@ export const returnClientRequestId32: msRest.OperationParameter = { export const returnClientRequestId33: msRest.OperationParameter = { parameterPath: [ "options", - "jobAddOptions", + "jobListOptions", "returnClientRequestId" ], mapper: { @@ -5063,7 +4997,7 @@ export const returnClientRequestId33: msRest.OperationParameter = { export const returnClientRequestId34: msRest.OperationParameter = { parameterPath: [ "options", - "jobListOptions", + "jobListFromJobScheduleOptions", "returnClientRequestId" ], mapper: { @@ -5077,7 +5011,7 @@ export const returnClientRequestId34: msRest.OperationParameter = { export const returnClientRequestId35: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleOptions", + "jobListPreparationAndReleaseTaskStatusOptions", "returnClientRequestId" ], mapper: { @@ -5091,7 +5025,7 @@ export const returnClientRequestId35: msRest.OperationParameter = { export const returnClientRequestId36: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusOptions", + "jobGetTaskCountsOptions", "returnClientRequestId" ], mapper: { @@ -5105,7 +5039,7 @@ export const returnClientRequestId36: msRest.OperationParameter = { export const returnClientRequestId37: msRest.OperationParameter = { parameterPath: [ "options", - "jobGetTaskCountsOptions", + "jobListNextOptions", "returnClientRequestId" ], mapper: { @@ -5119,7 +5053,7 @@ export const returnClientRequestId37: msRest.OperationParameter = { export const returnClientRequestId38: msRest.OperationParameter = { parameterPath: [ "options", - "jobListNextOptions", + "jobListFromJobScheduleNextOptions", "returnClientRequestId" ], mapper: { @@ -5133,7 +5067,7 @@ export const returnClientRequestId38: msRest.OperationParameter = { export const returnClientRequestId39: msRest.OperationParameter = { parameterPath: [ "options", - "jobListFromJobScheduleNextOptions", + "jobListPreparationAndReleaseTaskStatusNextOptions", "returnClientRequestId" ], mapper: { @@ -5161,7 +5095,7 @@ export const returnClientRequestId4: msRest.OperationParameter = { export const returnClientRequestId40: msRest.OperationParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusNextOptions", + "certificateAddOptions", "returnClientRequestId" ], mapper: { @@ -5175,7 +5109,7 @@ export const returnClientRequestId40: msRest.OperationParameter = { export const returnClientRequestId41: msRest.OperationParameter = { parameterPath: [ "options", - "certificateAddOptions", + "certificateListOptions", "returnClientRequestId" ], mapper: { @@ -5189,7 +5123,7 @@ export const returnClientRequestId41: msRest.OperationParameter = { export const returnClientRequestId42: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListOptions", + "certificateCancelDeletionOptions", "returnClientRequestId" ], mapper: { @@ -5203,7 +5137,7 @@ export const returnClientRequestId42: msRest.OperationParameter = { export const returnClientRequestId43: msRest.OperationParameter = { parameterPath: [ "options", - "certificateCancelDeletionOptions", + "certificateDeleteMethodOptions", "returnClientRequestId" ], mapper: { @@ -5217,7 +5151,7 @@ export const returnClientRequestId43: msRest.OperationParameter = { export const returnClientRequestId44: msRest.OperationParameter = { parameterPath: [ "options", - "certificateDeleteMethodOptions", + "certificateGetOptions", "returnClientRequestId" ], mapper: { @@ -5231,7 +5165,7 @@ export const returnClientRequestId44: msRest.OperationParameter = { export const returnClientRequestId45: msRest.OperationParameter = { parameterPath: [ "options", - "certificateGetOptions", + "certificateListNextOptions", "returnClientRequestId" ], mapper: { @@ -5245,7 +5179,7 @@ export const returnClientRequestId45: msRest.OperationParameter = { export const returnClientRequestId46: msRest.OperationParameter = { parameterPath: [ "options", - "certificateListNextOptions", + "fileDeleteFromTaskOptions", "returnClientRequestId" ], mapper: { @@ -5259,7 +5193,7 @@ export const returnClientRequestId46: msRest.OperationParameter = { export const returnClientRequestId47: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromTaskOptions", + "fileGetFromTaskOptions", "returnClientRequestId" ], mapper: { @@ -5273,7 +5207,7 @@ export const returnClientRequestId47: msRest.OperationParameter = { export const returnClientRequestId48: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "returnClientRequestId" ], mapper: { @@ -5287,7 +5221,7 @@ export const returnClientRequestId48: msRest.OperationParameter = { export const returnClientRequestId49: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileDeleteFromComputeNodeOptions", "returnClientRequestId" ], mapper: { @@ -5315,7 +5249,7 @@ export const returnClientRequestId5: msRest.OperationParameter = { export const returnClientRequestId50: msRest.OperationParameter = { parameterPath: [ "options", - "fileDeleteFromComputeNodeOptions", + "fileGetFromComputeNodeOptions", "returnClientRequestId" ], mapper: { @@ -5329,7 +5263,7 @@ export const returnClientRequestId50: msRest.OperationParameter = { export const returnClientRequestId51: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "returnClientRequestId" ], mapper: { @@ -5343,7 +5277,7 @@ export const returnClientRequestId51: msRest.OperationParameter = { export const returnClientRequestId52: msRest.OperationParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "fileListFromTaskOptions", "returnClientRequestId" ], mapper: { @@ -5357,7 +5291,7 @@ export const returnClientRequestId52: msRest.OperationParameter = { export const returnClientRequestId53: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskOptions", + "fileListFromComputeNodeOptions", "returnClientRequestId" ], mapper: { @@ -5371,7 +5305,7 @@ export const returnClientRequestId53: msRest.OperationParameter = { export const returnClientRequestId54: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeOptions", + "fileListFromTaskNextOptions", "returnClientRequestId" ], mapper: { @@ -5385,7 +5319,7 @@ export const returnClientRequestId54: msRest.OperationParameter = { export const returnClientRequestId55: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromTaskNextOptions", + "fileListFromComputeNodeNextOptions", "returnClientRequestId" ], mapper: { @@ -5399,7 +5333,7 @@ export const returnClientRequestId55: msRest.OperationParameter = { export const returnClientRequestId56: msRest.OperationParameter = { parameterPath: [ "options", - "fileListFromComputeNodeNextOptions", + "jobScheduleExistsOptions", "returnClientRequestId" ], mapper: { @@ -5413,7 +5347,7 @@ export const returnClientRequestId56: msRest.OperationParameter = { export const returnClientRequestId57: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "returnClientRequestId" ], mapper: { @@ -5427,7 +5361,7 @@ export const returnClientRequestId57: msRest.OperationParameter = { export const returnClientRequestId58: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "returnClientRequestId" ], mapper: { @@ -5441,7 +5375,7 @@ export const returnClientRequestId58: msRest.OperationParameter = { export const returnClientRequestId59: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "returnClientRequestId" ], mapper: { @@ -5469,7 +5403,7 @@ export const returnClientRequestId6: msRest.OperationParameter = { export const returnClientRequestId60: msRest.OperationParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "returnClientRequestId" ], mapper: { @@ -5483,7 +5417,7 @@ export const returnClientRequestId60: msRest.OperationParameter = { export const returnClientRequestId61: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "returnClientRequestId" ], mapper: { @@ -5497,7 +5431,7 @@ export const returnClientRequestId61: msRest.OperationParameter = { export const returnClientRequestId62: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "returnClientRequestId" ], mapper: { @@ -5511,7 +5445,7 @@ export const returnClientRequestId62: msRest.OperationParameter = { export const returnClientRequestId63: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "returnClientRequestId" ], mapper: { @@ -5525,7 +5459,7 @@ export const returnClientRequestId63: msRest.OperationParameter = { export const returnClientRequestId64: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "jobScheduleAddOptions", "returnClientRequestId" ], mapper: { @@ -5539,7 +5473,7 @@ export const returnClientRequestId64: msRest.OperationParameter = { export const returnClientRequestId65: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleAddOptions", + "jobScheduleListOptions", "returnClientRequestId" ], mapper: { @@ -5553,7 +5487,7 @@ export const returnClientRequestId65: msRest.OperationParameter = { export const returnClientRequestId66: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListOptions", + "jobScheduleListNextOptions", "returnClientRequestId" ], mapper: { @@ -5567,7 +5501,7 @@ export const returnClientRequestId66: msRest.OperationParameter = { export const returnClientRequestId67: msRest.OperationParameter = { parameterPath: [ "options", - "jobScheduleListNextOptions", + "taskAddOptions", "returnClientRequestId" ], mapper: { @@ -5581,7 +5515,7 @@ export const returnClientRequestId67: msRest.OperationParameter = { export const returnClientRequestId68: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddOptions", + "taskListOptions", "returnClientRequestId" ], mapper: { @@ -5595,7 +5529,7 @@ export const returnClientRequestId68: msRest.OperationParameter = { export const returnClientRequestId69: msRest.OperationParameter = { parameterPath: [ "options", - "taskListOptions", + "taskAddCollectionOptions", "returnClientRequestId" ], mapper: { @@ -5623,7 +5557,7 @@ export const returnClientRequestId7: msRest.OperationParameter = { export const returnClientRequestId70: msRest.OperationParameter = { parameterPath: [ "options", - "taskAddCollectionOptions", + "taskDeleteMethodOptions", "returnClientRequestId" ], mapper: { @@ -5637,7 +5571,7 @@ export const returnClientRequestId70: msRest.OperationParameter = { export const returnClientRequestId71: msRest.OperationParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "returnClientRequestId" ], mapper: { @@ -5651,7 +5585,7 @@ export const returnClientRequestId71: msRest.OperationParameter = { export const returnClientRequestId72: msRest.OperationParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "returnClientRequestId" ], mapper: { @@ -5665,7 +5599,7 @@ export const returnClientRequestId72: msRest.OperationParameter = { export const returnClientRequestId73: msRest.OperationParameter = { parameterPath: [ "options", - "taskUpdateOptions", + "taskListSubtasksOptions", "returnClientRequestId" ], mapper: { @@ -5679,7 +5613,7 @@ export const returnClientRequestId73: msRest.OperationParameter = { export const returnClientRequestId74: msRest.OperationParameter = { parameterPath: [ "options", - "taskListSubtasksOptions", + "taskTerminateOptions", "returnClientRequestId" ], mapper: { @@ -5693,7 +5627,7 @@ export const returnClientRequestId74: msRest.OperationParameter = { export const returnClientRequestId75: msRest.OperationParameter = { parameterPath: [ "options", - "taskTerminateOptions", + "taskReactivateOptions", "returnClientRequestId" ], mapper: { @@ -5707,7 +5641,7 @@ export const returnClientRequestId75: msRest.OperationParameter = { export const returnClientRequestId76: msRest.OperationParameter = { parameterPath: [ "options", - "taskReactivateOptions", + "taskListNextOptions", "returnClientRequestId" ], mapper: { @@ -5721,7 +5655,7 @@ export const returnClientRequestId76: msRest.OperationParameter = { export const returnClientRequestId77: msRest.OperationParameter = { parameterPath: [ "options", - "taskListNextOptions", + "computeNodeAddUserOptions", "returnClientRequestId" ], mapper: { @@ -5735,7 +5669,7 @@ export const returnClientRequestId77: msRest.OperationParameter = { export const returnClientRequestId78: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeAddUserOptions", + "computeNodeDeleteUserOptions", "returnClientRequestId" ], mapper: { @@ -5749,7 +5683,7 @@ export const returnClientRequestId78: msRest.OperationParameter = { export const returnClientRequestId79: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDeleteUserOptions", + "computeNodeUpdateUserOptions", "returnClientRequestId" ], mapper: { @@ -5777,7 +5711,7 @@ export const returnClientRequestId8: msRest.OperationParameter = { export const returnClientRequestId80: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUpdateUserOptions", + "computeNodeGetOptions", "returnClientRequestId" ], mapper: { @@ -5791,7 +5725,7 @@ export const returnClientRequestId80: msRest.OperationParameter = { export const returnClientRequestId81: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetOptions", + "computeNodeRebootOptions", "returnClientRequestId" ], mapper: { @@ -5805,7 +5739,7 @@ export const returnClientRequestId81: msRest.OperationParameter = { export const returnClientRequestId82: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeRebootOptions", + "computeNodeReimageOptions", "returnClientRequestId" ], mapper: { @@ -5819,7 +5753,7 @@ export const returnClientRequestId82: msRest.OperationParameter = { export const returnClientRequestId83: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeReimageOptions", + "computeNodeDisableSchedulingOptions", "returnClientRequestId" ], mapper: { @@ -5833,7 +5767,7 @@ export const returnClientRequestId83: msRest.OperationParameter = { export const returnClientRequestId84: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeDisableSchedulingOptions", + "computeNodeEnableSchedulingOptions", "returnClientRequestId" ], mapper: { @@ -5847,7 +5781,7 @@ export const returnClientRequestId84: msRest.OperationParameter = { export const returnClientRequestId85: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeEnableSchedulingOptions", + "computeNodeGetRemoteLoginSettingsOptions", "returnClientRequestId" ], mapper: { @@ -5861,7 +5795,7 @@ export const returnClientRequestId85: msRest.OperationParameter = { export const returnClientRequestId86: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteLoginSettingsOptions", + "computeNodeGetRemoteDesktopOptions", "returnClientRequestId" ], mapper: { @@ -5875,7 +5809,7 @@ export const returnClientRequestId86: msRest.OperationParameter = { export const returnClientRequestId87: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeGetRemoteDesktopOptions", + "computeNodeUploadBatchServiceLogsOptions", "returnClientRequestId" ], mapper: { @@ -5889,7 +5823,7 @@ export const returnClientRequestId87: msRest.OperationParameter = { export const returnClientRequestId88: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeUploadBatchServiceLogsOptions", + "computeNodeListOptions", "returnClientRequestId" ], mapper: { @@ -5903,7 +5837,7 @@ export const returnClientRequestId88: msRest.OperationParameter = { export const returnClientRequestId89: msRest.OperationParameter = { parameterPath: [ "options", - "computeNodeListOptions", + "computeNodeListNextOptions", "returnClientRequestId" ], mapper: { @@ -5928,20 +5862,6 @@ export const returnClientRequestId9: msRest.OperationParameter = { } } }; -export const returnClientRequestId90: msRest.OperationParameter = { - parameterPath: [ - "options", - "computeNodeListNextOptions", - "returnClientRequestId" - ], - mapper: { - serializedName: "return-client-request-id", - defaultValue: false, - type: { - name: "Boolean" - } - } -}; export const select0: msRest.OperationQueryParameter = { parameterPath: [ "options", @@ -6295,7 +6215,7 @@ export const timeout15: msRest.OperationQueryParameter = { export const timeout16: msRest.OperationQueryParameter = { parameterPath: [ "options", - "poolUpgradeOSOptions", + "poolRemoveNodesOptions", "timeout" ], mapper: { @@ -6309,7 +6229,7 @@ export const timeout16: msRest.OperationQueryParameter = { export const timeout17: msRest.OperationQueryParameter = { parameterPath: [ "options", - "poolRemoveNodesOptions", + "accountListNodeAgentSkusOptions", "timeout" ], mapper: { @@ -6323,7 +6243,7 @@ export const timeout17: msRest.OperationQueryParameter = { export const timeout18: msRest.OperationQueryParameter = { parameterPath: [ "options", - "accountListNodeAgentSkusOptions", + "accountListPoolNodeCountsOptions", "timeout" ], mapper: { @@ -6337,7 +6257,7 @@ export const timeout18: msRest.OperationQueryParameter = { export const timeout19: msRest.OperationQueryParameter = { parameterPath: [ "options", - "accountListPoolNodeCountsOptions", + "jobGetAllLifetimeStatisticsOptions", "timeout" ], mapper: { @@ -6365,7 +6285,7 @@ export const timeout2: msRest.OperationQueryParameter = { export const timeout20: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobGetAllLifetimeStatisticsOptions", + "jobDeleteMethodOptions", "timeout" ], mapper: { @@ -6379,7 +6299,7 @@ export const timeout20: msRest.OperationQueryParameter = { export const timeout21: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobDeleteMethodOptions", + "jobGetOptions", "timeout" ], mapper: { @@ -6393,7 +6313,7 @@ export const timeout21: msRest.OperationQueryParameter = { export const timeout22: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobGetOptions", + "jobPatchOptions", "timeout" ], mapper: { @@ -6407,7 +6327,7 @@ export const timeout22: msRest.OperationQueryParameter = { export const timeout23: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobPatchOptions", + "jobUpdateOptions", "timeout" ], mapper: { @@ -6421,7 +6341,7 @@ export const timeout23: msRest.OperationQueryParameter = { export const timeout24: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobUpdateOptions", + "jobDisableOptions", "timeout" ], mapper: { @@ -6435,7 +6355,7 @@ export const timeout24: msRest.OperationQueryParameter = { export const timeout25: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobDisableOptions", + "jobEnableOptions", "timeout" ], mapper: { @@ -6449,7 +6369,7 @@ export const timeout25: msRest.OperationQueryParameter = { export const timeout26: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobEnableOptions", + "jobTerminateOptions", "timeout" ], mapper: { @@ -6463,7 +6383,7 @@ export const timeout26: msRest.OperationQueryParameter = { export const timeout27: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobTerminateOptions", + "jobAddOptions", "timeout" ], mapper: { @@ -6477,7 +6397,7 @@ export const timeout27: msRest.OperationQueryParameter = { export const timeout28: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobAddOptions", + "jobListOptions", "timeout" ], mapper: { @@ -6491,7 +6411,7 @@ export const timeout28: msRest.OperationQueryParameter = { export const timeout29: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobListOptions", + "jobListFromJobScheduleOptions", "timeout" ], mapper: { @@ -6519,7 +6439,7 @@ export const timeout3: msRest.OperationQueryParameter = { export const timeout30: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobListFromJobScheduleOptions", + "jobListPreparationAndReleaseTaskStatusOptions", "timeout" ], mapper: { @@ -6533,7 +6453,7 @@ export const timeout30: msRest.OperationQueryParameter = { export const timeout31: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobListPreparationAndReleaseTaskStatusOptions", + "jobGetTaskCountsOptions", "timeout" ], mapper: { @@ -6547,7 +6467,7 @@ export const timeout31: msRest.OperationQueryParameter = { export const timeout32: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobGetTaskCountsOptions", + "certificateAddOptions", "timeout" ], mapper: { @@ -6561,7 +6481,7 @@ export const timeout32: msRest.OperationQueryParameter = { export const timeout33: msRest.OperationQueryParameter = { parameterPath: [ "options", - "certificateAddOptions", + "certificateListOptions", "timeout" ], mapper: { @@ -6575,7 +6495,7 @@ export const timeout33: msRest.OperationQueryParameter = { export const timeout34: msRest.OperationQueryParameter = { parameterPath: [ "options", - "certificateListOptions", + "certificateCancelDeletionOptions", "timeout" ], mapper: { @@ -6589,7 +6509,7 @@ export const timeout34: msRest.OperationQueryParameter = { export const timeout35: msRest.OperationQueryParameter = { parameterPath: [ "options", - "certificateCancelDeletionOptions", + "certificateDeleteMethodOptions", "timeout" ], mapper: { @@ -6603,7 +6523,7 @@ export const timeout35: msRest.OperationQueryParameter = { export const timeout36: msRest.OperationQueryParameter = { parameterPath: [ "options", - "certificateDeleteMethodOptions", + "certificateGetOptions", "timeout" ], mapper: { @@ -6617,7 +6537,7 @@ export const timeout36: msRest.OperationQueryParameter = { export const timeout37: msRest.OperationQueryParameter = { parameterPath: [ "options", - "certificateGetOptions", + "fileDeleteFromTaskOptions", "timeout" ], mapper: { @@ -6631,7 +6551,7 @@ export const timeout37: msRest.OperationQueryParameter = { export const timeout38: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileDeleteFromTaskOptions", + "fileGetFromTaskOptions", "timeout" ], mapper: { @@ -6645,7 +6565,7 @@ export const timeout38: msRest.OperationQueryParameter = { export const timeout39: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileGetFromTaskOptions", + "fileGetPropertiesFromTaskOptions", "timeout" ], mapper: { @@ -6673,7 +6593,7 @@ export const timeout4: msRest.OperationQueryParameter = { export const timeout40: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileGetPropertiesFromTaskOptions", + "fileDeleteFromComputeNodeOptions", "timeout" ], mapper: { @@ -6687,7 +6607,7 @@ export const timeout40: msRest.OperationQueryParameter = { export const timeout41: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileDeleteFromComputeNodeOptions", + "fileGetFromComputeNodeOptions", "timeout" ], mapper: { @@ -6701,7 +6621,7 @@ export const timeout41: msRest.OperationQueryParameter = { export const timeout42: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileGetFromComputeNodeOptions", + "fileGetPropertiesFromComputeNodeOptions", "timeout" ], mapper: { @@ -6715,7 +6635,7 @@ export const timeout42: msRest.OperationQueryParameter = { export const timeout43: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileGetPropertiesFromComputeNodeOptions", + "fileListFromTaskOptions", "timeout" ], mapper: { @@ -6729,7 +6649,7 @@ export const timeout43: msRest.OperationQueryParameter = { export const timeout44: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileListFromTaskOptions", + "fileListFromComputeNodeOptions", "timeout" ], mapper: { @@ -6743,7 +6663,7 @@ export const timeout44: msRest.OperationQueryParameter = { export const timeout45: msRest.OperationQueryParameter = { parameterPath: [ "options", - "fileListFromComputeNodeOptions", + "jobScheduleExistsOptions", "timeout" ], mapper: { @@ -6757,7 +6677,7 @@ export const timeout45: msRest.OperationQueryParameter = { export const timeout46: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleExistsOptions", + "jobScheduleDeleteMethodOptions", "timeout" ], mapper: { @@ -6771,7 +6691,7 @@ export const timeout46: msRest.OperationQueryParameter = { export const timeout47: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleDeleteMethodOptions", + "jobScheduleGetOptions", "timeout" ], mapper: { @@ -6785,7 +6705,7 @@ export const timeout47: msRest.OperationQueryParameter = { export const timeout48: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleGetOptions", + "jobSchedulePatchOptions", "timeout" ], mapper: { @@ -6799,7 +6719,7 @@ export const timeout48: msRest.OperationQueryParameter = { export const timeout49: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobSchedulePatchOptions", + "jobScheduleUpdateOptions", "timeout" ], mapper: { @@ -6827,7 +6747,7 @@ export const timeout5: msRest.OperationQueryParameter = { export const timeout50: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleUpdateOptions", + "jobScheduleDisableOptions", "timeout" ], mapper: { @@ -6841,7 +6761,7 @@ export const timeout50: msRest.OperationQueryParameter = { export const timeout51: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleDisableOptions", + "jobScheduleEnableOptions", "timeout" ], mapper: { @@ -6855,7 +6775,7 @@ export const timeout51: msRest.OperationQueryParameter = { export const timeout52: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleEnableOptions", + "jobScheduleTerminateOptions", "timeout" ], mapper: { @@ -6869,7 +6789,7 @@ export const timeout52: msRest.OperationQueryParameter = { export const timeout53: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleTerminateOptions", + "jobScheduleAddOptions", "timeout" ], mapper: { @@ -6883,7 +6803,7 @@ export const timeout53: msRest.OperationQueryParameter = { export const timeout54: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleAddOptions", + "jobScheduleListOptions", "timeout" ], mapper: { @@ -6897,7 +6817,7 @@ export const timeout54: msRest.OperationQueryParameter = { export const timeout55: msRest.OperationQueryParameter = { parameterPath: [ "options", - "jobScheduleListOptions", + "taskAddOptions", "timeout" ], mapper: { @@ -6911,7 +6831,7 @@ export const timeout55: msRest.OperationQueryParameter = { export const timeout56: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskAddOptions", + "taskListOptions", "timeout" ], mapper: { @@ -6925,7 +6845,7 @@ export const timeout56: msRest.OperationQueryParameter = { export const timeout57: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskListOptions", + "taskAddCollectionOptions", "timeout" ], mapper: { @@ -6939,7 +6859,7 @@ export const timeout57: msRest.OperationQueryParameter = { export const timeout58: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskAddCollectionOptions", + "taskDeleteMethodOptions", "timeout" ], mapper: { @@ -6953,7 +6873,7 @@ export const timeout58: msRest.OperationQueryParameter = { export const timeout59: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskDeleteMethodOptions", + "taskGetOptions", "timeout" ], mapper: { @@ -6981,7 +6901,7 @@ export const timeout6: msRest.OperationQueryParameter = { export const timeout60: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskGetOptions", + "taskUpdateOptions", "timeout" ], mapper: { @@ -6995,7 +6915,7 @@ export const timeout60: msRest.OperationQueryParameter = { export const timeout61: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskUpdateOptions", + "taskListSubtasksOptions", "timeout" ], mapper: { @@ -7009,7 +6929,7 @@ export const timeout61: msRest.OperationQueryParameter = { export const timeout62: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskListSubtasksOptions", + "taskTerminateOptions", "timeout" ], mapper: { @@ -7023,7 +6943,7 @@ export const timeout62: msRest.OperationQueryParameter = { export const timeout63: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskTerminateOptions", + "taskReactivateOptions", "timeout" ], mapper: { @@ -7037,7 +6957,7 @@ export const timeout63: msRest.OperationQueryParameter = { export const timeout64: msRest.OperationQueryParameter = { parameterPath: [ "options", - "taskReactivateOptions", + "computeNodeAddUserOptions", "timeout" ], mapper: { @@ -7051,7 +6971,7 @@ export const timeout64: msRest.OperationQueryParameter = { export const timeout65: msRest.OperationQueryParameter = { parameterPath: [ "options", - "computeNodeAddUserOptions", + "computeNodeDeleteUserOptions", "timeout" ], mapper: { @@ -7065,7 +6985,7 @@ export const timeout65: msRest.OperationQueryParameter = { export const timeout66: msRest.OperationQueryParameter = { parameterPath: [ "options", - "computeNodeDeleteUserOptions", + "computeNodeUpdateUserOptions", "timeout" ], mapper: { @@ -7079,7 +6999,7 @@ export const timeout66: msRest.OperationQueryParameter = { export const timeout67: msRest.OperationQueryParameter = { parameterPath: [ "options", - "computeNodeUpdateUserOptions", + "computeNodeGetOptions", "timeout" ], mapper: { @@ -7093,7 +7013,7 @@ export const timeout67: msRest.OperationQueryParameter = { export const timeout68: msRest.OperationQueryParameter = { parameterPath: [ "options", - "computeNodeGetOptions", + "computeNodeRebootOptions", "timeout" ], mapper: { @@ -7107,7 +7027,7 @@ export const timeout68: msRest.OperationQueryParameter = { export const timeout69: msRest.OperationQueryParameter = { parameterPath: [ "options", - "computeNodeRebootOptions", + "computeNodeReimageOptions", "timeout" ], mapper: { @@ -7133,20 +7053,6 @@ export const timeout7: msRest.OperationQueryParameter = { } }; export const timeout70: msRest.OperationQueryParameter = { - parameterPath: [ - "options", - "computeNodeReimageOptions", - "timeout" - ], - mapper: { - serializedName: "timeout", - defaultValue: 30, - type: { - name: "Number" - } - } -}; -export const timeout71: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeDisableSchedulingOptions", @@ -7160,7 +7066,7 @@ export const timeout71: msRest.OperationQueryParameter = { } } }; -export const timeout72: msRest.OperationQueryParameter = { +export const timeout71: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeEnableSchedulingOptions", @@ -7174,7 +7080,7 @@ export const timeout72: msRest.OperationQueryParameter = { } } }; -export const timeout73: msRest.OperationQueryParameter = { +export const timeout72: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeGetRemoteLoginSettingsOptions", @@ -7188,7 +7094,7 @@ export const timeout73: msRest.OperationQueryParameter = { } } }; -export const timeout74: msRest.OperationQueryParameter = { +export const timeout73: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeGetRemoteDesktopOptions", @@ -7202,7 +7108,7 @@ export const timeout74: msRest.OperationQueryParameter = { } } }; -export const timeout75: msRest.OperationQueryParameter = { +export const timeout74: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeUploadBatchServiceLogsOptions", @@ -7216,7 +7122,7 @@ export const timeout75: msRest.OperationQueryParameter = { } } }; -export const timeout76: msRest.OperationQueryParameter = { +export const timeout75: msRest.OperationQueryParameter = { parameterPath: [ "options", "computeNodeListOptions", diff --git a/sdk/batch/batch/src/models/poolMappers.ts b/sdk/batch/batch/src/models/poolMappers.ts index 95f181ade6d5..0b64a7676299 100644 --- a/sdk/batch/batch/src/models/poolMappers.ts +++ b/sdk/batch/batch/src/models/poolMappers.ts @@ -1,75 +1,70 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - PoolListUsageMetricsResult, - PoolUsageMetrics, - PoolListUsageMetricsHeaders, + ApplicationPackageReference, + AutoScaleRun, + AutoScaleRunError, + AutoUserSpecification, BatchError, - ErrorMessage, BatchErrorDetail, - PoolStatistics, - UsageStatistics, - ResourceStatistics, - PoolGetAllLifetimeStatisticsHeaders, - PoolAddParameter, + CertificateReference, + CloudPool, + CloudPoolListResult, CloudServiceConfiguration, - VirtualMachineConfiguration, - ImageReference, - OSDisk, - WindowsConfiguration, - DataDisk, ContainerConfiguration, ContainerRegistry, - NetworkConfiguration, - PoolEndpointConfiguration, - InboundNATPool, - NetworkSecurityGroupRule, - StartTask, - TaskContainerSettings, - ResourceFile, + DataDisk, EnvironmentSetting, - UserIdentity, - AutoUserSpecification, - CertificateReference, - ApplicationPackageReference, - TaskSchedulingPolicy, - UserAccount, + ErrorMessage, + ImageReference, + InboundNATPool, LinuxUserConfiguration, MetadataItem, - PoolAddHeaders, - CloudPoolListResult, - CloudPool, - ResizeError, NameValuePair, - AutoScaleRun, - AutoScaleRunError, - PoolListHeaders, + NetworkConfiguration, + NetworkSecurityGroupRule, + NodeRemoveParameter, + PoolAddHeaders, + PoolAddParameter, PoolDeleteHeaders, - PoolExistsHeaders, - PoolGetHeaders, - PoolPatchParameter, - PoolPatchHeaders, PoolDisableAutoScaleHeaders, - PoolEnableAutoScaleParameter, PoolEnableAutoScaleHeaders, - PoolEvaluateAutoScaleParameter, + PoolEnableAutoScaleParameter, + PoolEndpointConfiguration, PoolEvaluateAutoScaleHeaders, - PoolResizeParameter, + PoolEvaluateAutoScaleParameter, + PoolExistsHeaders, + PoolGetAllLifetimeStatisticsHeaders, + PoolGetHeaders, + PoolListHeaders, + PoolListUsageMetricsHeaders, + PoolListUsageMetricsResult, + PoolPatchHeaders, + PoolPatchParameter, + PoolRemoveNodesHeaders, PoolResizeHeaders, + PoolResizeParameter, + PoolStatistics, PoolStopResizeHeaders, - PoolUpdatePropertiesParameter, PoolUpdatePropertiesHeaders, - PoolUpgradeOSParameter, - PoolUpgradeOSHeaders, - NodeRemoveParameter, - PoolRemoveNodesHeaders + PoolUpdatePropertiesParameter, + PoolUsageMetrics, + ResizeError, + ResourceFile, + ResourceStatistics, + StartTask, + TaskContainerSettings, + TaskSchedulingPolicy, + UsageStatistics, + UserAccount, + UserIdentity, + VirtualMachineConfiguration, + WindowsConfiguration, + WindowsUserConfiguration } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/models/taskMappers.ts b/sdk/batch/batch/src/models/taskMappers.ts index e71f2fcfe8b9..84ef079bc951 100644 --- a/sdk/batch/batch/src/models/taskMappers.ts +++ b/sdk/batch/batch/src/models/taskMappers.ts @@ -1,61 +1,58 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - TaskAddParameter, - TaskContainerSettings, - ContainerRegistry, - ExitConditions, - ExitCodeMapping, - ExitOptions, - ExitCodeRangeMapping, - ResourceFile, - OutputFile, - OutputFileDestination, - OutputFileBlobContainerDestination, - OutputFileUploadOptions, - EnvironmentSetting, AffinityInformation, - TaskConstraints, - UserIdentity, - AutoUserSpecification, - MultiInstanceSettings, - TaskDependencies, - TaskIdRange, ApplicationPackageReference, AuthenticationTokenSettings, - TaskAddHeaders, + AutoUserSpecification, BatchError, - ErrorMessage, BatchErrorDetail, - CloudTaskListResult, CloudTask, - TaskExecutionInformation, - TaskContainerExecutionInformation, - TaskFailureInformation, - NameValuePair, + CloudTaskListResult, + CloudTaskListSubtasksResult, ComputeNodeInformation, - TaskStatistics, - TaskListHeaders, + ContainerRegistry, + EnvironmentSetting, + ErrorMessage, + ExitCodeMapping, + ExitCodeRangeMapping, + ExitConditions, + ExitOptions, + MultiInstanceSettings, + NameValuePair, + OutputFile, + OutputFileBlobContainerDestination, + OutputFileDestination, + OutputFileUploadOptions, + ResourceFile, + SubtaskInformation, + TaskAddCollectionHeaders, TaskAddCollectionParameter, TaskAddCollectionResult, + TaskAddHeaders, + TaskAddParameter, TaskAddResult, - TaskAddCollectionHeaders, + TaskConstraints, + TaskContainerExecutionInformation, + TaskContainerSettings, TaskDeleteHeaders, + TaskDependencies, + TaskExecutionInformation, + TaskFailureInformation, TaskGetHeaders, - TaskUpdateParameter, - TaskUpdateHeaders, - CloudTaskListSubtasksResult, - SubtaskInformation, + TaskIdRange, + TaskListHeaders, TaskListSubtasksHeaders, + TaskReactivateHeaders, + TaskStatistics, TaskTerminateHeaders, - TaskReactivateHeaders + TaskUpdateHeaders, + TaskUpdateParameter, + UserIdentity } from "../models/mappers"; - diff --git a/sdk/batch/batch/src/operations/account.ts b/sdk/batch/batch/src/operations/account.ts index 94e2823d5602..aefa31e9c111 100644 --- a/sdk/batch/batch/src/operations/account.ts +++ b/sdk/batch/batch/src/operations/account.ts @@ -136,17 +136,20 @@ const serializer = new msRest.Serializer(Mappers); const listNodeAgentSkusOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "nodeagentskus", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter2, Parameters.maxResults3, - Parameters.timeout18 + Parameters.timeout17 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId21, - Parameters.returnClientRequestId21, - Parameters.ocpDate21 + Parameters.clientRequestId20, + Parameters.returnClientRequestId20, + Parameters.ocpDate20 ], responses: { 200: { @@ -163,17 +166,20 @@ const listNodeAgentSkusOperationSpec: msRest.OperationSpec = { const listPoolNodeCountsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "nodecounts", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter3, Parameters.maxResults4, - Parameters.timeout19 + Parameters.timeout18 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId22, - Parameters.returnClientRequestId22, - Parameters.ocpDate22 + Parameters.clientRequestId21, + Parameters.returnClientRequestId21, + Parameters.ocpDate21 ], responses: { 200: { @@ -189,16 +195,16 @@ const listPoolNodeCountsOperationSpec: msRest.OperationSpec = { const listNodeAgentSkusNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId23, - Parameters.returnClientRequestId23, - Parameters.ocpDate23 + Parameters.clientRequestId22, + Parameters.returnClientRequestId22, + Parameters.ocpDate22 ], responses: { 200: { @@ -214,16 +220,16 @@ const listNodeAgentSkusNextOperationSpec: msRest.OperationSpec = { const listPoolNodeCountsNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId24, - Parameters.returnClientRequestId24, - Parameters.ocpDate24 + Parameters.clientRequestId23, + Parameters.returnClientRequestId23, + Parameters.ocpDate23 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/application.ts b/sdk/batch/batch/src/operations/application.ts index 73ecd2fc69b2..d689f9bb17ab 100644 --- a/sdk/batch/batch/src/operations/application.ts +++ b/sdk/batch/batch/src/operations/application.ts @@ -124,6 +124,9 @@ const serializer = new msRest.Serializer(Mappers); const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "applications", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.maxResults0, @@ -151,6 +154,7 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "applications/{applicationId}", urlParameters: [ + Parameters.batchUrl, Parameters.applicationId ], queryParameters: [ @@ -177,7 +181,7 @@ const getOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink diff --git a/sdk/batch/batch/src/operations/certificateOperations.ts b/sdk/batch/batch/src/operations/certificateOperations.ts index 7ebcd1487746..7cbabb12ffc7 100644 --- a/sdk/batch/batch/src/operations/certificateOperations.ts +++ b/sdk/batch/batch/src/operations/certificateOperations.ts @@ -231,15 +231,18 @@ const serializer = new msRest.Serializer(Mappers); const addOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "certificates", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout33 + Parameters.timeout32 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId41, - Parameters.returnClientRequestId41, - Parameters.ocpDate41 + Parameters.clientRequestId40, + Parameters.returnClientRequestId40, + Parameters.ocpDate40 ], requestBody: { parameterPath: "certificate", @@ -263,18 +266,21 @@ const addOperationSpec: msRest.OperationSpec = { const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "certificates", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter7, Parameters.select6, Parameters.maxResults8, - Parameters.timeout34 + Parameters.timeout33 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId42, - Parameters.returnClientRequestId42, - Parameters.ocpDate42 + Parameters.clientRequestId41, + Parameters.returnClientRequestId41, + Parameters.ocpDate41 ], responses: { 200: { @@ -292,18 +298,19 @@ const cancelDeletionOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete", urlParameters: [ + Parameters.batchUrl, Parameters.thumbprintAlgorithm, Parameters.thumbprint ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout35 + Parameters.timeout34 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId43, - Parameters.returnClientRequestId43, - Parameters.ocpDate43 + Parameters.clientRequestId42, + Parameters.returnClientRequestId42, + Parameters.ocpDate42 ], responses: { 204: { @@ -320,18 +327,19 @@ const deleteMethodOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})", urlParameters: [ + Parameters.batchUrl, Parameters.thumbprintAlgorithm, Parameters.thumbprint ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout36 + Parameters.timeout35 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId44, - Parameters.returnClientRequestId44, - Parameters.ocpDate44 + Parameters.clientRequestId43, + Parameters.returnClientRequestId43, + Parameters.ocpDate43 ], responses: { 202: { @@ -348,19 +356,20 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})", urlParameters: [ + Parameters.batchUrl, Parameters.thumbprintAlgorithm, Parameters.thumbprint ], queryParameters: [ Parameters.apiVersion, Parameters.select7, - Parameters.timeout37 + Parameters.timeout36 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId45, - Parameters.returnClientRequestId45, - Parameters.ocpDate45 + Parameters.clientRequestId44, + Parameters.returnClientRequestId44, + Parameters.ocpDate44 ], responses: { 200: { @@ -376,16 +385,16 @@ const getOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId46, - Parameters.returnClientRequestId46, - Parameters.ocpDate46 + Parameters.clientRequestId45, + Parameters.returnClientRequestId45, + Parameters.ocpDate45 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/computeNodeOperations.ts b/sdk/batch/batch/src/operations/computeNodeOperations.ts index 66ad872e10e3..3ffcd01b7dc2 100644 --- a/sdk/batch/batch/src/operations/computeNodeOperations.ts +++ b/sdk/batch/batch/src/operations/computeNodeOperations.ts @@ -101,7 +101,7 @@ export class ComputeNodeOperations { } /** - * This operation replaces of all the updateable properties of the account. For example, if the + * This operation replaces of all the updatable properties of the account. For example, if the * expiryTime element is not specified, the current value is replaced with the default value, not * left unmodified. You can update a user account on a node only when it is in the idle or running * state. @@ -493,18 +493,19 @@ const addUserOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/users", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout65 + Parameters.timeout64 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId78, - Parameters.returnClientRequestId78, - Parameters.ocpDate78 + Parameters.clientRequestId77, + Parameters.returnClientRequestId77, + Parameters.ocpDate77 ], requestBody: { parameterPath: "user", @@ -529,19 +530,20 @@ const deleteUserOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "pools/{poolId}/nodes/{nodeId}/users/{userName}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId, Parameters.userName ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout66 + Parameters.timeout65 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId79, - Parameters.returnClientRequestId79, - Parameters.ocpDate79 + Parameters.clientRequestId78, + Parameters.returnClientRequestId78, + Parameters.ocpDate78 ], responses: { 200: { @@ -558,19 +560,20 @@ const updateUserOperationSpec: msRest.OperationSpec = { httpMethod: "PUT", path: "pools/{poolId}/nodes/{nodeId}/users/{userName}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId, Parameters.userName ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout67 + Parameters.timeout66 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId80, - Parameters.returnClientRequestId80, - Parameters.ocpDate80 + Parameters.clientRequestId79, + Parameters.returnClientRequestId79, + Parameters.ocpDate79 ], requestBody: { parameterPath: "nodeUpdateUserParameter", @@ -595,19 +598,20 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes/{nodeId}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, Parameters.select13, - Parameters.timeout68 + Parameters.timeout67 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId81, - Parameters.returnClientRequestId81, - Parameters.ocpDate81 + Parameters.clientRequestId80, + Parameters.returnClientRequestId80, + Parameters.ocpDate80 ], responses: { 200: { @@ -625,18 +629,19 @@ const rebootOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/reboot", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout69 + Parameters.timeout68 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId82, - Parameters.returnClientRequestId82, - Parameters.ocpDate82 + Parameters.clientRequestId81, + Parameters.returnClientRequestId81, + Parameters.ocpDate81 ], requestBody: { parameterPath: { @@ -663,18 +668,19 @@ const reimageOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/reimage", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout70 + Parameters.timeout69 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId83, - Parameters.returnClientRequestId83, - Parameters.ocpDate83 + Parameters.clientRequestId82, + Parameters.returnClientRequestId82, + Parameters.ocpDate82 ], requestBody: { parameterPath: { @@ -701,18 +707,19 @@ const disableSchedulingOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/disablescheduling", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout71 + Parameters.timeout70 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId84, - Parameters.returnClientRequestId84, - Parameters.ocpDate84 + Parameters.clientRequestId83, + Parameters.returnClientRequestId83, + Parameters.ocpDate83 ], requestBody: { parameterPath: { @@ -739,18 +746,19 @@ const enableSchedulingOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/enablescheduling", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout72 + Parameters.timeout71 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId85, - Parameters.returnClientRequestId85, - Parameters.ocpDate85 + Parameters.clientRequestId84, + Parameters.returnClientRequestId84, + Parameters.ocpDate84 ], responses: { 200: { @@ -767,18 +775,19 @@ const getRemoteLoginSettingsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes/{nodeId}/remoteloginsettings", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout73 + Parameters.timeout72 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId86, - Parameters.returnClientRequestId86, - Parameters.ocpDate86 + Parameters.clientRequestId85, + Parameters.returnClientRequestId85, + Parameters.ocpDate85 ], responses: { 200: { @@ -796,18 +805,19 @@ const getRemoteDesktopOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes/{nodeId}/rdp", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout74 + Parameters.timeout73 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId87, - Parameters.returnClientRequestId87, - Parameters.ocpDate87 + Parameters.clientRequestId86, + Parameters.returnClientRequestId86, + Parameters.ocpDate86 ], responses: { 200: { @@ -830,18 +840,19 @@ const uploadBatchServiceLogsOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout75 + Parameters.timeout74 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId88, - Parameters.returnClientRequestId88, - Parameters.ocpDate88 + Parameters.clientRequestId87, + Parameters.returnClientRequestId87, + Parameters.ocpDate87 ], requestBody: { parameterPath: "uploadBatchServiceLogsConfiguration", @@ -867,6 +878,7 @@ const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -874,13 +886,13 @@ const listOperationSpec: msRest.OperationSpec = { Parameters.filter12, Parameters.select14, Parameters.maxResults13, - Parameters.timeout76 + Parameters.timeout75 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId89, - Parameters.returnClientRequestId89, - Parameters.ocpDate89 + Parameters.clientRequestId88, + Parameters.returnClientRequestId88, + Parameters.ocpDate88 ], responses: { 200: { @@ -896,16 +908,16 @@ const listOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId90, - Parameters.returnClientRequestId90, - Parameters.ocpDate90 + Parameters.clientRequestId89, + Parameters.returnClientRequestId89, + Parameters.ocpDate89 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/file.ts b/sdk/batch/batch/src/operations/file.ts index c9459fc9dfe5..75169781d916 100644 --- a/sdk/batch/batch/src/operations/file.ts +++ b/sdk/batch/batch/src/operations/file.ts @@ -369,6 +369,7 @@ const deleteFromTaskOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "jobs/{jobId}/tasks/{taskId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId, Parameters.filePath @@ -376,13 +377,13 @@ const deleteFromTaskOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.recursive, Parameters.apiVersion, - Parameters.timeout38 + Parameters.timeout37 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId47, - Parameters.returnClientRequestId47, - Parameters.ocpDate47 + Parameters.clientRequestId46, + Parameters.returnClientRequestId46, + Parameters.ocpDate46 ], responses: { 200: { @@ -399,22 +400,23 @@ const getFromTaskOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/tasks/{taskId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId, Parameters.filePath ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout39 + Parameters.timeout38 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId48, - Parameters.returnClientRequestId48, - Parameters.ocpDate48, + Parameters.clientRequestId47, + Parameters.returnClientRequestId47, + Parameters.ocpDate47, Parameters.ocpRange0, - Parameters.ifModifiedSince16, - Parameters.ifUnmodifiedSince16 + Parameters.ifModifiedSince15, + Parameters.ifUnmodifiedSince15 ], responses: { 200: { @@ -437,21 +439,22 @@ const getPropertiesFromTaskOperationSpec: msRest.OperationSpec = { httpMethod: "HEAD", path: "jobs/{jobId}/tasks/{taskId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId, Parameters.filePath ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout40 + Parameters.timeout39 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId49, - Parameters.returnClientRequestId49, - Parameters.ocpDate49, - Parameters.ifModifiedSince17, - Parameters.ifUnmodifiedSince17 + Parameters.clientRequestId48, + Parameters.returnClientRequestId48, + Parameters.ocpDate48, + Parameters.ifModifiedSince16, + Parameters.ifUnmodifiedSince16 ], responses: { 200: { @@ -468,6 +471,7 @@ const deleteFromComputeNodeOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "pools/{poolId}/nodes/{nodeId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId, Parameters.filePath @@ -475,13 +479,13 @@ const deleteFromComputeNodeOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.recursive, Parameters.apiVersion, - Parameters.timeout41 + Parameters.timeout40 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId50, - Parameters.returnClientRequestId50, - Parameters.ocpDate50 + Parameters.clientRequestId49, + Parameters.returnClientRequestId49, + Parameters.ocpDate49 ], responses: { 200: { @@ -498,22 +502,23 @@ const getFromComputeNodeOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes/{nodeId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId, Parameters.filePath ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout42 + Parameters.timeout41 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId51, - Parameters.returnClientRequestId51, - Parameters.ocpDate51, + Parameters.clientRequestId50, + Parameters.returnClientRequestId50, + Parameters.ocpDate50, Parameters.ocpRange1, - Parameters.ifModifiedSince18, - Parameters.ifUnmodifiedSince18 + Parameters.ifModifiedSince17, + Parameters.ifUnmodifiedSince17 ], responses: { 200: { @@ -536,21 +541,22 @@ const getPropertiesFromComputeNodeOperationSpec: msRest.OperationSpec = { httpMethod: "HEAD", path: "pools/{poolId}/nodes/{nodeId}/files/{filePath}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId, Parameters.filePath ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout43 + Parameters.timeout42 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId52, - Parameters.returnClientRequestId52, - Parameters.ocpDate52, - Parameters.ifModifiedSince19, - Parameters.ifUnmodifiedSince19 + Parameters.clientRequestId51, + Parameters.returnClientRequestId51, + Parameters.ocpDate51, + Parameters.ifModifiedSince18, + Parameters.ifUnmodifiedSince18 ], responses: { 200: { @@ -567,6 +573,7 @@ const listFromTaskOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/tasks/{taskId}/files", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], @@ -575,13 +582,13 @@ const listFromTaskOperationSpec: msRest.OperationSpec = { Parameters.apiVersion, Parameters.filter8, Parameters.maxResults9, - Parameters.timeout44 + Parameters.timeout43 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId53, - Parameters.returnClientRequestId53, - Parameters.ocpDate53 + Parameters.clientRequestId52, + Parameters.returnClientRequestId52, + Parameters.ocpDate52 ], responses: { 200: { @@ -599,6 +606,7 @@ const listFromComputeNodeOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}/nodes/{nodeId}/files", urlParameters: [ + Parameters.batchUrl, Parameters.poolId, Parameters.nodeId ], @@ -607,13 +615,13 @@ const listFromComputeNodeOperationSpec: msRest.OperationSpec = { Parameters.apiVersion, Parameters.filter9, Parameters.maxResults10, - Parameters.timeout45 + Parameters.timeout44 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId54, - Parameters.returnClientRequestId54, - Parameters.ocpDate54 + Parameters.clientRequestId53, + Parameters.returnClientRequestId53, + Parameters.ocpDate53 ], responses: { 200: { @@ -629,16 +637,16 @@ const listFromComputeNodeOperationSpec: msRest.OperationSpec = { const listFromTaskNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId55, - Parameters.returnClientRequestId55, - Parameters.ocpDate55 + Parameters.clientRequestId54, + Parameters.returnClientRequestId54, + Parameters.ocpDate54 ], responses: { 200: { @@ -654,16 +662,16 @@ const listFromTaskNextOperationSpec: msRest.OperationSpec = { const listFromComputeNodeNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId56, - Parameters.returnClientRequestId56, - Parameters.ocpDate56 + Parameters.clientRequestId55, + Parameters.returnClientRequestId55, + Parameters.ocpDate55 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/job.ts b/sdk/batch/batch/src/operations/job.ts index 7b05ec29b1a5..032091ec6211 100644 --- a/sdk/batch/batch/src/operations/job.ts +++ b/sdk/batch/batch/src/operations/job.ts @@ -153,7 +153,7 @@ export class Job { } /** - * This fully replaces all the updateable properties of the job. For example, if the job has + * This fully replaces all the updatable properties of the job. For example, if the job has * constraints associated with it and if constraints is not specified with this request, then the * Batch service will remove the existing constraints. * @summary Updates the properties of the specified job. @@ -233,8 +233,8 @@ export class Job { * When you call this API, the Batch service sets a disabled job to the enabling state. After the * this operation is completed, the job moves to the active state, and scheduling of new tasks * under the job resumes. The Batch service does not allow a task to remain in the active state for - * more than 7 days. Therefore, if you enable a job containing active tasks which were added more - * than 7 days ago, those tasks will not run. + * more than 180 days. Therefore, if you enable a job containing active tasks which were added more + * than 180 days ago, those tasks will not run. * @summary Enables the specified job, allowing new tasks to run. * @param jobId The ID of the job to enable. * @param [options] The optional parameters @@ -542,15 +542,18 @@ const serializer = new msRest.Serializer(Mappers); const getAllLifetimeStatisticsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "lifetimejobstats", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout20 + Parameters.timeout19 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId25, - Parameters.returnClientRequestId25, - Parameters.ocpDate25 + Parameters.clientRequestId24, + Parameters.returnClientRequestId24, + Parameters.ocpDate24 ], responses: { 200: { @@ -568,21 +571,22 @@ const deleteMethodOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "jobs/{jobId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout21 + Parameters.timeout20 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId26, - Parameters.returnClientRequestId26, - Parameters.ocpDate26, - Parameters.ifMatch9, - Parameters.ifNoneMatch9, - Parameters.ifModifiedSince9, - Parameters.ifUnmodifiedSince9 + Parameters.clientRequestId25, + Parameters.returnClientRequestId25, + Parameters.ocpDate25, + Parameters.ifMatch8, + Parameters.ifNoneMatch8, + Parameters.ifModifiedSince8, + Parameters.ifUnmodifiedSince8 ], responses: { 202: { @@ -599,23 +603,24 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, Parameters.select2, Parameters.expand2, - Parameters.timeout22 + Parameters.timeout21 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId27, - Parameters.returnClientRequestId27, - Parameters.ocpDate27, - Parameters.ifMatch10, - Parameters.ifNoneMatch10, - Parameters.ifModifiedSince10, - Parameters.ifUnmodifiedSince10 + Parameters.clientRequestId26, + Parameters.returnClientRequestId26, + Parameters.ocpDate26, + Parameters.ifMatch9, + Parameters.ifNoneMatch9, + Parameters.ifModifiedSince9, + Parameters.ifUnmodifiedSince9 ], responses: { 200: { @@ -633,21 +638,22 @@ const patchOperationSpec: msRest.OperationSpec = { httpMethod: "PATCH", path: "jobs/{jobId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout23 + Parameters.timeout22 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId28, - Parameters.returnClientRequestId28, - Parameters.ocpDate28, - Parameters.ifMatch11, - Parameters.ifNoneMatch11, - Parameters.ifModifiedSince11, - Parameters.ifUnmodifiedSince11 + Parameters.clientRequestId27, + Parameters.returnClientRequestId27, + Parameters.ocpDate27, + Parameters.ifMatch10, + Parameters.ifNoneMatch10, + Parameters.ifModifiedSince10, + Parameters.ifUnmodifiedSince10 ], requestBody: { parameterPath: "jobPatchParameter", @@ -672,21 +678,22 @@ const updateOperationSpec: msRest.OperationSpec = { httpMethod: "PUT", path: "jobs/{jobId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout24 + Parameters.timeout23 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId29, - Parameters.returnClientRequestId29, - Parameters.ocpDate29, - Parameters.ifMatch12, - Parameters.ifNoneMatch12, - Parameters.ifModifiedSince12, - Parameters.ifUnmodifiedSince12 + Parameters.clientRequestId28, + Parameters.returnClientRequestId28, + Parameters.ocpDate28, + Parameters.ifMatch11, + Parameters.ifNoneMatch11, + Parameters.ifModifiedSince11, + Parameters.ifUnmodifiedSince11 ], requestBody: { parameterPath: "jobUpdateParameter", @@ -711,21 +718,22 @@ const disableOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/disable", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout25 + Parameters.timeout24 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId30, - Parameters.returnClientRequestId30, - Parameters.ocpDate30, - Parameters.ifMatch13, - Parameters.ifNoneMatch13, - Parameters.ifModifiedSince13, - Parameters.ifUnmodifiedSince13 + Parameters.clientRequestId29, + Parameters.returnClientRequestId29, + Parameters.ocpDate29, + Parameters.ifMatch12, + Parameters.ifNoneMatch12, + Parameters.ifModifiedSince12, + Parameters.ifUnmodifiedSince12 ], requestBody: { parameterPath: { @@ -752,21 +760,22 @@ const enableOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/enable", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout26 + Parameters.timeout25 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId31, - Parameters.returnClientRequestId31, - Parameters.ocpDate31, - Parameters.ifMatch14, - Parameters.ifNoneMatch14, - Parameters.ifModifiedSince14, - Parameters.ifUnmodifiedSince14 + Parameters.clientRequestId30, + Parameters.returnClientRequestId30, + Parameters.ocpDate30, + Parameters.ifMatch13, + Parameters.ifNoneMatch13, + Parameters.ifModifiedSince13, + Parameters.ifUnmodifiedSince13 ], responses: { 202: { @@ -783,21 +792,22 @@ const terminateOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/terminate", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout27 + Parameters.timeout26 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId32, - Parameters.returnClientRequestId32, - Parameters.ocpDate32, - Parameters.ifMatch15, - Parameters.ifNoneMatch15, - Parameters.ifModifiedSince15, - Parameters.ifUnmodifiedSince15 + Parameters.clientRequestId31, + Parameters.returnClientRequestId31, + Parameters.ocpDate31, + Parameters.ifMatch14, + Parameters.ifNoneMatch14, + Parameters.ifModifiedSince14, + Parameters.ifUnmodifiedSince14 ], requestBody: { parameterPath: { @@ -823,15 +833,18 @@ const terminateOperationSpec: msRest.OperationSpec = { const addOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout28 + Parameters.timeout27 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId33, - Parameters.returnClientRequestId33, - Parameters.ocpDate33 + Parameters.clientRequestId32, + Parameters.returnClientRequestId32, + Parameters.ocpDate32 ], requestBody: { parameterPath: "job", @@ -855,19 +868,22 @@ const addOperationSpec: msRest.OperationSpec = { const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter4, Parameters.select3, Parameters.expand3, Parameters.maxResults5, - Parameters.timeout29 + Parameters.timeout28 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId34, - Parameters.returnClientRequestId34, - Parameters.ocpDate34 + Parameters.clientRequestId33, + Parameters.returnClientRequestId33, + Parameters.ocpDate33 ], responses: { 200: { @@ -885,6 +901,7 @@ const listFromJobScheduleOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobschedules/{jobScheduleId}/jobs", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ @@ -893,13 +910,13 @@ const listFromJobScheduleOperationSpec: msRest.OperationSpec = { Parameters.select4, Parameters.expand4, Parameters.maxResults6, - Parameters.timeout30 + Parameters.timeout29 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId35, - Parameters.returnClientRequestId35, - Parameters.ocpDate35 + Parameters.clientRequestId34, + Parameters.returnClientRequestId34, + Parameters.ocpDate34 ], responses: { 200: { @@ -917,6 +934,7 @@ const listPreparationAndReleaseTaskStatusOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/jobpreparationandreleasetaskstatus", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ @@ -924,13 +942,13 @@ const listPreparationAndReleaseTaskStatusOperationSpec: msRest.OperationSpec = { Parameters.filter6, Parameters.select5, Parameters.maxResults7, - Parameters.timeout31 + Parameters.timeout30 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId36, - Parameters.returnClientRequestId36, - Parameters.ocpDate36 + Parameters.clientRequestId35, + Parameters.returnClientRequestId35, + Parameters.ocpDate35 ], responses: { 200: { @@ -948,17 +966,18 @@ const getTaskCountsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/taskcounts", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout32 + Parameters.timeout31 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId37, - Parameters.returnClientRequestId37, - Parameters.ocpDate37 + Parameters.clientRequestId36, + Parameters.returnClientRequestId36, + Parameters.ocpDate36 ], responses: { 200: { @@ -974,16 +993,16 @@ const getTaskCountsOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId38, - Parameters.returnClientRequestId38, - Parameters.ocpDate38 + Parameters.clientRequestId37, + Parameters.returnClientRequestId37, + Parameters.ocpDate37 ], responses: { 200: { @@ -999,16 +1018,16 @@ const listNextOperationSpec: msRest.OperationSpec = { const listFromJobScheduleNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId39, - Parameters.returnClientRequestId39, - Parameters.ocpDate39 + Parameters.clientRequestId38, + Parameters.returnClientRequestId38, + Parameters.ocpDate38 ], responses: { 200: { @@ -1024,16 +1043,16 @@ const listFromJobScheduleNextOperationSpec: msRest.OperationSpec = { const listPreparationAndReleaseTaskStatusNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId40, - Parameters.returnClientRequestId40, - Parameters.ocpDate40 + Parameters.clientRequestId39, + Parameters.returnClientRequestId39, + Parameters.ocpDate39 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/jobSchedule.ts b/sdk/batch/batch/src/operations/jobSchedule.ts index 817c03705690..1aca6bbdd8ad 100644 --- a/sdk/batch/batch/src/operations/jobSchedule.ts +++ b/sdk/batch/batch/src/operations/jobSchedule.ts @@ -152,7 +152,7 @@ export class JobSchedule { } /** - * This fully replaces all the updateable properties of the job schedule. For example, if the + * This fully replaces all the updatable properties of the job schedule. For example, if the * schedule property is not specified with this request, then the Batch service will remove the * existing schedule. Changes to a job schedule only impact jobs created by the schedule after the * update has taken place; currently running jobs are unaffected. @@ -359,21 +359,22 @@ const existsOperationSpec: msRest.OperationSpec = { httpMethod: "HEAD", path: "jobschedules/{jobScheduleId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout46 + Parameters.timeout45 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId57, - Parameters.returnClientRequestId57, - Parameters.ocpDate57, - Parameters.ifMatch16, - Parameters.ifNoneMatch16, - Parameters.ifModifiedSince20, - Parameters.ifUnmodifiedSince20 + Parameters.clientRequestId56, + Parameters.returnClientRequestId56, + Parameters.ocpDate56, + Parameters.ifMatch15, + Parameters.ifNoneMatch15, + Parameters.ifModifiedSince19, + Parameters.ifUnmodifiedSince19 ], responses: { 200: { @@ -393,21 +394,22 @@ const deleteMethodOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "jobschedules/{jobScheduleId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout47 + Parameters.timeout46 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId58, - Parameters.returnClientRequestId58, - Parameters.ocpDate58, - Parameters.ifMatch17, - Parameters.ifNoneMatch17, - Parameters.ifModifiedSince21, - Parameters.ifUnmodifiedSince21 + Parameters.clientRequestId57, + Parameters.returnClientRequestId57, + Parameters.ocpDate57, + Parameters.ifMatch16, + Parameters.ifNoneMatch16, + Parameters.ifModifiedSince20, + Parameters.ifUnmodifiedSince20 ], responses: { 202: { @@ -424,23 +426,24 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobschedules/{jobScheduleId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, Parameters.select8, Parameters.expand5, - Parameters.timeout48 + Parameters.timeout47 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId59, - Parameters.returnClientRequestId59, - Parameters.ocpDate59, - Parameters.ifMatch18, - Parameters.ifNoneMatch18, - Parameters.ifModifiedSince22, - Parameters.ifUnmodifiedSince22 + Parameters.clientRequestId58, + Parameters.returnClientRequestId58, + Parameters.ocpDate58, + Parameters.ifMatch17, + Parameters.ifNoneMatch17, + Parameters.ifModifiedSince21, + Parameters.ifUnmodifiedSince21 ], responses: { 200: { @@ -458,21 +461,22 @@ const patchOperationSpec: msRest.OperationSpec = { httpMethod: "PATCH", path: "jobschedules/{jobScheduleId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout49 + Parameters.timeout48 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId60, - Parameters.returnClientRequestId60, - Parameters.ocpDate60, - Parameters.ifMatch19, - Parameters.ifNoneMatch19, - Parameters.ifModifiedSince23, - Parameters.ifUnmodifiedSince23 + Parameters.clientRequestId59, + Parameters.returnClientRequestId59, + Parameters.ocpDate59, + Parameters.ifMatch18, + Parameters.ifNoneMatch18, + Parameters.ifModifiedSince22, + Parameters.ifUnmodifiedSince22 ], requestBody: { parameterPath: "jobSchedulePatchParameter", @@ -497,21 +501,22 @@ const updateOperationSpec: msRest.OperationSpec = { httpMethod: "PUT", path: "jobschedules/{jobScheduleId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout50 + Parameters.timeout49 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId61, - Parameters.returnClientRequestId61, - Parameters.ocpDate61, - Parameters.ifMatch20, - Parameters.ifNoneMatch20, - Parameters.ifModifiedSince24, - Parameters.ifUnmodifiedSince24 + Parameters.clientRequestId60, + Parameters.returnClientRequestId60, + Parameters.ocpDate60, + Parameters.ifMatch19, + Parameters.ifNoneMatch19, + Parameters.ifModifiedSince23, + Parameters.ifUnmodifiedSince23 ], requestBody: { parameterPath: "jobScheduleUpdateParameter", @@ -536,21 +541,22 @@ const disableOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobschedules/{jobScheduleId}/disable", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout51 + Parameters.timeout50 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId62, - Parameters.returnClientRequestId62, - Parameters.ocpDate62, - Parameters.ifMatch21, - Parameters.ifNoneMatch21, - Parameters.ifModifiedSince25, - Parameters.ifUnmodifiedSince25 + Parameters.clientRequestId61, + Parameters.returnClientRequestId61, + Parameters.ocpDate61, + Parameters.ifMatch20, + Parameters.ifNoneMatch20, + Parameters.ifModifiedSince24, + Parameters.ifUnmodifiedSince24 ], responses: { 204: { @@ -567,21 +573,22 @@ const enableOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobschedules/{jobScheduleId}/enable", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout52 + Parameters.timeout51 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId63, - Parameters.returnClientRequestId63, - Parameters.ocpDate63, - Parameters.ifMatch22, - Parameters.ifNoneMatch22, - Parameters.ifModifiedSince26, - Parameters.ifUnmodifiedSince26 + Parameters.clientRequestId62, + Parameters.returnClientRequestId62, + Parameters.ocpDate62, + Parameters.ifMatch21, + Parameters.ifNoneMatch21, + Parameters.ifModifiedSince25, + Parameters.ifUnmodifiedSince25 ], responses: { 204: { @@ -598,21 +605,22 @@ const terminateOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobschedules/{jobScheduleId}/terminate", urlParameters: [ + Parameters.batchUrl, Parameters.jobScheduleId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout53 + Parameters.timeout52 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId64, - Parameters.returnClientRequestId64, - Parameters.ocpDate64, - Parameters.ifMatch23, - Parameters.ifNoneMatch23, - Parameters.ifModifiedSince27, - Parameters.ifUnmodifiedSince27 + Parameters.clientRequestId63, + Parameters.returnClientRequestId63, + Parameters.ocpDate63, + Parameters.ifMatch22, + Parameters.ifNoneMatch22, + Parameters.ifModifiedSince26, + Parameters.ifUnmodifiedSince26 ], responses: { 202: { @@ -628,15 +636,18 @@ const terminateOperationSpec: msRest.OperationSpec = { const addOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobschedules", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout54 + Parameters.timeout53 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId65, - Parameters.returnClientRequestId65, - Parameters.ocpDate65 + Parameters.clientRequestId64, + Parameters.returnClientRequestId64, + Parameters.ocpDate64 ], requestBody: { parameterPath: "cloudJobSchedule", @@ -660,19 +671,22 @@ const addOperationSpec: msRest.OperationSpec = { const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobschedules", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter10, Parameters.select9, Parameters.expand6, Parameters.maxResults11, - Parameters.timeout55 + Parameters.timeout54 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId66, - Parameters.returnClientRequestId66, - Parameters.ocpDate66 + Parameters.clientRequestId65, + Parameters.returnClientRequestId65, + Parameters.ocpDate65 ], responses: { 200: { @@ -688,16 +702,16 @@ const listOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId67, - Parameters.returnClientRequestId67, - Parameters.ocpDate67 + Parameters.clientRequestId66, + Parameters.returnClientRequestId66, + Parameters.ocpDate66 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/pool.ts b/sdk/batch/batch/src/operations/pool.ts index 33b8dbfa9b14..4fb694a9153e 100644 --- a/sdk/batch/batch/src/operations/pool.ts +++ b/sdk/batch/batch/src/operations/pool.ts @@ -452,7 +452,7 @@ export class Pool { } /** - * This fully replaces all the updateable properties of the pool. For example, if the pool has a + * This fully replaces all the updatable properties of the pool. For example, if the pool has a * start task associated with it and if start task is not specified with this request, then the * Batch service will remove the existing start task. * @summary Updates the properties of the specified pool. @@ -486,54 +486,6 @@ export class Pool { callback) as Promise; } - /** - * During an upgrade, the Batch service upgrades each compute node in the pool. When a compute node - * is chosen for upgrade, any tasks running on that node are removed from the node and returned to - * the queue to be rerun later (or on a different compute node). The node will be unavailable until - * the upgrade is complete. This operation results in temporarily reduced pool capacity as nodes - * are taken out of service to be upgraded. Although the Batch service tries to avoid upgrading all - * compute nodes at the same time, it does not guarantee to do this (particularly on small pools); - * therefore, the pool may be temporarily unavailable to run tasks. When this operation runs, the - * pool state changes to upgrading. When all compute nodes have finished upgrading, the pool state - * returns to active. While the upgrade is in progress, the pool's currentOSVersion reflects the OS - * version that nodes are upgrading from, and targetOSVersion reflects the OS version that nodes - * are upgrading to. Once the upgrade is complete, currentOSVersion is updated to reflect the OS - * version now running on all nodes. This operation can only be invoked on pools created with the - * cloudServiceConfiguration property. - * @summary Upgrades the operating system of the specified pool. - * @param poolId The ID of the pool to upgrade. - * @param targetOSVersion The Azure Guest OS version to be installed on the virtual machines in the - * pool. - * @param [options] The optional parameters - * @returns Promise - */ - upgradeOS(poolId: string, targetOSVersion: string, options?: Models.PoolUpgradeOSOptionalParams): Promise; - /** - * @param poolId The ID of the pool to upgrade. - * @param targetOSVersion The Azure Guest OS version to be installed on the virtual machines in the - * pool. - * @param callback The callback - */ - upgradeOS(poolId: string, targetOSVersion: string, callback: msRest.ServiceCallback): void; - /** - * @param poolId The ID of the pool to upgrade. - * @param targetOSVersion The Azure Guest OS version to be installed on the virtual machines in the - * pool. - * @param options The optional parameters - * @param callback The callback - */ - upgradeOS(poolId: string, targetOSVersion: string, options: Models.PoolUpgradeOSOptionalParams, callback: msRest.ServiceCallback): void; - upgradeOS(poolId: string, targetOSVersion: string, options?: Models.PoolUpgradeOSOptionalParams | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { - return this.client.sendOperationRequest( - { - poolId, - targetOSVersion, - options - }, - upgradeOSOperationSpec, - callback) as Promise; - } - /** * This operation can only run when the allocation state of the pool is steady. When this operation * runs, the allocation state changes from steady to resizing. @@ -636,6 +588,9 @@ const serializer = new msRest.Serializer(Mappers); const listUsageMetricsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "poolusagemetrics", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.startTime, @@ -665,6 +620,9 @@ const listUsageMetricsOperationSpec: msRest.OperationSpec = { const getAllLifetimeStatisticsOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "lifetimepoolstats", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.timeout3 @@ -690,6 +648,9 @@ const getAllLifetimeStatisticsOperationSpec: msRest.OperationSpec = { const addOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.timeout4 @@ -722,6 +683,9 @@ const addOperationSpec: msRest.OperationSpec = { const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools", + urlParameters: [ + Parameters.batchUrl + ], queryParameters: [ Parameters.apiVersion, Parameters.filter1, @@ -752,6 +716,7 @@ const deleteMethodOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "pools/{poolId}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -783,6 +748,7 @@ const existsOperationSpec: msRest.OperationSpec = { httpMethod: "HEAD", path: "pools/{poolId}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -817,6 +783,7 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "pools/{poolId}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -851,6 +818,7 @@ const patchOperationSpec: msRest.OperationSpec = { httpMethod: "PATCH", path: "pools/{poolId}", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -890,6 +858,7 @@ const disableAutoScaleOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/disableautoscale", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -917,6 +886,7 @@ const enableAutoScaleOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/enableautoscale", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -956,6 +926,7 @@ const evaluateAutoScaleOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/evaluateautoscale", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -994,6 +965,7 @@ const resizeOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/resize", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -1033,6 +1005,7 @@ const stopResizeOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/stopresize", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -1064,6 +1037,7 @@ const updatePropertiesOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "pools/{poolId}/updateproperties", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -1095,10 +1069,11 @@ const updatePropertiesOperationSpec: msRest.OperationSpec = { serializer }; -const upgradeOSOperationSpec: msRest.OperationSpec = { +const removeNodesOperationSpec: msRest.OperationSpec = { httpMethod: "POST", - path: "pools/{poolId}/upgradeos", + path: "pools/{poolId}/removenodes", urlParameters: [ + Parameters.batchUrl, Parameters.poolId ], queryParameters: [ @@ -1115,47 +1090,6 @@ const upgradeOSOperationSpec: msRest.OperationSpec = { Parameters.ifModifiedSince7, Parameters.ifUnmodifiedSince7 ], - requestBody: { - parameterPath: { - targetOSVersion: "targetOSVersion" - }, - mapper: { - ...Mappers.PoolUpgradeOSParameter, - required: true - } - }, - contentType: "application/json; odata=minimalmetadata; charset=utf-8", - responses: { - 202: { - headersMapper: Mappers.PoolUpgradeOSHeaders - }, - default: { - bodyMapper: Mappers.BatchError - } - }, - serializer -}; - -const removeNodesOperationSpec: msRest.OperationSpec = { - httpMethod: "POST", - path: "pools/{poolId}/removenodes", - urlParameters: [ - Parameters.poolId - ], - queryParameters: [ - Parameters.apiVersion, - Parameters.timeout17 - ], - headerParameters: [ - Parameters.acceptLanguage, - Parameters.clientRequestId18, - Parameters.returnClientRequestId18, - Parameters.ocpDate18, - Parameters.ifMatch8, - Parameters.ifNoneMatch8, - Parameters.ifModifiedSince8, - Parameters.ifUnmodifiedSince8 - ], requestBody: { parameterPath: "nodeRemoveParameter", mapper: { @@ -1177,16 +1111,16 @@ const removeNodesOperationSpec: msRest.OperationSpec = { const listUsageMetricsNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId19, - Parameters.returnClientRequestId19, - Parameters.ocpDate19 + Parameters.clientRequestId18, + Parameters.returnClientRequestId18, + Parameters.ocpDate18 ], responses: { 200: { @@ -1202,16 +1136,16 @@ const listUsageMetricsNextOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId20, - Parameters.returnClientRequestId20, - Parameters.ocpDate20 + Parameters.clientRequestId19, + Parameters.returnClientRequestId19, + Parameters.ocpDate19 ], responses: { 200: { diff --git a/sdk/batch/batch/src/operations/task.ts b/sdk/batch/batch/src/operations/task.ts index f22538368d7e..809212a479e2 100644 --- a/sdk/batch/batch/src/operations/task.ts +++ b/sdk/batch/batch/src/operations/task.ts @@ -27,8 +27,8 @@ export class Task { } /** - * The maximum lifetime of a task from addition to completion is 7 days. If a task has not - * completed within 7 days of being added it will be terminated by the Batch service and left in + * The maximum lifetime of a task from addition to completion is 180 days. If a task has not + * completed within 180 days of being added it will be terminated by the Batch service and left in * whatever state it was in at that time. * @summary Adds a task to the specified job. * @param jobId The ID of the job to which the task is to be added. @@ -101,9 +101,9 @@ export class Task { * extra tasks unexpectedly. If the response contains any tasks which failed to add, a client can * retry the request. In a retry, it is most efficient to resubmit only tasks that failed to add, * and to omit tasks that were successfully added on the first attempt. The maximum lifetime of a - * task from addition to completion is 7 days. If a task has not completed within 7 days of being - * added it will be terminated by the Batch service and left in whatever state it was in at that - * time. + * task from addition to completion is 180 days. If a task has not completed within 180 days of + * being added it will be terminated by the Batch service and left in whatever state it was in at + * that time. * @summary Adds a collection of tasks to the specified job. * @param jobId The ID of the job to which the task collection is to be added. * @param value The collection of tasks to add. The maximum count of tasks is 100. The total @@ -390,17 +390,18 @@ const addOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/tasks", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout56 + Parameters.timeout55 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId68, - Parameters.returnClientRequestId68, - Parameters.ocpDate68 + Parameters.clientRequestId67, + Parameters.returnClientRequestId67, + Parameters.ocpDate67 ], requestBody: { parameterPath: "task", @@ -425,6 +426,7 @@ const listOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/tasks", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ @@ -433,13 +435,13 @@ const listOperationSpec: msRest.OperationSpec = { Parameters.select10, Parameters.expand7, Parameters.maxResults12, - Parameters.timeout57 + Parameters.timeout56 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId69, - Parameters.returnClientRequestId69, - Parameters.ocpDate69 + Parameters.clientRequestId68, + Parameters.returnClientRequestId68, + Parameters.ocpDate68 ], responses: { 200: { @@ -457,17 +459,18 @@ const addCollectionOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/addtaskcollection", urlParameters: [ + Parameters.batchUrl, Parameters.jobId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout58 + Parameters.timeout57 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId70, - Parameters.returnClientRequestId70, - Parameters.ocpDate70 + Parameters.clientRequestId69, + Parameters.returnClientRequestId69, + Parameters.ocpDate69 ], requestBody: { parameterPath: { @@ -495,22 +498,23 @@ const deleteMethodOperationSpec: msRest.OperationSpec = { httpMethod: "DELETE", path: "jobs/{jobId}/tasks/{taskId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout59 + Parameters.timeout58 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId71, - Parameters.returnClientRequestId71, - Parameters.ocpDate71, - Parameters.ifMatch24, - Parameters.ifNoneMatch24, - Parameters.ifModifiedSince28, - Parameters.ifUnmodifiedSince28 + Parameters.clientRequestId70, + Parameters.returnClientRequestId70, + Parameters.ocpDate70, + Parameters.ifMatch23, + Parameters.ifNoneMatch23, + Parameters.ifModifiedSince27, + Parameters.ifUnmodifiedSince27 ], responses: { 200: { @@ -527,6 +531,7 @@ const getOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/tasks/{taskId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], @@ -534,17 +539,17 @@ const getOperationSpec: msRest.OperationSpec = { Parameters.apiVersion, Parameters.select11, Parameters.expand8, - Parameters.timeout60 + Parameters.timeout59 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId72, - Parameters.returnClientRequestId72, - Parameters.ocpDate72, - Parameters.ifMatch25, - Parameters.ifNoneMatch25, - Parameters.ifModifiedSince29, - Parameters.ifUnmodifiedSince29 + Parameters.clientRequestId71, + Parameters.returnClientRequestId71, + Parameters.ocpDate71, + Parameters.ifMatch24, + Parameters.ifNoneMatch24, + Parameters.ifModifiedSince28, + Parameters.ifUnmodifiedSince28 ], responses: { 200: { @@ -562,22 +567,23 @@ const updateOperationSpec: msRest.OperationSpec = { httpMethod: "PUT", path: "jobs/{jobId}/tasks/{taskId}", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout61 + Parameters.timeout60 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId73, - Parameters.returnClientRequestId73, - Parameters.ocpDate73, - Parameters.ifMatch26, - Parameters.ifNoneMatch26, - Parameters.ifModifiedSince30, - Parameters.ifUnmodifiedSince30 + Parameters.clientRequestId72, + Parameters.returnClientRequestId72, + Parameters.ocpDate72, + Parameters.ifMatch25, + Parameters.ifNoneMatch25, + Parameters.ifModifiedSince29, + Parameters.ifUnmodifiedSince29 ], requestBody: { parameterPath: { @@ -607,19 +613,20 @@ const listSubtasksOperationSpec: msRest.OperationSpec = { httpMethod: "GET", path: "jobs/{jobId}/tasks/{taskId}/subtasksinfo", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], queryParameters: [ Parameters.apiVersion, Parameters.select12, - Parameters.timeout62 + Parameters.timeout61 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId74, - Parameters.returnClientRequestId74, - Parameters.ocpDate74 + Parameters.clientRequestId73, + Parameters.returnClientRequestId73, + Parameters.ocpDate73 ], responses: { 200: { @@ -637,22 +644,23 @@ const terminateOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/tasks/{taskId}/terminate", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout63 + Parameters.timeout62 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId75, - Parameters.returnClientRequestId75, - Parameters.ocpDate75, - Parameters.ifMatch27, - Parameters.ifNoneMatch27, - Parameters.ifModifiedSince31, - Parameters.ifUnmodifiedSince31 + Parameters.clientRequestId74, + Parameters.returnClientRequestId74, + Parameters.ocpDate74, + Parameters.ifMatch26, + Parameters.ifNoneMatch26, + Parameters.ifModifiedSince30, + Parameters.ifUnmodifiedSince30 ], responses: { 204: { @@ -669,22 +677,23 @@ const reactivateOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "jobs/{jobId}/tasks/{taskId}/reactivate", urlParameters: [ + Parameters.batchUrl, Parameters.jobId, Parameters.taskId ], queryParameters: [ Parameters.apiVersion, - Parameters.timeout64 + Parameters.timeout63 ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId76, - Parameters.returnClientRequestId76, - Parameters.ocpDate76, - Parameters.ifMatch28, - Parameters.ifNoneMatch28, - Parameters.ifModifiedSince32, - Parameters.ifUnmodifiedSince32 + Parameters.clientRequestId75, + Parameters.returnClientRequestId75, + Parameters.ocpDate75, + Parameters.ifMatch27, + Parameters.ifNoneMatch27, + Parameters.ifModifiedSince31, + Parameters.ifUnmodifiedSince31 ], responses: { 204: { @@ -699,16 +708,16 @@ const reactivateOperationSpec: msRest.OperationSpec = { const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", - baseUrl: "https://batch.core.windows.net", + baseUrl: "{batchUrl}", path: "{nextLink}", urlParameters: [ Parameters.nextPageLink ], headerParameters: [ Parameters.acceptLanguage, - Parameters.clientRequestId77, - Parameters.returnClientRequestId77, - Parameters.ocpDate77 + Parameters.clientRequestId76, + Parameters.returnClientRequestId76, + Parameters.ocpDate76 ], responses: { 200: {