Merge remote-tracking branch 'origin/master' into restapi_auto_hdinsight/resource-manager

# Conflicts:
#	lib/services/hdInsightManagement/README.md
#	lib/services/hdInsightManagement/lib/models/storageAccount.js
This commit is contained in:
Kamil Pajdzik 2019-01-29 10:46:36 -08:00
Родитель efbca80ffc 51b83fc644
Коммит a4d55c0449
2418 изменённых файлов: 159935 добавлений и 83738 удалений

162
.azure-pipelines/client.yml Normal file
Просмотреть файл

@ -0,0 +1,162 @@
trigger:
- master
variables:
node.version: '10.x'
jobs:
- job: 'Publish'
pool:
vmImage: 'ubuntu-16.04'
steps:
- task: NodeTool@0
inputs:
versionSpec: '$(node.version)'
displayName: 'Install Node.js $(node.version)'
# Reduce build time by only installing the "npm-run-all" package, which is the minimum required to run the
# composite script commands.
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'install npm-run-all'
displayName: 'npm install npm-run-all'
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'run install-client'
displayName: 'npm run install-client'
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'run pack-client'
displayName: 'npm run pack-client'
- task: CopyFiles@2
inputs:
contents: 'lib/**/*.tgz'
targetFolder: $(Build.ArtifactStagingDirectory)
flattenFolders: true
displayName: 'Copy Package'
- task: PublishBuildArtifacts@1
displayName: 'Publish Package'
- job: 'Audit'
pool:
vmImage: 'ubuntu-16.04'
steps:
- task: NodeTool@0
inputs:
versionSpec: '$(node.version)'
displayName: 'Install Node.js $(node.version)'
# Rather than running "npm install" in the repo root, reduce build time by only installing the "npm-run-all" package,
# which is the minimum required to run the composite script commands.
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'install npm-run-all'
displayName: 'npm install npm-run-all'
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'run audit-client'
displayName: 'npm run audit-client'
- task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0
# ComponentGovernance is currently unable to run on pull requests of public projects. Running on non-PR
# builds should be sufficient.
condition: and(succeededOrFailed(), ne(variables['Build.Reason'], 'PullRequest'))
displayName: 'Component Detection'
- job: 'Test'
dependsOn:
- 'Publish'
strategy:
matrix:
Linux_Node6:
os.name: 'Linux'
os.vmImage: 'ubuntu-16.04'
node.version: '6.x'
Linux_Node8:
os.name: 'Linux'
os.vmImage: 'ubuntu-16.04'
node.version: '8.x'
Linux_Node10:
os.name: 'Linux'
os.vmImage: 'ubuntu-16.04'
node.version: '10.x'
Linux_Node11:
os.name: 'Linux'
os.vmImage: 'ubuntu-16.04'
node.version: '11.x'
macOS_Node6:
os.name: 'macOS'
os.vmImage: 'macOS-10.13'
node.version: '6.x'
macOS_Node8:
os.name: 'macOS'
os.vmImage: 'macOS-10.13'
node.version: '8.x'
macOS_Node10:
os.name: 'macOS'
os.vmImage: 'macOS-10.13'
node.version: '10.x'
macOS_Node11:
os.name: 'macOS'
os.vmImage: 'macOS-10.13'
node.version: '11.x'
Windows_Node6:
os.name: 'Windows'
os.vmImage: 'vs2017-win2016'
node.version: '6.x'
Windows_Node8:
os.name: 'Windows'
os.vmImage: 'vs2017-win2016'
node.version: '8.x'
Windows_Node10:
os.name: 'Windows'
os.vmImage: 'vs2017-win2016'
node.version: '10.x'
Windows_Node11:
os.name: 'Windows'
os.vmImage: 'vs2017-win2016'
node.version: '11.x'
pool:
vmImage: '$(os.vmImage)'
steps:
- task: NodeTool@0
inputs:
versionSpec: '$(node.version)'
displayName: 'Install Node.js $(node.version)'
# Tests depend on running "npm install" in repo root
- task: Npm@1
inputs:
command: 'install'
displayName: 'npm install'
- task: Npm@1
inputs:
command: 'custom'
customCommand: 'run test-client -- -- --reporter mocha-junit-reporter'
displayName: 'npm run test-client'
- task: PublishTestResults@2
inputs:
testResultsFiles: '**/test-results.xml'
testRunTitle: '{os.name} Node $(node.version)'
condition: succeededOrFailed()
displayName: 'Publish test results'

8
.gitignore поставляемый
Просмотреть файл

@ -55,4 +55,10 @@ packages
# Coverage report
coverage
.nyc_output
.nyc_output
# Output of 'npm pack'
*.tgz
# Test Results
test-results.xml

Просмотреть файл

@ -1,6 +1,9 @@
# Azure SDK for Node.js
[![NPM version](https://badge.fury.io/js/azure.png)](https://badge.fury.io/js/azure) [![Build Status](https://travis-ci.org/Azure/azure-sdk-for-node.png?branch=master)](https://travis-ci.org/Azure/azure-sdk-for-node)
| Component | Build Status |
| --------- | ------ |
| Management Libraries | [![Build Status](https://travis-ci.org/Azure/azure-sdk-for-node.png?branch=master)](https://travis-ci.org/Azure/azure-sdk-for-node) |
| Client Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-node.client)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=33) |
This project provides Node.js packages that makes it easy to consume and manage Microsoft Azure Services.

Просмотреть файл

@ -21,7 +21,7 @@ export default class BatchServiceClient extends AzureServiceClient {
* @class
* @param {credentials} credentials - Credentials needed for the client to connect to Azure.
*
* @param {string} [baseUri] - The base URI of the service.
* @param {string} batchUrl - The base URL for all Azure Batch service requests.
*
* @param {object} [options] - The parameter options
*
@ -39,12 +39,14 @@ export default class BatchServiceClient extends AzureServiceClient {
* @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
*
*/
constructor(credentials: ServiceClientCredentials, baseUri?: string, options?: AzureServiceClientOptions);
constructor(credentials: ServiceClientCredentials, batchUrl: string, options?: AzureServiceClientOptions);
credentials: ServiceClientCredentials;
apiVersion: string;
batchUrl: string;
acceptLanguage: string;
longRunningOperationRetryTimeout: number;

Просмотреть файл

@ -27,7 +27,7 @@ class BatchServiceClient extends ServiceClient {
/**
* Create a BatchServiceClient.
* @param {credentials} credentials - Credentials needed for the client to connect to Azure.
* @param {string} [baseUri] - The base URI of the service.
* @param {string} batchUrl - The base URL for all Azure Batch service requests.
* @param {object} [options] - The parameter options
* @param {Array} [options.filters] - Filters to be added to the request pipeline
* @param {object} [options.requestOptions] - Options for the underlying request object
@ -37,24 +37,25 @@ class BatchServiceClient extends ServiceClient {
* @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30.
* @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
*/
constructor(credentials, baseUri, options) {
constructor(credentials, batchUrl, options) {
if (credentials === null || credentials === undefined) {
throw new Error('\'credentials\' cannot be null.');
}
if (batchUrl === null || batchUrl === undefined) {
throw new Error('\'batchUrl\' cannot be null.');
}
if (!options) options = {};
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.generateClientRequestId = true;
this.baseUri = baseUri;
if (!this.baseUri) {
this.baseUri = 'https://batch.core.windows.net';
}
this.baseUri = '{batchUrl}';
this.credentials = credentials;
this.batchUrl = batchUrl;
let packageInfo = this.getPackageJsonInfo(__dirname);
this.addUserAgentInfo(`${packageInfo.name}/${packageInfo.version}`);

Просмотреть файл

@ -17,14 +17,14 @@
class AccountListNodeAgentSkusNextOptions {
/**
* Create a AccountListNodeAgentSkusNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,23 +17,23 @@
class AccountListNodeAgentSkusOptions {
/**
* Create a AccountListNodeAgentSkusOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {number} [maxResults] The maximum number of items to return in the
* response. A maximum of 1000 results will be returned. Default value: 1000
* .
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 results will be returned. Default value:
* 1000 .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -16,7 +16,7 @@
class AccountListNodeAgentSkusResult extends Array {
/**
* Create a AccountListNodeAgentSkusResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -17,14 +17,14 @@
class AccountListPoolNodeCountsNextOptions {
/**
* Create a AccountListPoolNodeCountsNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,22 +17,22 @@
class AccountListPoolNodeCountsOptions {
/**
* Create a AccountListPoolNodeCountsOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {number} [maxResults] The maximum number of items to return in the
* response. Default value: 10 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [maxResults] The maximum number of items to return in
* the response. Default value: 10 .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -18,8 +18,8 @@
class AffinityInformation {
/**
* Create a 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
* @property {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

Просмотреть файл

@ -17,17 +17,17 @@
class ApplicationGetOptions {
/**
* Create a ApplicationGetOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,14 +17,14 @@
class ApplicationListNextOptions {
/**
* Create a ApplicationListNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,20 +17,20 @@
class ApplicationListOptions {
/**
* Create a 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 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 applications can be returned. Default
* value: 1000 .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -16,7 +16,7 @@
class ApplicationListResult extends Array {
/**
* Create a ApplicationListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -18,8 +18,8 @@
class ApplicationPackageReference {
/**
* Create a ApplicationPackageReference.
* @member {string} applicationId The ID of the application to deploy.
* @member {string} [version] The version of the application to deploy. If
* @property {string} applicationId The ID of the application to deploy.
* @property {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

Просмотреть файл

@ -18,10 +18,10 @@
class ApplicationSummary {
/**
* Create a ApplicationSummary.
* @member {string} id A string that uniquely identifies the application
* @property {string} id A string that uniquely identifies the application
* within the account.
* @member {string} displayName The display name for the application.
* @member {array} versions The list of available versions of the
* @property {string} displayName The display name for the application.
* @property {array} versions The list of available versions of the
* application.
*/
constructor() {

Просмотреть файл

@ -18,7 +18,7 @@
class AuthenticationTokenSettings {
/**
* Create a AuthenticationTokenSettings.
* @member {array} [access] The Batch resources to which the token grants
* @property {array} [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

Просмотреть файл

@ -18,29 +18,29 @@
class AutoPoolSpecification {
/**
* Create a AutoPoolSpecification.
* @member {string} [autoPoolIdPrefix] A prefix to be added to the unique
* @property {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.
* @member {string} poolLifetimeOption The minimum lifetime of created auto
* @property {string} poolLifetimeOption The minimum lifetime of created auto
* pools, and how multiple jobs on a schedule are assigned to pools. Possible
* values include: 'jobSchedule', 'job'
* @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.
* @member {object} [pool] The pool specification for the auto pool.
* @member {string} [pool.displayName] The display name need not be unique
* @property {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.
* @property {object} [pool] The pool specification for the auto pool.
* @property {string} [pool.displayName] The display name need not be unique
* and can contain any Unicode characters up to a maximum length of 1024.
* @member {string} [pool.vmSize] For information about available sizes of
* @property {string} [pool.vmSize] 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).
* @member {object} [pool.cloudServiceConfiguration] This property must be
* @property {object} [pool.cloudServiceConfiguration] 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
@ -48,54 +48,42 @@ class AutoPoolSpecification {
* 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'.
* @member {string} [pool.cloudServiceConfiguration.osFamily] Possible values
* are:
* @property {string} [pool.cloudServiceConfiguration.osFamily] 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
* (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
* @member {string} [pool.cloudServiceConfiguration.targetOSVersion] The
* default value is * which specifies the latest operating system version for
* the specified OS family.
* @member {string} [pool.cloudServiceConfiguration.currentOSVersion] 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.
* @member {object} [pool.virtualMachineConfiguration] This property must be
* specified if the pool needs to be created with Azure IaaS VMs. This
* @property {string} [pool.cloudServiceConfiguration.osVersion] The default
* value is * which specifies the latest operating system version for the
* specified OS family.
* @property {object} [pool.virtualMachineConfiguration] 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).
* @member {object} [pool.virtualMachineConfiguration.imageReference]
* @member {string}
* @property {object} [pool.virtualMachineConfiguration.imageReference]
* @property {string}
* [pool.virtualMachineConfiguration.imageReference.publisher] For example,
* Canonical or MicrosoftWindowsServer.
* @member {string} [pool.virtualMachineConfiguration.imageReference.offer]
* @property {string} [pool.virtualMachineConfiguration.imageReference.offer]
* For example, UbuntuServer or WindowsServer.
* @member {string} [pool.virtualMachineConfiguration.imageReference.sku] For
* example, 14.04.0-LTS or 2012-R2-Datacenter.
* @member {string} [pool.virtualMachineConfiguration.imageReference.version]
* A value of 'latest' can be specified to select the latest version of an
* image. If omitted, the default is 'latest'.
* @member {string}
* @property {string} [pool.virtualMachineConfiguration.imageReference.sku]
* For example, 14.04.0-LTS or 2012-R2-Datacenter.
* @property {string}
* [pool.virtualMachineConfiguration.imageReference.version] A value of
* 'latest' can be specified to select the latest version of an image. If
* omitted, the default is 'latest'.
* @property {string}
* [pool.virtualMachineConfiguration.imageReference.virtualMachineImageId]
* 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.
* @member {object} [pool.virtualMachineConfiguration.osDisk]
* @member {string} [pool.virtualMachineConfiguration.osDisk.caching] 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'
* @member {string} [pool.virtualMachineConfiguration.nodeAgentSKUId] The
* the Azure Batch account. For more details, see
* https://docs.microsoft.com/azure/batch/batch-custom-images.
* @property {string} [pool.virtualMachineConfiguration.nodeAgentSKUId] 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
@ -103,119 +91,111 @@ class AutoPoolSpecification {
* 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.
* @member {object} [pool.virtualMachineConfiguration.windowsConfiguration]
* This property must not be specified if the imageReference or osDisk
* property specifies a Linux OS image.
* @member {boolean}
* @property {object} [pool.virtualMachineConfiguration.windowsConfiguration]
* This property must not be specified if the imageReference property
* specifies a Linux OS image.
* @property {boolean}
* [pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates]
* If omitted, the default value is true.
* @member {array} [pool.virtualMachineConfiguration.dataDisks] 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
* @property {array} [pool.virtualMachineConfiguration.dataDisks] 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.
* @member {string} [pool.virtualMachineConfiguration.licenseType] 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
* @property {string} [pool.virtualMachineConfiguration.licenseType] 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.
* @member {object} [pool.virtualMachineConfiguration.containerConfiguration]
* 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.
* @member {array}
* @property {object}
* [pool.virtualMachineConfiguration.containerConfiguration] 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.
* @property {array}
* [pool.virtualMachineConfiguration.containerConfiguration.containerImageNames]
* 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.
* @member {array}
* @property {array}
* [pool.virtualMachineConfiguration.containerConfiguration.containerRegistries]
* If any images must be downloaded from a private registry which requires
* credentials, then those credentials must be provided here.
* @member {number} [pool.maxTasksPerNode] The default value is 1. The
* @property {number} [pool.maxTasksPerNode] 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).
* @member {object} [pool.taskSchedulingPolicy]
* @member {string} [pool.taskSchedulingPolicy.nodeFillType] Possible values
* include: 'spread', 'pack'
* @member {moment.duration} [pool.resizeTimeout] This timeout applies only
* @property {object} [pool.taskSchedulingPolicy]
* @property {string} [pool.taskSchedulingPolicy.nodeFillType] Possible
* values include: 'spread', 'pack'
* @property {moment.duration} [pool.resizeTimeout] 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).
* @member {number} [pool.targetDedicatedNodes] This property must not be
* @property {number} [pool.targetDedicatedNodes] 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.
* @member {number} [pool.targetLowPriorityNodes] This property must not be
* @property {number} [pool.targetLowPriorityNodes] 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.
* @member {boolean} [pool.enableAutoScale] If false, at least one of
* @property {boolean} [pool.enableAutoScale] 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.
* @member {string} [pool.autoScaleFormula] This property must not be
* @property {string} [pool.autoScaleFormula] 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.
* @member {moment.duration} [pool.autoScaleEvaluationInterval] The default
* @property {moment.duration} [pool.autoScaleEvaluationInterval] 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).
* @member {boolean} [pool.enableInterNodeCommunication] 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.
* @member {object} [pool.networkConfiguration]
* @member {string} [pool.networkConfiguration.subnetId] 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
* @property {boolean} [pool.enableInterNodeCommunication] 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.
* @property {object} [pool.networkConfiguration]
* @property {string} [pool.networkConfiguration.subnetId] 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. 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:
* supported. For more details, see:
* https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
* @member {object} [pool.networkConfiguration.endpointConfiguration] Pool
* @property {string} [pool.networkConfiguration.dynamicVNetAssignmentScope]
* Possible values include: 'none', 'job'
* @property {object} [pool.networkConfiguration.endpointConfiguration] Pool
* endpoint configuration is only supported on pools with the
* virtualMachineConfiguration property.
* @member {array}
* @property {array}
* [pool.networkConfiguration.endpointConfiguration.inboundNATPools] 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.
* @member {object} [pool.startTask]
* @member {string} [pool.startTask.commandLine] The command line does not
* @property {object} [pool.startTask]
* @property {string} [pool.startTask.commandLine] 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
@ -224,41 +204,42 @@ class AutoPoolSpecification {
* 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).
* @member {object} [pool.startTask.containerSettings] When this is
* @property {object} [pool.startTask.containerSettings] 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.
* @member {string} [pool.startTask.containerSettings.containerRunOptions]
* @property {string} [pool.startTask.containerSettings.containerRunOptions]
* These additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [pool.startTask.containerSettings.imageName] 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
* @property {string} [pool.startTask.containerSettings.imageName] 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.
* @member {object} [pool.startTask.containerSettings.registry] This setting
* can be omitted if was already provided at pool creation.
* @member {string}
* @property {object} [pool.startTask.containerSettings.registry] This
* setting can be omitted if was already provided at pool creation.
* @property {string}
* [pool.startTask.containerSettings.registry.registryServer] If omitted, the
* default is "docker.io".
* @member {string} [pool.startTask.containerSettings.registry.userName]
* @member {string} [pool.startTask.containerSettings.registry.password]
* @member {array} [pool.startTask.resourceFiles] Files listed under this
* @property {string} [pool.startTask.containerSettings.registry.userName]
* @property {string} [pool.startTask.containerSettings.registry.password]
* @property {array} [pool.startTask.resourceFiles] Files listed under this
* element are located in the task's working directory.
* @member {array} [pool.startTask.environmentSettings]
* @member {object} [pool.startTask.userIdentity] If omitted, the task runs
* @property {array} [pool.startTask.environmentSettings]
* @property {object} [pool.startTask.userIdentity] If omitted, the task runs
* as a non-administrative user unique to the task.
* @member {string} [pool.startTask.userIdentity.userName] The userName and
* @property {string} [pool.startTask.userIdentity.userName] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {object} [pool.startTask.userIdentity.autoUser] The userName and
* @property {object} [pool.startTask.userIdentity.autoUser] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {string} [pool.startTask.userIdentity.autoUser.scope] The default
* value is task. Possible values include: 'task', 'pool'
* @member {string} [pool.startTask.userIdentity.autoUser.elevationLevel] The
* default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {number} [pool.startTask.maxTaskRetryCount] The Batch service
* @property {string} [pool.startTask.userIdentity.autoUser.scope] The
* default value is task. Possible values include: 'task', 'pool'
* @property {string} [pool.startTask.userIdentity.autoUser.elevationLevel]
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
* @property {number} [pool.startTask.maxTaskRetryCount] 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
@ -266,7 +247,7 @@ class AutoPoolSpecification {
* 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.
* @member {boolean} [pool.startTask.waitForSuccess] If true and the start
* @property {boolean} [pool.startTask.waitForSuccess] 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
@ -276,7 +257,7 @@ class AutoPoolSpecification {
* 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.
* @member {array} [pool.certificateReferences] For Windows compute nodes,
* @property {array} [pool.certificateReferences] 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
@ -284,15 +265,15 @@ class AutoPoolSpecification {
* 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.
* @member {array} [pool.applicationPackageReferences]
* @member {array} [pool.applicationLicenses] The list of application
* @property {array} [pool.applicationPackageReferences]
* @property {array} [pool.applicationLicenses] 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.
* @member {array} [pool.userAccounts]
* @member {array} [pool.metadata] The Batch service does not assign any
* @property {array} [pool.userAccounts]
* @property {array} [pool.metadata] The Batch service does not assign any
* meaning to metadata; it is solely for the use of user code.
*/
constructor() {

Просмотреть файл

@ -18,16 +18,16 @@
class AutoScaleRun {
/**
* Create a AutoScaleRun.
* @member {date} timestamp The time at which the autoscale formula was last
* evaluated.
* @member {string} [results] The final values of all variables used in the
* @property {date} timestamp The time at which the autoscale formula was
* last evaluated.
* @property {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.
* @member {object} [error] Details of the error encountered evaluating the
* @property {object} [error] Details of the error encountered evaluating the
* autoscale formula on the pool, if the evaluation was unsuccessful.
* @member {string} [error.code]
* @member {string} [error.message]
* @member {array} [error.values]
* @property {string} [error.code]
* @property {string} [error.message]
* @property {array} [error.values]
*/
constructor() {
}

Просмотреть файл

@ -18,12 +18,12 @@
class AutoScaleRunError {
/**
* Create a AutoScaleRunError.
* @member {string} [code] An identifier for the autoscale error. Codes are
* @property {string} [code] An identifier for the autoscale error. Codes are
* invariant and are intended to be consumed programmatically.
* @member {string} [message] A message describing the autoscale error,
* @property {string} [message] A message describing the autoscale error,
* intended to be suitable for display in a user interface.
* @member {array} [values] A list of additional error details related to the
* autoscale error.
* @property {array} [values] A list of additional error details related to
* the autoscale error.
*/
constructor() {
}

Просмотреть файл

@ -18,9 +18,9 @@
class AutoUserSpecification {
/**
* Create a AutoUserSpecification.
* @member {string} [scope] The scope for the auto user. The default value is
* task. Possible values include: 'task', 'pool'
* @member {string} [elevationLevel] The elevation level of the auto user.
* @property {string} [scope] The scope for the auto user. The default value
* is task. Possible values include: 'task', 'pool'
* @property {string} [elevationLevel] The elevation level of the auto user.
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
*/

Просмотреть файл

@ -17,13 +17,13 @@
class BatchError {
/**
* Create a BatchError.
* @member {string} [code] An identifier for the error. Codes are invariant
* @property {string} [code] An identifier for the error. Codes are invariant
* and are intended to be consumed programmatically.
* @member {object} [message] A message describing the error, intended to be
* suitable for display in a user interface.
* @member {string} [message.lang]
* @member {string} [message.value]
* @member {array} [values] A collection of key-value pairs containing
* @property {object} [message] A message describing the error, intended to
* be suitable for display in a user interface.
* @property {string} [message.lang]
* @property {string} [message.value]
* @property {array} [values] A collection of key-value pairs containing
* additional details about the error.
*/
constructor() {

Просмотреть файл

@ -18,9 +18,9 @@
class BatchErrorDetail {
/**
* Create a BatchErrorDetail.
* @member {string} [key] An identifier specifying the meaning of the Value
* @property {string} [key] An identifier specifying the meaning of the Value
* property.
* @member {string} [value] The additional information included with the
* @property {string} [value] The additional information included with the
* error response.
*/
constructor() {

Просмотреть файл

@ -18,32 +18,32 @@
class Certificate {
/**
* Create a Certificate.
* @member {string} [thumbprint] The X.509 thumbprint of the certificate.
* @property {string} [thumbprint] The X.509 thumbprint of the certificate.
* This is a sequence of up to 40 hex digits.
* @member {string} [thumbprintAlgorithm] The algorithm used to derive the
* @property {string} [thumbprintAlgorithm] The algorithm used to derive the
* thumbprint.
* @member {string} [url] The URL of the certificate.
* @member {string} [state] The current state of the certificate. Possible
* @property {string} [url] The URL of the certificate.
* @property {string} [state] The current state of the certificate. Possible
* values include: 'active', 'deleting', 'deleteFailed'
* @member {date} [stateTransitionTime] The time at which the certificate
* @property {date} [stateTransitionTime] The time at which the certificate
* entered its current state.
* @member {string} [previousState] The previous state of the certificate.
* @property {string} [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'
* @member {date} [previousStateTransitionTime] The time at which the
* @property {date} [previousStateTransitionTime] The time at which the
* certificate entered its previous state. This property is not set if the
* certificate is in its initial Active state.
* @member {string} [publicData] The public part of the certificate as a
* @property {string} [publicData] The public part of the certificate as a
* base-64 encoded .cer file.
* @member {object} [deleteCertificateError] The error that occurred on the
* @property {object} [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.
* @member {string} [deleteCertificateError.code]
* @member {string} [deleteCertificateError.message]
* @member {array} [deleteCertificateError.values] 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.
* @property {string} [deleteCertificateError.code]
* @property {string} [deleteCertificateError.message]
* @property {array} [deleteCertificateError.values] 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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class CertificateAddOptions {
/**
* Create a CertificateAddOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -18,16 +18,16 @@
class CertificateAddParameter {
/**
* Create a 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).
* @member {string} thumbprintAlgorithm The algorithm used to derive the
* @property {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).
* @property {string} thumbprintAlgorithm The algorithm used to derive the
* thumbprint. This must be sha1.
* @member {string} data The base64-encoded contents of the certificate. The
* maximum size is 10KB.
* @member {string} [certificateFormat] The format of the certificate data.
* @property {string} data The base64-encoded contents of the certificate.
* The maximum size is 10KB.
* @property {string} [certificateFormat] The format of the certificate data.
* Possible values include: 'pfx', 'cer'
* @member {string} [password] The password to access the certificate's
* @property {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.
*/

Просмотреть файл

@ -17,17 +17,17 @@
class CertificateCancelDeletionOptions {
/**
* Create a CertificateCancelDeletionOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class CertificateDeleteMethodOptions {
/**
* Create a CertificateDeleteMethodOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,18 +17,18 @@
class CertificateGetOptions {
/**
* Create a CertificateGetOptions.
* @member {string} [select] An OData $select clause.
* @member {number} [timeout] The maximum time that the server can spend
* @property {string} [select] An OData $select clause.
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,14 +17,14 @@
class CertificateListNextOptions {
/**
* Create a CertificateListNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,24 +17,24 @@
class CertificateListOptions {
/**
* Create a CertificateListOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {string} [select] An OData $select clause.
* @member {number} [maxResults] The maximum number of items to return in the
* response. A maximum of 1000 certificates can be returned. Default value:
* 1000 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {string} [select] An OData $select clause.
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 certificates can be returned. Default
* value: 1000 .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -16,7 +16,7 @@
class CertificateListResult extends Array {
/**
* Create a CertificateListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -18,28 +18,29 @@
class CertificateReference {
/**
* Create a CertificateReference.
* @member {string} thumbprint The thumbprint of the certificate.
* @member {string} thumbprintAlgorithm The algorithm with which the
* @property {string} thumbprint The thumbprint of the certificate.
* @property {string} thumbprintAlgorithm The algorithm with which the
* thumbprint is associated. This must be sha1.
* @member {string} [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. Possible values include: 'currentUser', 'localMachine'
* @member {string} [storeName] The name of the certificate store on the
* @property {string} [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.
* Possible values include: 'currentUser', 'localMachine'
* @property {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.
* @member {array} [visibility] Which user accounts on the compute node
* @property {array} [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.
*/

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -17,7 +17,7 @@
class CloudJobListPreparationAndReleaseTaskStatusResult extends Array {
/**
* Create a CloudJobListPreparationAndReleaseTaskStatusResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -16,7 +16,7 @@
class CloudJobListResult extends Array {
/**
* Create a CloudJobListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -16,7 +16,7 @@
class CloudJobScheduleListResult extends Array {
/**
* Create a CloudJobScheduleListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -17,86 +17,74 @@
class CloudPool {
/**
* Create a CloudPool.
* @member {string} [id] A string that uniquely identifies the pool within
* @property {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).
* @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.
* @member {string} [url] The URL of the pool.
* @member {string} [eTag] The ETag of the pool. This is an opaque string.
* @property {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.
* @property {string} [url] The URL of the pool.
* @property {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.
* @member {date} [lastModified] The last modified time of the pool. This is
* the last time at which the pool level data, such as the
* @property {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.
* @member {date} [creationTime] The creation time of the pool.
* @member {string} [state] The current state of the pool. Possible values
* include: 'active', 'deleting', 'upgrading'
* @member {date} [stateTransitionTime] The time at which the pool entered
* @property {date} [creationTime] The creation time of the pool.
* @property {string} [state] The current state of the pool. Possible values
* include: 'active', 'deleting'
* @property {date} [stateTransitionTime] The time at which the pool entered
* its current state.
* @member {string} [allocationState] Whether the pool is resizing. Possible
* values include: 'steady', 'resizing', 'stopping'
* @member {date} [allocationStateTransitionTime] The time at which the pool
* entered its current allocation state.
* @member {string} [vmSize] The size of virtual machines in the pool. All
* @property {string} [allocationState] Whether the pool is resizing.
* Possible values include: 'steady', 'resizing', 'stopping'
* @property {date} [allocationStateTransitionTime] The time at which the
* pool entered its current allocation state.
* @property {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
* compute nodes in an Azure Batch pool
* (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
* @member {object} [cloudServiceConfiguration] The cloud service
* @property {object} [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 'UserSubscription'.
* @member {string} [cloudServiceConfiguration.osFamily] Possible values are:
* @property {string} [cloudServiceConfiguration.osFamily] 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
* (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
* @member {string} [cloudServiceConfiguration.targetOSVersion] The default
* value is * which specifies the latest operating system version for the
* specified OS family.
* @member {string} [cloudServiceConfiguration.currentOSVersion] 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.
* @member {object} [virtualMachineConfiguration] The virtual machine
* @property {string} [cloudServiceConfiguration.osVersion] The default value
* is * which specifies the latest operating system version for the specified
* OS family.
* @property {object} [virtualMachineConfiguration] The virtual machine
* configuration for the pool. This property and cloudServiceConfiguration
* are mutually exclusive and one of the properties must be specified.
* @member {object} [virtualMachineConfiguration.imageReference]
* @member {string} [virtualMachineConfiguration.imageReference.publisher]
* @property {object} [virtualMachineConfiguration.imageReference]
* @property {string} [virtualMachineConfiguration.imageReference.publisher]
* For example, Canonical or MicrosoftWindowsServer.
* @member {string} [virtualMachineConfiguration.imageReference.offer] For
* @property {string} [virtualMachineConfiguration.imageReference.offer] For
* example, UbuntuServer or WindowsServer.
* @member {string} [virtualMachineConfiguration.imageReference.sku] For
* @property {string} [virtualMachineConfiguration.imageReference.sku] For
* example, 14.04.0-LTS or 2012-R2-Datacenter.
* @member {string} [virtualMachineConfiguration.imageReference.version] A
* @property {string} [virtualMachineConfiguration.imageReference.version] A
* value of 'latest' can be specified to select the latest version of an
* image. If omitted, the default is 'latest'.
* @member {string}
* @property {string}
* [virtualMachineConfiguration.imageReference.virtualMachineImageId] 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.
* @member {object} [virtualMachineConfiguration.osDisk]
* @member {string} [virtualMachineConfiguration.osDisk.caching] 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'
* @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch
* Azure Batch account. For more details, see
* https://docs.microsoft.com/azure/batch/batch-custom-images.
* @property {string} [virtualMachineConfiguration.nodeAgentSKUId] 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
@ -104,14 +92,14 @@ class CloudPool {
* 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.
* @member {object} [virtualMachineConfiguration.windowsConfiguration] This
* property must not be specified if the imageReference or osDisk property
* specifies a Linux OS image.
* @member {boolean}
* @property {object} [virtualMachineConfiguration.windowsConfiguration] This
* property must not be specified if the imageReference property specifies a
* Linux OS image.
* @property {boolean}
* [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates]
* If omitted, the default value is true.
* @member {array} [virtualMachineConfiguration.dataDisks] This property must
* be specified if the compute nodes in the pool need to have empty data
* @property {array} [virtualMachineConfiguration.dataDisks] 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
@ -121,7 +109,7 @@ class CloudPool {
* 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.
* @member {string} [virtualMachineConfiguration.licenseType] This only
* @property {string} [virtualMachineConfiguration.licenseType] 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
@ -129,99 +117,89 @@ class CloudPool {
*
* Windows_Server - The on-premises license is for Windows Server.
* Windows_Client - The on-premises license is for Windows Client.
* @member {object} [virtualMachineConfiguration.containerConfiguration] If
* @property {object} [virtualMachineConfiguration.containerConfiguration] 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.
* @member {array}
* @property {array}
* [virtualMachineConfiguration.containerConfiguration.containerImageNames]
* 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.
* @member {array}
* @property {array}
* [virtualMachineConfiguration.containerConfiguration.containerRegistries]
* If any images must be downloaded from a private registry which requires
* credentials, then those credentials must be provided here.
* @member {moment.duration} [resizeTimeout] The timeout for allocation of
* @property {moment.duration} [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.
* @member {array} [resizeErrors] A list of errors encountered while
* @property {array} [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.
* @member {number} [currentDedicatedNodes] The number of dedicated compute
* @property {number} [currentDedicatedNodes] The number of dedicated compute
* nodes currently in the pool.
* @member {number} [currentLowPriorityNodes] The number of low-priority
* @property {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.
* @member {number} [targetDedicatedNodes] The desired number of dedicated
* @property {number} [targetDedicatedNodes] The desired number of dedicated
* compute nodes in the pool.
* @member {number} [targetLowPriorityNodes] The desired number of
* @property {number} [targetLowPriorityNodes] The desired number of
* low-priority compute nodes in the pool.
* @member {boolean} [enableAutoScale] Whether the pool size should
* @property {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.
* @member {string} [autoScaleFormula] A formula for the desired number of
* @property {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.
* @member {moment.duration} [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.
* @member {object} [autoScaleRun] The results and errors from the last
* @property {moment.duration} [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.
* @property {object} [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.
* @member {date} [autoScaleRun.timestamp]
* @member {string} [autoScaleRun.results] Each variable value is returned in
* the form $variable=value, and variables are separated by semicolons.
* @member {object} [autoScaleRun.error]
* @member {string} [autoScaleRun.error.code]
* @member {string} [autoScaleRun.error.message]
* @member {array} [autoScaleRun.error.values]
* @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.
* @member {object} [networkConfiguration] The network configuration for the
* pool.
* @member {string} [networkConfiguration.subnetId] 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
* @property {date} [autoScaleRun.timestamp]
* @property {string} [autoScaleRun.results] Each variable value is returned
* in the form $variable=value, and variables are separated by semicolons.
* @property {object} [autoScaleRun.error]
* @property {string} [autoScaleRun.error.code]
* @property {string} [autoScaleRun.error.message]
* @property {array} [autoScaleRun.error.values]
* @property {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.
* @property {object} [networkConfiguration] The network configuration for
* the pool.
* @property {string} [networkConfiguration.subnetId] 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. 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:
* supported. For more details, see:
* https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
* @member {object} [networkConfiguration.endpointConfiguration] Pool
* @property {string} [networkConfiguration.dynamicVNetAssignmentScope]
* Possible values include: 'none', 'job'
* @property {object} [networkConfiguration.endpointConfiguration] Pool
* endpoint configuration is only supported on pools with the
* virtualMachineConfiguration property.
* @member {array}
* @property {array}
* [networkConfiguration.endpointConfiguration.inboundNATPools] 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.
* @member {object} [startTask] A task specified to run on each compute node
* as it joins the pool.
* @member {string} [startTask.commandLine] The command line does not run
* @property {object} [startTask] A task specified to run on each compute
* node as it joins the pool.
* @property {string} [startTask.commandLine] 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
@ -230,48 +208,48 @@ class CloudPool {
* (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).
* @member {object} [startTask.containerSettings] When this is specified, all
* directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of
* @property {object} [startTask.containerSettings] 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.
* @member {string} [startTask.containerSettings.containerRunOptions] These
* @property {string} [startTask.containerSettings.containerRunOptions] These
* additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [startTask.containerSettings.imageName] This is the full
* image reference, as would be specified to "docker pull". If no tag is
* @property {string} [startTask.containerSettings.imageName] 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.
* @member {object} [startTask.containerSettings.registry] This setting can
* @property {object} [startTask.containerSettings.registry] This setting can
* be omitted if was already provided at pool creation.
* @member {string} [startTask.containerSettings.registry.registryServer] If
* omitted, the default is "docker.io".
* @member {string} [startTask.containerSettings.registry.userName]
* @member {string} [startTask.containerSettings.registry.password]
* @member {array} [startTask.resourceFiles] Files listed under this element
* are located in the task's working directory.
* @member {array} [startTask.environmentSettings]
* @member {object} [startTask.userIdentity] If omitted, the task runs as a
* @property {string} [startTask.containerSettings.registry.registryServer]
* If omitted, the default is "docker.io".
* @property {string} [startTask.containerSettings.registry.userName]
* @property {string} [startTask.containerSettings.registry.password]
* @property {array} [startTask.resourceFiles] Files listed under this
* element are located in the task's working directory.
* @property {array} [startTask.environmentSettings]
* @property {object} [startTask.userIdentity] If omitted, the task runs as a
* non-administrative user unique to the task.
* @member {string} [startTask.userIdentity.userName] The userName and
* @property {string} [startTask.userIdentity.userName] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {object} [startTask.userIdentity.autoUser] The userName and
* @property {object} [startTask.userIdentity.autoUser] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {string} [startTask.userIdentity.autoUser.scope] The default value
* is task. Possible values include: 'task', 'pool'
* @member {string} [startTask.userIdentity.autoUser.elevationLevel] The
* @property {string} [startTask.userIdentity.autoUser.scope] The default
* value is task. Possible values include: 'task', 'pool'
* @property {string} [startTask.userIdentity.autoUser.elevationLevel] The
* default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {number} [startTask.maxTaskRetryCount] The Batch service retries a
* task if its exit code is nonzero. Note that this value specifically
* @property {number} [startTask.maxTaskRetryCount] 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.
* @member {boolean} [startTask.waitForSuccess] If true and the start task
* @property {boolean} [startTask.waitForSuccess] 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
@ -281,7 +259,7 @@ class CloudPool {
* 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.
* @member {array} [certificateReferences] The list of certificates to be
* @property {array} [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
@ -290,48 +268,48 @@ class CloudPool {
* 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.
* @member {array} [applicationPackageReferences] The list of application
* @property {array} [applicationPackageReferences] The list of application
* packages to be installed on each compute node in the pool.
* @member {array} [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.
* @member {number} [maxTasksPerNode] The maximum number of tasks that can
* @property {array} [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.
* @property {number} [maxTasksPerNode] The maximum number of tasks that can
* run concurrently on a single compute node in the pool.
* @member {object} [taskSchedulingPolicy] How tasks are distributed across
* @property {object} [taskSchedulingPolicy] How tasks are distributed across
* compute nodes in a pool.
* @member {string} [taskSchedulingPolicy.nodeFillType] Possible values
* @property {string} [taskSchedulingPolicy.nodeFillType] Possible values
* include: 'spread', 'pack'
* @member {array} [userAccounts] The list of user accounts to be created on
* each node in the pool.
* @member {array} [metadata] A list of name-value pairs associated with the
* pool as metadata.
* @member {object} [stats] Utilization and resource usage statistics for the
* entire lifetime of the pool. The statistics may not be immediately
* @property {array} [userAccounts] The list of user accounts to be created
* on each node in the pool.
* @property {array} [metadata] A list of name-value pairs associated with
* the pool as metadata.
* @property {object} [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.
* @member {string} [stats.url]
* @member {date} [stats.startTime]
* @member {date} [stats.lastUpdateTime]
* @member {object} [stats.usageStats]
* @member {date} [stats.usageStats.startTime]
* @member {date} [stats.usageStats.lastUpdateTime]
* @member {moment.duration} [stats.usageStats.dedicatedCoreTime]
* @member {object} [stats.resourceStats]
* @member {date} [stats.resourceStats.startTime]
* @member {date} [stats.resourceStats.lastUpdateTime]
* @member {number} [stats.resourceStats.avgCPUPercentage]
* @member {number} [stats.resourceStats.avgMemoryGiB]
* @member {number} [stats.resourceStats.peakMemoryGiB]
* @member {number} [stats.resourceStats.avgDiskGiB]
* @member {number} [stats.resourceStats.peakDiskGiB]
* @member {number} [stats.resourceStats.diskReadIOps]
* @member {number} [stats.resourceStats.diskWriteIOps]
* @member {number} [stats.resourceStats.diskReadGiB]
* @member {number} [stats.resourceStats.diskWriteGiB]
* @member {number} [stats.resourceStats.networkReadGiB]
* @member {number} [stats.resourceStats.networkWriteGiB]
* @property {string} [stats.url]
* @property {date} [stats.startTime]
* @property {date} [stats.lastUpdateTime]
* @property {object} [stats.usageStats]
* @property {date} [stats.usageStats.startTime]
* @property {date} [stats.usageStats.lastUpdateTime]
* @property {moment.duration} [stats.usageStats.dedicatedCoreTime]
* @property {object} [stats.resourceStats]
* @property {date} [stats.resourceStats.startTime]
* @property {date} [stats.resourceStats.lastUpdateTime]
* @property {number} [stats.resourceStats.avgCPUPercentage]
* @property {number} [stats.resourceStats.avgMemoryGiB]
* @property {number} [stats.resourceStats.peakMemoryGiB]
* @property {number} [stats.resourceStats.avgDiskGiB]
* @property {number} [stats.resourceStats.peakDiskGiB]
* @property {number} [stats.resourceStats.diskReadIOps]
* @property {number} [stats.resourceStats.diskWriteIOps]
* @property {number} [stats.resourceStats.diskReadGiB]
* @property {number} [stats.resourceStats.diskWriteGiB]
* @property {number} [stats.resourceStats.networkReadGiB]
* @property {number} [stats.resourceStats.networkWriteGiB]
*/
constructor() {
}
@ -397,7 +375,7 @@ class CloudPool {
serializedName: 'state',
type: {
name: 'Enum',
allowedValues: [ 'active', 'deleting', 'upgrading' ]
allowedValues: [ 'active', 'deleting' ]
}
},
stateTransitionTime: {

Просмотреть файл

@ -16,7 +16,7 @@
class CloudPoolListResult extends Array {
/**
* Create a CloudPoolListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -18,25 +18,17 @@
class CloudServiceConfiguration {
/**
* Create a CloudServiceConfiguration.
* @member {string} osFamily The Azure Guest OS family to be installed on the
* virtual machines in the pool. Possible values are:
* @property {string} osFamily 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
* (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
* @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.
* @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.
* @property {string} [osVersion] 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.
*/
constructor() {
}
@ -62,17 +54,9 @@ class CloudServiceConfiguration {
name: 'String'
}
},
targetOSVersion: {
osVersion: {
required: false,
serializedName: 'targetOSVersion',
type: {
name: 'String'
}
},
currentOSVersion: {
required: false,
readOnly: true,
serializedName: 'currentOSVersion',
serializedName: 'osVersion',
type: {
name: 'String'
}

Просмотреть файл

@ -28,89 +28,89 @@
class CloudTask {
/**
* Create a CloudTask.
* @member {string} [id] A string that uniquely identifies the task within
* @property {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.
* @member {string} [displayName] A display name for the task. The display
* @property {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.
* @member {string} [url] The URL of the task.
* @member {string} [eTag] The ETag of the task. This is an opaque string.
* @property {string} [url] The URL of the task.
* @property {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.
* @member {date} [lastModified] The last modified time of the task.
* @member {date} [creationTime] The creation time of the task.
* @member {object} [exitConditions] How the Batch service should respond
* @property {date} [lastModified] The last modified time of the task.
* @property {date} [creationTime] The creation time of the task.
* @property {object} [exitConditions] How the Batch service should respond
* when the task completes.
* @member {array} [exitConditions.exitCodes]
* @member {array} [exitConditions.exitCodeRanges]
* @member {object} [exitConditions.preProcessingError]
* @member {string} [exitConditions.preProcessingError.jobAction] The default
* @property {array} [exitConditions.exitCodes]
* @property {array} [exitConditions.exitCodeRanges]
* @property {object} [exitConditions.preProcessingError]
* @property {string} [exitConditions.preProcessingError.jobAction] 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'
* @property {string} [exitConditions.preProcessingError.dependencyAction]
* 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'
* @property {object} [exitConditions.fileUploadError] 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.
* @property {string} [exitConditions.fileUploadError.jobAction] 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'
* @member {string} [exitConditions.preProcessingError.dependencyAction] The
* @property {string} [exitConditions.fileUploadError.dependencyAction] 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'
* @member {object} [exitConditions.fileUploadError] 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.
* @member {string} [exitConditions.fileUploadError.jobAction] 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'
* @member {string} [exitConditions.fileUploadError.dependencyAction] 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'
* @member {object} [exitConditions.default] This value is used if the task
* @property {object} [exitConditions.default] 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 explicitly using the exitCodes
* behavior on exit code 0, you must list it explicitly using the exitCodes
* or exitCodeRanges collection.
* @member {string} [exitConditions.default.jobAction] The default is none
* @property {string} [exitConditions.default.jobAction] 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'
* @member {string} [exitConditions.default.dependencyAction] 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'
* @member {string} [state] The current state of the task. Possible values
* @property {string} [exitConditions.default.dependencyAction] 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'
* @property {string} [state] The current state of the task. Possible values
* include: 'active', 'preparing', 'running', 'completed'
* @member {date} [stateTransitionTime] The time at which the task entered
* @property {date} [stateTransitionTime] The time at which the task entered
* its current state.
* @member {string} [previousState] The previous state of the task. This
* @property {string} [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'
* @member {date} [previousStateTransitionTime] The time at which the task
* @property {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.
* @member {string} [commandLine] The command line of the task. For
* @property {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,
@ -121,8 +121,8 @@ class CloudTask {
* 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).
* @member {object} [containerSettings] The settings for the container under
* which the task runs. If the pool that will run this task has
* @property {object} [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
@ -130,19 +130,19 @@ class CloudTask {
* are mapped into the container, all task environment variables are mapped
* into the container, and the task command line is executed in the
* container.
* @member {string} [containerSettings.containerRunOptions] These additional
* options are supplied as arguments to the "docker create" command, in
* addition to those controlled by the Batch Service.
* @member {string} [containerSettings.imageName] This is the full image
* @property {string} [containerSettings.containerRunOptions] These
* additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @property {string} [containerSettings.imageName] 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.
* @member {object} [containerSettings.registry] This setting can be omitted
* if was already provided at pool creation.
* @member {string} [containerSettings.registry.registryServer] If omitted,
* @property {object} [containerSettings.registry] This setting can be
* omitted if was already provided at pool creation.
* @property {string} [containerSettings.registry.registryServer] If omitted,
* the default is "docker.io".
* @member {string} [containerSettings.registry.userName]
* @member {string} [containerSettings.registry.password]
* @member {array} [resourceFiles] A list of files that the Batch service
* @property {string} [containerSettings.registry.userName]
* @property {string} [containerSettings.registry.password]
* @property {array} [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
@ -151,155 +151,154 @@ class CloudTask {
* 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.
* @member {array} [outputFiles] A list of files that the Batch service will
* upload from the compute node after running the command line. For
* @property {array} [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.
* @member {array} [environmentSettings] A list of environment variable
* @property {array} [environmentSettings] A list of environment variable
* settings for the task.
* @member {object} [affinityInfo] A locality hint that can be used by the
* @property {object} [affinityInfo] A locality hint that can be used by the
* Batch service to select a compute node on which to start the new task.
* @member {string} [affinityInfo.affinityId] You can pass the affinityId of
* a compute node to indicate that this task needs to run on that compute
* @property {string} [affinityInfo.affinityId] 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.
* @member {object} [constraints] The execution constraints that apply to
* @property {object} [constraints] The execution constraints that apply to
* this task.
* @member {moment.duration} [constraints.maxWallClockTime] If this is not
* @property {moment.duration} [constraints.maxWallClockTime] If this is not
* specified, there is no time limit on how long the task may run.
* @member {moment.duration} [constraints.retentionTime] The default is
* infinite, i.e. the task directory will be retained until the compute node
* is removed or reimaged.
* @member {number} [constraints.maxTaskRetryCount] Note that this value
* @property {moment.duration} [constraints.retentionTime] 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.
* @property {number} [constraints.maxTaskRetryCount] 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.
* @member {object} [userIdentity] The user identity under which the task
* retries the task without limit.
* @property {object} [userIdentity] The user identity under which the task
* runs. If omitted, the task runs as a non-administrative user unique to the
* task.
* @member {string} [userIdentity.userName] The userName and autoUser
* @property {string} [userIdentity.userName] The userName and autoUser
* properties are mutually exclusive; you must specify one but not both.
* @member {object} [userIdentity.autoUser] The userName and autoUser
* @property {object} [userIdentity.autoUser] The userName and autoUser
* properties are mutually exclusive; you must specify one but not both.
* @member {string} [userIdentity.autoUser.scope] The default value is task.
* Possible values include: 'task', 'pool'
* @member {string} [userIdentity.autoUser.elevationLevel] The default value
* is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {object} [executionInfo] Information about the execution of the
* @property {string} [userIdentity.autoUser.scope] The default value is
* task. Possible values include: 'task', 'pool'
* @property {string} [userIdentity.autoUser.elevationLevel] The default
* value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @property {object} [executionInfo] Information about the execution of the
* task.
* @member {date} [executionInfo.startTime] 'Running' corresponds to the
* @property {date} [executionInfo.startTime] '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.
* @member {date} [executionInfo.endTime] This property is set only if the
* @property {date} [executionInfo.endTime] This property is set only if the
* task is in the Completed state.
* @member {number} [executionInfo.exitCode] 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.
* @member {object} [executionInfo.containerInfo] This property is set only
* @property {number} [executionInfo.exitCode] 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.
* @property {object} [executionInfo.containerInfo] This property is set only
* if the task runs in a container context.
* @member {string} [executionInfo.containerInfo.containerId]
* @member {string} [executionInfo.containerInfo.state] This is the state of
* the container according to the Docker service. It is equivalent to the
* @property {string} [executionInfo.containerInfo.containerId]
* @property {string} [executionInfo.containerInfo.state] This is the state
* of the container according to the Docker service. It is equivalent to the
* status field returned by "docker inspect".
* @member {string} [executionInfo.containerInfo.error] This is the detailed
* error string from the Docker service, if available. It is equivalent to
* the error field returned by "docker inspect".
* @member {object} [executionInfo.failureInfo] This property is set only if
* the task is in the completed state and encountered a failure.
* @member {string} [executionInfo.failureInfo.category] Possible values
* @property {string} [executionInfo.containerInfo.error] This is the
* detailed error string from the Docker service, if available. It is
* equivalent to the error field returned by "docker inspect".
* @property {object} [executionInfo.failureInfo] This property is set only
* if the task is in the completed state and encountered a failure.
* @property {string} [executionInfo.failureInfo.category] Possible values
* include: 'userError', 'serverError'
* @member {string} [executionInfo.failureInfo.code]
* @member {string} [executionInfo.failureInfo.message]
* @member {array} [executionInfo.failureInfo.details]
* @member {number} [executionInfo.retryCount] Task application failures
* @property {string} [executionInfo.failureInfo.code]
* @property {string} [executionInfo.failureInfo.message]
* @property {array} [executionInfo.failureInfo.details]
* @property {number} [executionInfo.retryCount] 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.
* @member {date} [executionInfo.lastRetryTime] 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.
* @member {number} [executionInfo.requeueCount] 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.
* @member {date} [executionInfo.lastRequeueTime] This property is set only
* @property {date} [executionInfo.lastRetryTime] 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.
* @property {number} [executionInfo.requeueCount] 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.
* @property {date} [executionInfo.lastRequeueTime] This property is set only
* if the requeueCount is nonzero.
* @member {string} [executionInfo.result] If the value is 'failed', then the
* details of the failure can be found in the failureInfo property. Possible
* values include: 'success', 'failure'
* @member {object} [nodeInfo] Information about the compute node on which
* @property {string} [executionInfo.result] If the value is 'failed', then
* the details of the failure can be found in the failureInfo property.
* Possible values include: 'success', 'failure'
* @property {object} [nodeInfo] Information about the compute node on which
* the task ran.
* @member {string} [nodeInfo.affinityId]
* @member {string} [nodeInfo.nodeUrl]
* @member {string} [nodeInfo.poolId]
* @member {string} [nodeInfo.nodeId]
* @member {string} [nodeInfo.taskRootDirectory]
* @member {string} [nodeInfo.taskRootDirectoryUrl]
* @member {object} [multiInstanceSettings] An object that indicates that the
* task is a multi-instance task, and contains information about how to run
* the multi-instance task.
* @member {number} [multiInstanceSettings.numberOfInstances] If omitted, the
* default is 1.
* @member {string} [multiInstanceSettings.coordinationCommandLine] A typical
* coordination command line launches a background service and verifies that
* the service is ready to process inter-node messages.
* @member {array} [multiInstanceSettings.commonResourceFiles] 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
* @property {string} [nodeInfo.affinityId]
* @property {string} [nodeInfo.nodeUrl]
* @property {string} [nodeInfo.poolId]
* @property {string} [nodeInfo.nodeId]
* @property {string} [nodeInfo.taskRootDirectory]
* @property {string} [nodeInfo.taskRootDirectoryUrl]
* @property {object} [multiInstanceSettings] An object that indicates that
* the task is a multi-instance task, and contains information about how to
* run the multi-instance task.
* @property {number} [multiInstanceSettings.numberOfInstances] If omitted,
* the default is 1.
* @property {string} [multiInstanceSettings.coordinationCommandLine] A
* typical coordination command line launches a background service and
* verifies that the service is ready to process inter-node messages.
* @property {array} [multiInstanceSettings.commonResourceFiles] 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.
* @member {object} [stats] Resource usage statistics for the task.
* @member {string} [stats.url]
* @member {date} [stats.startTime]
* @member {date} [stats.lastUpdateTime]
* @member {moment.duration} [stats.userCPUTime]
* @member {moment.duration} [stats.kernelCPUTime]
* @member {moment.duration} [stats.wallClockTime] 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.
* @member {number} [stats.readIOps]
* @member {number} [stats.writeIOps]
* @member {number} [stats.readIOGiB]
* @member {number} [stats.writeIOGiB]
* @member {moment.duration} [stats.waitTime]
* @member {object} [dependsOn] The tasks that this task depends on. This
* @property {object} [stats] Resource usage statistics for the task.
* @property {string} [stats.url]
* @property {date} [stats.startTime]
* @property {date} [stats.lastUpdateTime]
* @property {moment.duration} [stats.userCPUTime]
* @property {moment.duration} [stats.kernelCPUTime]
* @property {moment.duration} [stats.wallClockTime] 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.
* @property {number} [stats.readIOps]
* @property {number} [stats.writeIOps]
* @property {number} [stats.readIOGiB]
* @property {number} [stats.writeIOGiB]
* @property {moment.duration} [stats.waitTime]
* @property {object} [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.
* @member {array} [dependsOn.taskIds] The taskIds collection is limited to
* @property {array} [dependsOn.taskIds] 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.
* @member {array} [dependsOn.taskIdRanges]
* @member {array} [applicationPackageReferences] A list of application
* @property {array} [dependsOn.taskIdRanges]
* @property {array} [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
@ -307,7 +306,7 @@ class CloudTask {
* 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.
* @member {object} [authenticationTokenSettings] The settings for an
* @property {object} [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
@ -317,7 +316,7 @@ class CloudTask {
* 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.
* @member {array} [authenticationTokenSettings.access] The authentication
* @property {array} [authenticationTokenSettings.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

Просмотреть файл

@ -16,7 +16,7 @@
class CloudTaskListResult extends Array {
/**
* Create a CloudTaskListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -17,7 +17,7 @@
class CloudTaskListSubtasksResult {
/**
* Create a CloudTaskListSubtasksResult.
* @member {array} [value] The list of subtasks.
* @property {array} [value] The list of subtasks.
*/
constructor() {
}

Просмотреть файл

@ -17,55 +17,58 @@
class ComputeNode {
/**
* Create a 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.
* @member {string} [url] The URL of the compute node.
* @member {string} [state] The current state of the compute node. The
* @property {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.
* @property {string} [url] The URL of the compute node.
* @property {string} [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'
* @member {string} [schedulingState] Whether the compute node is available
* @property {string} [schedulingState] Whether the compute node is available
* for task scheduling. Possible values include: 'enabled', 'disabled'
* @member {date} [stateTransitionTime] The time at which the compute node
* @property {date} [stateTransitionTime] The time at which the compute node
* entered its current state.
* @member {date} [lastBootTime] The time at which the compute node was
* started. This property may not be present if the node state is unusable.
* @member {date} [allocationTime] The time at which this compute node was
* allocated to the pool.
* @member {string} [ipAddress] The IP address that other compute nodes can
* @property {date} [lastBootTime] The last time at which the compute node
* was started. This property may not be present if the node state is
* unusable.
* @property {date} [allocationTime] 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.
* @property {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.
* @member {string} [affinityId] An identifier which can be passed when
* @property {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.
* @member {string} [vmSize] The size of the virtual machine hosting the
* @property {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).
* @member {number} [totalTasksRun] The total number of job tasks completed
* @property {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.
* @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.
* @member {number} [totalTasksSucceeded] The total number of job tasks which
* completed successfully (with exitCode 0) on the compute node. This
* @property {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.
* @property {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.
* @member {array} [recentTasks] A list of tasks whose state has recently
* @property {array} [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.
* @member {object} [startTask] The task specified to run on the compute node
* as it joins the pool.
* @member {string} [startTask.commandLine] The command line does not run
* @property {object} [startTask] The task specified to run on the compute
* node as it joins the pool.
* @property {string} [startTask.commandLine] 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
@ -74,48 +77,48 @@ class ComputeNode {
* (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).
* @member {object} [startTask.containerSettings] When this is specified, all
* directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of
* @property {object} [startTask.containerSettings] 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.
* @member {string} [startTask.containerSettings.containerRunOptions] These
* @property {string} [startTask.containerSettings.containerRunOptions] These
* additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [startTask.containerSettings.imageName] This is the full
* image reference, as would be specified to "docker pull". If no tag is
* @property {string} [startTask.containerSettings.imageName] 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.
* @member {object} [startTask.containerSettings.registry] This setting can
* @property {object} [startTask.containerSettings.registry] This setting can
* be omitted if was already provided at pool creation.
* @member {string} [startTask.containerSettings.registry.registryServer] If
* omitted, the default is "docker.io".
* @member {string} [startTask.containerSettings.registry.userName]
* @member {string} [startTask.containerSettings.registry.password]
* @member {array} [startTask.resourceFiles] Files listed under this element
* are located in the task's working directory.
* @member {array} [startTask.environmentSettings]
* @member {object} [startTask.userIdentity] If omitted, the task runs as a
* @property {string} [startTask.containerSettings.registry.registryServer]
* If omitted, the default is "docker.io".
* @property {string} [startTask.containerSettings.registry.userName]
* @property {string} [startTask.containerSettings.registry.password]
* @property {array} [startTask.resourceFiles] Files listed under this
* element are located in the task's working directory.
* @property {array} [startTask.environmentSettings]
* @property {object} [startTask.userIdentity] If omitted, the task runs as a
* non-administrative user unique to the task.
* @member {string} [startTask.userIdentity.userName] The userName and
* @property {string} [startTask.userIdentity.userName] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {object} [startTask.userIdentity.autoUser] The userName and
* @property {object} [startTask.userIdentity.autoUser] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {string} [startTask.userIdentity.autoUser.scope] The default value
* is task. Possible values include: 'task', 'pool'
* @member {string} [startTask.userIdentity.autoUser.elevationLevel] The
* @property {string} [startTask.userIdentity.autoUser.scope] The default
* value is task. Possible values include: 'task', 'pool'
* @property {string} [startTask.userIdentity.autoUser.elevationLevel] The
* default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {number} [startTask.maxTaskRetryCount] The Batch service retries a
* task if its exit code is nonzero. Note that this value specifically
* @property {number} [startTask.maxTaskRetryCount] 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.
* @member {boolean} [startTask.waitForSuccess] If true and the start task
* @property {boolean} [startTask.waitForSuccess] 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
@ -125,77 +128,77 @@ class ComputeNode {
* 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.
* @member {object} [startTaskInfo] Runtime information about the execution
* @property {object} [startTaskInfo] Runtime information about the execution
* of the start task on the compute node.
* @member {string} [startTaskInfo.state] Possible values include: 'running',
* 'completed'
* @member {date} [startTaskInfo.startTime] This value is reset every time
* @property {string} [startTaskInfo.state] Possible values include:
* 'running', 'completed'
* @property {date} [startTaskInfo.startTime] 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).
* @member {date} [startTaskInfo.endTime] This is the end time of the most
* @property {date} [startTaskInfo.endTime] 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.
* @member {number} [startTaskInfo.exitCode] This property is set only if the
* start task is in the completed state. In general, the exit code for a
* @property {number} [startTaskInfo.exitCode] 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.
* @member {object} [startTaskInfo.containerInfo] This property is set only
* @property {object} [startTaskInfo.containerInfo] This property is set only
* if the task runs in a container context.
* @member {string} [startTaskInfo.containerInfo.containerId]
* @member {string} [startTaskInfo.containerInfo.state] This is the state of
* the container according to the Docker service. It is equivalent to the
* @property {string} [startTaskInfo.containerInfo.containerId]
* @property {string} [startTaskInfo.containerInfo.state] This is the state
* of the container according to the Docker service. It is equivalent to the
* status field returned by "docker inspect".
* @member {string} [startTaskInfo.containerInfo.error] This is the detailed
* error string from the Docker service, if available. It is equivalent to
* the error field returned by "docker inspect".
* @member {object} [startTaskInfo.failureInfo] This property is set only if
* the task is in the completed state and encountered a failure.
* @member {string} [startTaskInfo.failureInfo.category] Possible values
* @property {string} [startTaskInfo.containerInfo.error] This is the
* detailed error string from the Docker service, if available. It is
* equivalent to the error field returned by "docker inspect".
* @property {object} [startTaskInfo.failureInfo] This property is set only
* if the task is in the completed state and encountered a failure.
* @property {string} [startTaskInfo.failureInfo.category] Possible values
* include: 'userError', 'serverError'
* @member {string} [startTaskInfo.failureInfo.code]
* @member {string} [startTaskInfo.failureInfo.message]
* @member {array} [startTaskInfo.failureInfo.details]
* @member {number} [startTaskInfo.retryCount] Task application failures
* @property {string} [startTaskInfo.failureInfo.code]
* @property {string} [startTaskInfo.failureInfo.message]
* @property {array} [startTaskInfo.failureInfo.details]
* @property {number} [startTaskInfo.retryCount] 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.
* @member {date} [startTaskInfo.lastRetryTime] 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.
* @member {string} [startTaskInfo.result] If the value is 'failed', then the
* details of the failure can be found in the failureInfo property. Possible
* values include: 'success', 'failure'
* @member {array} [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
* @property {date} [startTaskInfo.lastRetryTime] 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.
* @property {string} [startTaskInfo.result] If the value is 'failed', then
* the details of the failure can be found in the failureInfo property.
* Possible values include: 'success', 'failure'
* @property {array} [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.
* @member {array} [errors] The list of errors that are currently being
* @property {array} [errors] The list of errors that are currently being
* encountered by the compute node.
* @member {boolean} [isDedicated] Whether this compute node is a dedicated
* @property {boolean} [isDedicated] Whether this compute node is a dedicated
* node. If false, the node is a low-priority node.
* @member {object} [endpointConfiguration] The endpoint configuration for
* @property {object} [endpointConfiguration] The endpoint configuration for
* the compute node.
* @member {array} [endpointConfiguration.inboundEndpoints]
* @member {object} [nodeAgentInfo] Information about the node agent version
* and the time the node upgraded to a new version.
* @member {string} [nodeAgentInfo.version] This version number can be
* @property {array} [endpointConfiguration.inboundEndpoints]
* @property {object} [nodeAgentInfo] Information about the node agent
* version and the time the node upgraded to a new version.
* @property {string} [nodeAgentInfo.version] 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.
* @member {date} [nodeAgentInfo.lastUpdateTime] This is the most recent time
* that the node agent was updated to a new version.
* @property {date} [nodeAgentInfo.lastUpdateTime] This is the most recent
* time that the node agent was updated to a new version.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeAddUserOptions {
/**
* Create a ComputeNodeAddUserOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeDeleteUserOptions {
/**
* Create a ComputeNodeDeleteUserOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeDisableSchedulingOptions {
/**
* Create a ComputeNodeDisableSchedulingOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeEnableSchedulingOptions {
/**
* Create a ComputeNodeEnableSchedulingOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,7 +17,7 @@
class ComputeNodeEndpointConfiguration {
/**
* Create a ComputeNodeEndpointConfiguration.
* @member {array} inboundEndpoints The list of inbound endpoints that are
* @property {array} inboundEndpoints The list of inbound endpoints that are
* accessible on the compute node.
*/
constructor() {

Просмотреть файл

@ -17,11 +17,11 @@
class ComputeNodeError {
/**
* Create a ComputeNodeError.
* @member {string} [code] An identifier for the compute node error. Codes
* @property {string} [code] An identifier for the compute node error. Codes
* are invariant and are intended to be consumed programmatically.
* @member {string} [message] A message describing the compute node error,
* @property {string} [message] A message describing the compute node error,
* intended to be suitable for display in a user interface.
* @member {array} [errorDetails] The list of additional error details
* @property {array} [errorDetails] The list of additional error details
* related to the compute node error.
*/
constructor() {

Просмотреть файл

@ -17,18 +17,18 @@
class ComputeNodeGetOptions {
/**
* Create a ComputeNodeGetOptions.
* @member {string} [select] An OData $select clause.
* @member {number} [timeout] The maximum time that the server can spend
* @property {string} [select] An OData $select clause.
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeGetRemoteDesktopOptions {
/**
* Create a ComputeNodeGetRemoteDesktopOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeGetRemoteLoginSettingsOptions {
/**
* Create a ComputeNodeGetRemoteLoginSettingsOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,9 +17,9 @@
class ComputeNodeGetRemoteLoginSettingsResult {
/**
* Create a ComputeNodeGetRemoteLoginSettingsResult.
* @member {string} remoteLoginIPAddress The IP address used for remote login
* to the compute node.
* @member {number} remoteLoginPort The port used for remote login to the
* @property {string} remoteLoginIPAddress The IP address used for remote
* login to the compute node.
* @property {number} remoteLoginPort The port used for remote login to the
* compute node.
*/
constructor() {

Просмотреть файл

@ -17,15 +17,15 @@
class ComputeNodeInformation {
/**
* Create a 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.
* @member {string} [nodeUrl] The URL of the node on which the task ran. .
* @member {string} [poolId] The ID of the pool on which the task ran.
* @member {string} [nodeId] The ID of the node on which the task ran.
* @member {string} [taskRootDirectory] The root directory of the task on the
* compute node.
* @member {string} [taskRootDirectoryUrl] The URL to the root directory of
* @property {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.
* @property {string} [nodeUrl] The URL of the node on which the task ran. .
* @property {string} [poolId] The ID of the pool on which the task ran.
* @property {string} [nodeId] The ID of the node on which the task ran.
* @property {string} [taskRootDirectory] The root directory of the task on
* the compute node.
* @property {string} [taskRootDirectoryUrl] The URL to the root directory of
* the task on the compute node.
*/
constructor() {

Просмотреть файл

@ -17,14 +17,14 @@
class ComputeNodeListNextOptions {
/**
* Create a ComputeNodeListNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,23 +17,24 @@
class ComputeNodeListOptions {
/**
* Create a ComputeNodeListOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {string} [select] An OData $select clause.
* @member {number} [maxResults] The maximum number of items to return in the
* response. A maximum of 1000 nodes can be returned. Default value: 1000 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {string} [select] An OData $select clause.
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 nodes can be returned. Default value: 1000
* .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -16,7 +16,7 @@
class ComputeNodeListResult extends Array {
/**
* Create a ComputeNodeListResult.
* @member {string} [odatanextLink]
* @property {string} [odatanextLink]
*/
constructor() {
super();

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeRebootOptions {
/**
* Create a ComputeNodeRebootOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeReimageOptions {
/**
* Create a ComputeNodeReimageOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeUpdateUserOptions {
/**
* Create a ComputeNodeUpdateUserOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class ComputeNodeUploadBatchServiceLogsOptions {
/**
* Create a ComputeNodeUploadBatchServiceLogsOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,18 +17,18 @@
class ComputeNodeUser {
/**
* Create a ComputeNodeUser.
* @member {string} name The user name of the account.
* @member {boolean} [isAdmin] Whether the account should be an administrator
* on the compute node. The default value is false.
* @member {date} [expiryTime] The time at which the account should expire.
* @property {string} name The user name of the account.
* @property {boolean} [isAdmin] Whether the account should be an
* administrator on the compute node. The default value is false.
* @property {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.
* @member {string} [password] The password of the account. The password is
* @property {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.
* @member {string} [sshPublicKey] The SSH public key that can be used for
* @property {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,

Просмотреть файл

@ -17,11 +17,11 @@
class ContainerConfiguration {
/**
* Create a ContainerConfiguration.
* @member {array} [containerImageNames] The collection of container image
* @property {array} [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 image is fully qualified with an alternative registry.
* @member {array} [containerRegistries] Additional private registries from
* @property {array} [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.

Просмотреть файл

@ -17,10 +17,10 @@
class ContainerRegistry {
/**
* Create a ContainerRegistry.
* @member {string} [registryServer] The registry URL. If omitted, the
* @property {string} [registryServer] The registry URL. If omitted, the
* default is "docker.io".
* @member {string} userName The user name to log into the registry server.
* @member {string} password The password to log into the registry server.
* @property {string} userName The user name to log into the registry server.
* @property {string} password The password to log into the registry server.
*/
constructor() {
}

Просмотреть файл

@ -18,18 +18,18 @@
class DataDisk {
/**
* Create a 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.
* @member {string} [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:
* @property {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.
* @property {string} [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:
* https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
* Possible values include: 'none', 'readOnly', 'readWrite'
* @member {number} diskSizeGB The initial disk size in gigabytes.
* @member {string} [storageAccountType] The storage account type to be used
* for the data disk. If omitted, the default is "standard_lrs". Possible
* values include: 'StandardLRS', 'PremiumLRS'
* @property {number} diskSizeGB The initial disk size in gigabytes.
* @property {string} [storageAccountType] The storage account type to be
* used for the data disk. If omitted, the default is "standard_lrs".
* Possible values include: 'StandardLRS', 'PremiumLRS'
*/
constructor() {
}

Просмотреть файл

@ -18,15 +18,16 @@
class DeleteCertificateError {
/**
* Create a DeleteCertificateError.
* @member {string} [code] An identifier for the certificate deletion error.
* Codes are invariant and are intended to be consumed programmatically.
* @member {string} [message] A message describing the certificate deletion
* @property {string} [code] An identifier for the certificate deletion
* error. Codes are invariant and are intended to be consumed
* programmatically.
* @property {string} [message] A message describing the certificate deletion
* error, intended to be suitable for display in a user interface.
* @member {array} [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.
* @property {array} [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.
*/
constructor() {
}

Просмотреть файл

@ -17,8 +17,8 @@
class EnvironmentSetting {
/**
* Create a EnvironmentSetting.
* @member {string} name The name of the environment variable.
* @member {string} [value] The value of the environment variable.
* @property {string} name The name of the environment variable.
* @property {string} [value] The value of the environment variable.
*/
constructor() {
}

Просмотреть файл

@ -17,8 +17,8 @@
class ErrorMessage {
/**
* Create a ErrorMessage.
* @member {string} [lang] The language code of the error message.
* @member {string} [value] The text of the message.
* @property {string} [lang] The language code of the error message.
* @property {string} [value] The text of the message.
*/
constructor() {
}

Просмотреть файл

@ -18,16 +18,16 @@
class ExitCodeMapping {
/**
* Create a ExitCodeMapping.
* @member {number} code A process exit code.
* @member {object} exitOptions How the Batch service should respond if the
* @property {number} code A process exit code.
* @property {object} exitOptions How the Batch service should respond if the
* task exits with this exit code.
* @member {string} [exitOptions.jobAction] 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'
* @member {string} [exitOptions.dependencyAction] The default is 'satisfy'
* @property {string} [exitOptions.jobAction] 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'
* @property {string} [exitOptions.dependencyAction] 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

Просмотреть файл

@ -18,17 +18,17 @@
class ExitCodeRangeMapping {
/**
* Create a ExitCodeRangeMapping.
* @member {number} start The first exit code in the range.
* @member {number} end The last exit code in the range.
* @member {object} exitOptions How the Batch service should respond if the
* @property {number} start The first exit code in the range.
* @property {number} end The last exit code in the range.
* @property {object} exitOptions How the Batch service should respond if the
* task exits with an exit code in the range start to end (inclusive).
* @member {string} [exitOptions.jobAction] 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'
* @member {string} [exitOptions.dependencyAction] The default is 'satisfy'
* @property {string} [exitOptions.jobAction] 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'
* @property {string} [exitOptions.dependencyAction] 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

Просмотреть файл

@ -18,57 +18,57 @@
class ExitConditions {
/**
* Create a ExitConditions.
* @member {array} [exitCodes] A list of individual task exit codes and how
* @property {array} [exitCodes] A list of individual task exit codes and how
* the Batch service should respond to them.
* @member {array} [exitCodeRanges] A list of task exit code ranges and how
* @property {array} [exitCodeRanges] A list of task exit code ranges and how
* the Batch service should respond to them.
* @member {object} [preProcessingError] How the Batch service should respond
* if the task fails to start due to an error.
* @member {string} [preProcessingError.jobAction] The default is none for
* @property {object} [preProcessingError] How the Batch service should
* respond if the task fails to start due to an error.
* @property {string} [preProcessingError.jobAction] 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'
* @member {string} [preProcessingError.dependencyAction] The default is
* @property {string} [preProcessingError.dependencyAction] 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'
* @member {object} [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
* @property {object} [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.
* @member {string} [fileUploadError.jobAction] The default is none for exit
* code 0 and terminate for all other exit conditions. If the job's
* @property {string} [fileUploadError.jobAction] 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'
* @member {string} [fileUploadError.dependencyAction] The default is
* @property {string} [fileUploadError.dependencyAction] 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'
* @member {object} [default] How the Batch service should respond if the
* @property {object} [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
* If you want non-default behavior on exit code 0, you must list it
* explicitly using the exitCodes or exitCodeRanges collection.
* @member {string} [default.jobAction] The default is none for exit code 0
* @property {string} [default.jobAction] 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'
* @member {string} [default.dependencyAction] The default is 'satisfy' for
* @property {string} [default.dependencyAction] 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

Просмотреть файл

@ -18,7 +18,7 @@
class ExitOptions {
/**
* Create a ExitOptions.
* @member {string} [jobAction] An action to take on the job containing the
* @property {string} [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
@ -27,7 +27,7 @@ class ExitOptions {
* value error; if you are calling the REST API directly, the HTTP status
* code is 400 (Bad Request). Possible values include: 'none', 'disable',
* 'terminate'
* @member {string} [dependencyAction] An action that the Batch service
* @property {string} [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

Просмотреть файл

@ -17,17 +17,17 @@
class FileDeleteFromComputeNodeOptions {
/**
* Create a FileDeleteFromComputeNodeOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,17 +17,17 @@
class FileDeleteFromTaskOptions {
/**
* Create a FileDeleteFromTaskOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,24 +17,24 @@
class FileGetFromComputeNodeOptions {
/**
* Create a FileGetFromComputeNodeOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @member {string} [ocpRange] The byte range to be retrieved. The default is
* to retrieve the entire file. The format is bytes=startRange-endRange.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {string} [ocpRange] The byte range to be retrieved. The default
* is to retrieve the entire file. The format is bytes=startRange-endRange.
* @property {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.
* @property {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.

Просмотреть файл

@ -17,24 +17,24 @@
class FileGetFromTaskOptions {
/**
* Create a FileGetFromTaskOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @member {string} [ocpRange] The byte range to be retrieved. The default is
* to retrieve the entire file. The format is bytes=startRange-endRange.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {string} [ocpRange] The byte range to be retrieved. The default
* is to retrieve the entire file. The format is bytes=startRange-endRange.
* @property {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.
* @property {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.

Просмотреть файл

@ -17,22 +17,22 @@
class FileGetPropertiesFromComputeNodeOptions {
/**
* Create a FileGetPropertiesFromComputeNodeOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {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.
* @property {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.

Просмотреть файл

@ -17,22 +17,22 @@
class FileGetPropertiesFromTaskOptions {
/**
* Create a FileGetPropertiesFromTaskOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {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.
* @property {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.

Просмотреть файл

@ -17,14 +17,14 @@
class FileListFromComputeNodeNextOptions {
/**
* Create a FileListFromComputeNodeNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,22 +17,23 @@
class FileListFromComputeNodeOptions {
/**
* Create a FileListFromComputeNodeOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {number} [maxResults] The maximum number of items to return in the
* response. A maximum of 1000 files can be returned. Default value: 1000 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 files can be returned. Default value: 1000
* .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,14 +17,14 @@
class FileListFromTaskNextOptions {
/**
* Create a FileListFromTaskNextOptions.
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,22 +17,23 @@
class FileListFromTaskOptions {
/**
* Create a FileListFromTaskOptions.
* @member {string} [filter] An OData $filter clause. For more information on
* constructing this filter, see
* @property {string} [filter] 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.
* @member {number} [maxResults] The maximum number of items to return in the
* response. A maximum of 1000 files can be returned. Default value: 1000 .
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [maxResults] The maximum number of items to return in
* the response. A maximum of 1000 files can be returned. Default value: 1000
* .
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,12 +17,13 @@
class FileProperties {
/**
* Create a FileProperties.
* @member {date} [creationTime] The file creation time. The creation time is
* not returned for files on Linux compute nodes.
* @member {date} lastModified The time at which the file was last modified.
* @member {number} contentLength The length of the file.
* @member {string} [contentType] The content type of the file.
* @member {string} [fileMode] The file mode attribute in octal format. The
* @property {date} [creationTime] The file creation time. The creation time
* is not returned for files on Linux compute nodes.
* @property {date} lastModified The time at which the file was last
* modified.
* @property {number} contentLength The length of the file.
* @property {string} [contentType] The content type of the file.
* @property {string} [fileMode] The file mode attribute in octal format. The
* file mode is returned only for files on Linux compute nodes.
*/
constructor() {

Просмотреть файл

@ -20,24 +20,23 @@
class ImageReference {
/**
* Create a ImageReference.
* @member {string} [publisher] The publisher of the Azure Virtual Machines
* @property {string} [publisher] The publisher of the Azure Virtual Machines
* Marketplace image. For example, Canonical or MicrosoftWindowsServer.
* @member {string} [offer] The offer type of the Azure Virtual Machines
* @property {string} [offer] The offer type of the Azure Virtual Machines
* Marketplace image. For example, UbuntuServer or WindowsServer.
* @member {string} [sku] The SKU of the Azure Virtual Machines Marketplace
* @property {string} [sku] The SKU of the Azure Virtual Machines Marketplace
* image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
* @member {string} [version] The version of the Azure Virtual Machines
* @property {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'.
* @member {string} [virtualMachineImageId] The ARM resource identifier of
* @property {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
* /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.
* the Azure Batch account. For more details, see
* https://docs.microsoft.com/azure/batch/batch-custom-images.
*/
constructor() {
}

Просмотреть файл

@ -17,15 +17,15 @@
class InboundEndpoint {
/**
* Create a InboundEndpoint.
* @member {string} name The name of the endpoint.
* @member {string} protocol The protocol of the endpoint. Possible values
* @property {string} name The name of the endpoint.
* @property {string} protocol The protocol of the endpoint. Possible values
* include: 'tcp', 'udp'
* @member {string} publicIPAddress The public IP address of the compute
* @property {string} publicIPAddress The public IP address of the compute
* node.
* @member {string} publicFQDN The public fully qualified domain name for the
* compute node.
* @member {number} frontendPort The public port number of the endpoint.
* @member {number} backendPort The backend port number of the endpoint.
* @property {string} publicFQDN The public fully qualified domain name for
* the compute node.
* @property {number} frontendPort The public port number of the endpoint.
* @property {number} backendPort The backend port number of the endpoint.
*/
constructor() {
}

Просмотреть файл

@ -18,32 +18,32 @@
class InboundNATPool {
/**
* Create a InboundNATPool.
* @member {string} name The name of the endpoint. The name must be unique
* @property {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.
* @member {string} protocol The protocol of the endpoint. Possible values
* @property {string} protocol The protocol of the endpoint. Possible values
* include: 'tcp', 'udp'
* @member {number} backendPort The port number on the compute node. This
* @property {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.
* @member {number} frontendPortRangeStart The first port number in the range
* of external ports that will be used to provide inbound access to the
* @property {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.
* @member {number} frontendPortRangeEnd The last port number in the range of
* external ports that will be used to provide inbound access to the
* @property {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.
* @member {array} [networkSecurityGroupRules] A list of network security
* @property {array} [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

18419
lib/services/batch/lib/models/index.d.ts поставляемый

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -36,6 +36,7 @@ exports.FileProperties = require('./fileProperties');
exports.NodeFile = require('./nodeFile');
exports.Schedule = require('./schedule');
exports.JobConstraints = require('./jobConstraints');
exports.JobNetworkConfiguration = require('./jobNetworkConfiguration');
exports.ContainerRegistry = require('./containerRegistry');
exports.TaskContainerSettings = require('./taskContainerSettings');
exports.ResourceFile = require('./resourceFile');
@ -47,6 +48,7 @@ exports.ExitConditions = require('./exitConditions');
exports.AutoUserSpecification = require('./autoUserSpecification');
exports.UserIdentity = require('./userIdentity');
exports.LinuxUserConfiguration = require('./linuxUserConfiguration');
exports.WindowsUserConfiguration = require('./windowsUserConfiguration');
exports.UserAccount = require('./userAccount');
exports.TaskConstraints = require('./taskConstraints');
exports.OutputFileBlobContainerDestination = require('./outputFileBlobContainerDestination');
@ -61,7 +63,6 @@ exports.StartTask = require('./startTask');
exports.CertificateReference = require('./certificateReference');
exports.MetadataItem = require('./metadataItem');
exports.CloudServiceConfiguration = require('./cloudServiceConfiguration');
exports.OSDisk = require('./oSDisk');
exports.WindowsConfiguration = require('./windowsConfiguration');
exports.DataDisk = require('./dataDisk');
exports.ContainerConfiguration = require('./containerConfiguration');
@ -130,7 +131,6 @@ exports.PoolEnableAutoScaleParameter = require('./poolEnableAutoScaleParameter')
exports.PoolEvaluateAutoScaleParameter = require('./poolEvaluateAutoScaleParameter');
exports.PoolResizeParameter = require('./poolResizeParameter');
exports.PoolUpdatePropertiesParameter = require('./poolUpdatePropertiesParameter');
exports.PoolUpgradeOSParameter = require('./poolUpgradeOSParameter');
exports.PoolPatchParameter = require('./poolPatchParameter');
exports.TaskUpdateParameter = require('./taskUpdateParameter');
exports.NodeUpdateUserParameter = require('./nodeUpdateUserParameter');
@ -158,7 +158,6 @@ exports.PoolEvaluateAutoScaleOptions = require('./poolEvaluateAutoScaleOptions')
exports.PoolResizeOptions = require('./poolResizeOptions');
exports.PoolStopResizeOptions = require('./poolStopResizeOptions');
exports.PoolUpdatePropertiesOptions = require('./poolUpdatePropertiesOptions');
exports.PoolUpgradeOSOptions = require('./poolUpgradeOSOptions');
exports.PoolRemoveNodesOptions = require('./poolRemoveNodesOptions');
exports.AccountListNodeAgentSkusOptions = require('./accountListNodeAgentSkusOptions');
exports.AccountListPoolNodeCountsOptions = require('./accountListPoolNodeCountsOptions');

Просмотреть файл

@ -17,17 +17,17 @@
class JobAddOptions {
/**
* Create a JobAddOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Просмотреть файл

@ -17,31 +17,31 @@
class JobAddParameter {
/**
* Create a JobAddParameter.
* @member {string} id A string that uniquely identifies the job within the
* @property {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).
* @member {string} [displayName] The display name for the job. The display
* @property {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.
* @member {number} [priority] The priority of the job. Priority values can
* @property {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.
* @member {object} [constraints] The execution constraints for the job.
* @member {moment.duration} [constraints.maxWallClockTime] If the job does
* @property {object} [constraints] The execution constraints for the job.
* @property {moment.duration} [constraints.maxWallClockTime] 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.
* @member {number} [constraints.maxTaskRetryCount] Note that this value
* @property {number} [constraints.maxTaskRetryCount] 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).
* @member {object} [jobManagerTask] Details of a Job Manager task to be
* @property {object} [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
@ -54,12 +54,12 @@ class JobAddParameter {
* 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.
* @member {string} [jobManagerTask.id] The ID can contain any combination of
* alphanumeric characters including hyphens and underscores and cannot
* @property {string} [jobManagerTask.id] The ID can contain any combination
* of alphanumeric characters including hyphens and underscores and cannot
* contain more than 64 characters.
* @member {string} [jobManagerTask.displayName] It need not be unique and
* @property {string} [jobManagerTask.displayName] It need not be unique and
* can contain any Unicode characters up to a maximum length of 1024.
* @member {string} [jobManagerTask.commandLine] The command line does not
* @property {string} [jobManagerTask.commandLine] 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
@ -68,57 +68,55 @@ class JobAddParameter {
* 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).
* @member {object} [jobManagerTask.containerSettings] 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.
* @member {string} [jobManagerTask.containerSettings.containerRunOptions]
* @property {object} [jobManagerTask.containerSettings] 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.
* @property {string} [jobManagerTask.containerSettings.containerRunOptions]
* These additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [jobManagerTask.containerSettings.imageName] 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
* @property {string} [jobManagerTask.containerSettings.imageName] 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.
* @member {object} [jobManagerTask.containerSettings.registry] This setting
* can be omitted if was already provided at pool creation.
* @member {string}
* @property {object} [jobManagerTask.containerSettings.registry] This
* setting can be omitted if was already provided at pool creation.
* @property {string}
* [jobManagerTask.containerSettings.registry.registryServer] If omitted, the
* default is "docker.io".
* @member {string} [jobManagerTask.containerSettings.registry.userName]
* @member {string} [jobManagerTask.containerSettings.registry.password]
* @member {array} [jobManagerTask.resourceFiles] Files listed under this
* @property {string} [jobManagerTask.containerSettings.registry.userName]
* @property {string} [jobManagerTask.containerSettings.registry.password]
* @property {array} [jobManagerTask.resourceFiles] 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.
* @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the
* files will only be uploaded from the compute node on which the primary
* @property {array} [jobManagerTask.outputFiles] For multi-instance tasks,
* the files will only be uploaded from the compute node on which the primary
* task is executed.
* @member {array} [jobManagerTask.environmentSettings]
* @member {object} [jobManagerTask.constraints]
* @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If
* this is not specified, there is no time limit on how long the task may
* @property {array} [jobManagerTask.environmentSettings]
* @property {object} [jobManagerTask.constraints]
* @property {moment.duration} [jobManagerTask.constraints.maxWallClockTime]
* If this is not specified, there is no time limit on how long the task may
* run.
* @member {moment.duration} [jobManagerTask.constraints.retentionTime] The
* default is infinite, i.e. the task directory will be retained until the
* compute node is removed or reimaged.
* @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that
* this value specifically controls the number of retries for the task
* @property {moment.duration} [jobManagerTask.constraints.retentionTime] 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.
* @property {number} [jobManagerTask.constraints.maxTaskRetryCount] 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.
* @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the
* the Batch service retries the task without limit.
* @property {boolean} [jobManagerTask.killJobOnCompletion] 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
@ -131,32 +129,33 @@ class JobAddParameter {
* 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.
* @member {object} [jobManagerTask.userIdentity] If omitted, the task runs
* @property {object} [jobManagerTask.userIdentity] If omitted, the task runs
* as a non-administrative user unique to the task.
* @member {string} [jobManagerTask.userIdentity.userName] The userName and
* @property {string} [jobManagerTask.userIdentity.userName] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {object} [jobManagerTask.userIdentity.autoUser] The userName and
* @property {object} [jobManagerTask.userIdentity.autoUser] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default
* value is task. Possible values include: 'task', 'pool'
* @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The
* default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks
* @property {string} [jobManagerTask.userIdentity.autoUser.scope] The
* default value is task. Possible values include: 'task', 'pool'
* @property {string} [jobManagerTask.userIdentity.autoUser.elevationLevel]
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
* @property {boolean} [jobManagerTask.runExclusive] 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.
* @member {array} [jobManagerTask.applicationPackageReferences] 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.
* @member {object} [jobManagerTask.authenticationTokenSettings] If this
* @property {array} [jobManagerTask.applicationPackageReferences]
* 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.
* @property {object} [jobManagerTask.authenticationTokenSettings] 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
@ -164,18 +163,18 @@ class JobAddParameter {
* 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.
* @member {array} [jobManagerTask.authenticationTokenSettings.access] The
* @property {array} [jobManagerTask.authenticationTokenSettings.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.
* @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value
* is true.
* @member {object} [jobPreparationTask] The Job Preparation task. If a job
* @property {boolean} [jobManagerTask.allowLowPriorityNode] The default
* value is true.
* @property {object} [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.
* @member {string} [jobPreparationTask.id] The ID can contain any
* @property {string} [jobPreparationTask.id] 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'.
@ -183,7 +182,7 @@ class JobAddParameter {
* 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).
* @member {string} [jobPreparationTask.commandLine] The command line does
* @property {string} [jobPreparationTask.commandLine] 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
@ -192,55 +191,55 @@ class JobAddParameter {
* 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).
* @member {object} [jobPreparationTask.containerSettings] When this is
* @property {object} [jobPreparationTask.containerSettings] 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.
* @member {string}
* @property {string}
* [jobPreparationTask.containerSettings.containerRunOptions] These
* additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [jobPreparationTask.containerSettings.imageName] This is
* the full image reference, as would be specified to "docker pull". If no
* @property {string} [jobPreparationTask.containerSettings.imageName] 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.
* @member {object} [jobPreparationTask.containerSettings.registry] This
* @property {object} [jobPreparationTask.containerSettings.registry] This
* setting can be omitted if was already provided at pool creation.
* @member {string}
* @property {string}
* [jobPreparationTask.containerSettings.registry.registryServer] If omitted,
* the default is "docker.io".
* @member {string} [jobPreparationTask.containerSettings.registry.userName]
* @member {string} [jobPreparationTask.containerSettings.registry.password]
* @member {array} [jobPreparationTask.resourceFiles] 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
* @property {string}
* [jobPreparationTask.containerSettings.registry.userName]
* @property {string}
* [jobPreparationTask.containerSettings.registry.password]
* @property {array} [jobPreparationTask.resourceFiles] 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.
* @member {array} [jobPreparationTask.environmentSettings]
* @member {object} [jobPreparationTask.constraints]
* @member {moment.duration}
* @property {array} [jobPreparationTask.environmentSettings]
* @property {object} [jobPreparationTask.constraints]
* @property {moment.duration}
* [jobPreparationTask.constraints.maxWallClockTime] If this is not
* specified, there is no time limit on how long the task may run.
* @member {moment.duration} [jobPreparationTask.constraints.retentionTime]
* The default is infinite, i.e. the task directory will be retained until
* the compute node is removed or reimaged.
* @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note
* @property {moment.duration} [jobPreparationTask.constraints.retentionTime]
* 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.
* @property {number} [jobPreparationTask.constraints.maxTaskRetryCount] 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.
* @member {boolean} [jobPreparationTask.waitForSuccess] 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
* the Batch service retries the task without limit.
* @property {boolean} [jobPreparationTask.waitForSuccess] 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
@ -248,42 +247,42 @@ class JobAddParameter {
* 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.
* @member {object} [jobPreparationTask.userIdentity] If omitted, the task
* @property {object} [jobPreparationTask.userIdentity] 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.
* @member {string} [jobPreparationTask.userIdentity.userName] The userName
* a non-administrative user unique to the pool on Linux nodes.
* @property {string} [jobPreparationTask.userIdentity.userName] The userName
* and autoUser properties are mutually exclusive; you must specify one but
* not both.
* @member {object} [jobPreparationTask.userIdentity.autoUser] The userName
* @property {object} [jobPreparationTask.userIdentity.autoUser] The userName
* and autoUser properties are mutually exclusive; you must specify one but
* not both.
* @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The
* @property {string} [jobPreparationTask.userIdentity.autoUser.scope] The
* default value is task. Possible values include: 'task', 'pool'
* @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel]
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
* @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The
* @property {string}
* [jobPreparationTask.userIdentity.autoUser.elevationLevel] The default
* value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @property {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] 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.
* @member {object} [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.
* @member {string} [jobReleaseTask.id] The ID can contain any combination of
* alphanumeric characters including hyphens and underscores and cannot
* @property {object} [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.
* @property {string} [jobReleaseTask.id] 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).
* @member {string} [jobReleaseTask.commandLine] The command line does not
* @property {string} [jobReleaseTask.commandLine] 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
@ -292,59 +291,60 @@ class JobAddParameter {
* 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).
* @member {object} [jobReleaseTask.containerSettings] When this is
* @property {object} [jobReleaseTask.containerSettings] 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.
* @member {string} [jobReleaseTask.containerSettings.containerRunOptions]
* @property {string} [jobReleaseTask.containerSettings.containerRunOptions]
* These additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string} [jobReleaseTask.containerSettings.imageName] 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
* @property {string} [jobReleaseTask.containerSettings.imageName] 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.
* @member {object} [jobReleaseTask.containerSettings.registry] This setting
* can be omitted if was already provided at pool creation.
* @member {string}
* @property {object} [jobReleaseTask.containerSettings.registry] This
* setting can be omitted if was already provided at pool creation.
* @property {string}
* [jobReleaseTask.containerSettings.registry.registryServer] If omitted, the
* default is "docker.io".
* @member {string} [jobReleaseTask.containerSettings.registry.userName]
* @member {string} [jobReleaseTask.containerSettings.registry.password]
* @member {array} [jobReleaseTask.resourceFiles] Files listed under this
* @property {string} [jobReleaseTask.containerSettings.registry.userName]
* @property {string} [jobReleaseTask.containerSettings.registry.password]
* @property {array} [jobReleaseTask.resourceFiles] Files listed under this
* element are located in the task's working directory.
* @member {array} [jobReleaseTask.environmentSettings]
* @member {moment.duration} [jobReleaseTask.maxWallClockTime]
* @member {moment.duration} [jobReleaseTask.retentionTime] The default is
* infinite, i.e. the task directory will be retained until the compute node
* is removed or reimaged.
* @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs
* @property {array} [jobReleaseTask.environmentSettings]
* @property {moment.duration} [jobReleaseTask.maxWallClockTime]
* @property {moment.duration} [jobReleaseTask.retentionTime] 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.
* @property {object} [jobReleaseTask.userIdentity] If omitted, the task runs
* as a non-administrative user unique to the task.
* @member {string} [jobReleaseTask.userIdentity.userName] The userName and
* @property {string} [jobReleaseTask.userIdentity.userName] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and
* @property {object} [jobReleaseTask.userIdentity.autoUser] The userName and
* autoUser properties are mutually exclusive; you must specify one but not
* both.
* @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default
* value is task. Possible values include: 'task', 'pool'
* @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The
* default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'
* @member {array} [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.
* @member {object} poolInfo The pool on which the Batch service runs the
* @property {string} [jobReleaseTask.userIdentity.autoUser.scope] The
* default value is task. Possible values include: 'task', 'pool'
* @property {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel]
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
* @property {array} [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.
* @property {object} poolInfo The pool on which the Batch service runs the
* job's tasks.
* @member {string} [poolInfo.poolId] You must ensure that the pool
* @property {string} [poolInfo.poolId] 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.
* @member {object} [poolInfo.autoPoolSpecification] If auto pool creation
* @property {object} [poolInfo.autoPoolSpecification] 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
@ -352,28 +352,28 @@ class JobAddParameter {
* 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.
* @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The
* @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] 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.
* @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption]
* @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption]
* Possible values include: 'jobSchedule', 'job'
* @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the
* Batch service deletes the pool once its lifetime (as determined by the
* @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] 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.
* @member {object} [poolInfo.autoPoolSpecification.pool]
* @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The
* @property {object} [poolInfo.autoPoolSpecification.pool]
* @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The
* display name need not be unique and can contain any Unicode characters up
* to a maximum length of 1024.
* @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For
* @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] 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).
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This
* property must be specified if the pool needs to be created with Azure PaaS
* VMs. This property and virtualMachineConfiguration are mutually exclusive
@ -382,7 +382,7 @@ class JobAddParameter {
* 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'.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily]
* Possible values are:
* 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1.
@ -391,55 +391,39 @@ class JobAddParameter {
* 5 - OS Family 5, equivalent to Windows Server 2016. For more information,
* see Azure Guest OS Releases
* (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
* @member {string}
* [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.targetOSVersion]
* @property {string}
* [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion]
* The default value is * which specifies the latest operating system version
* for the specified OS family.
* @member {string}
* [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.currentOSVersion]
* 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.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] 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).
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference]
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher]
* For example, Canonical or MicrosoftWindowsServer.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer]
* For example, UbuntuServer or WindowsServer.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku]
* For example, 14.04.0-LTS or 2012-R2-Datacenter.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version]
* A value of 'latest' can be specified to select the latest version of an
* image. If omitted, the default is 'latest'.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId]
* 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.
* @member {object}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.osDisk]
* @member {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.osDisk.caching]
* 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'
* @member {string}
* the Azure Batch account. For more details, see
* https://docs.microsoft.com/azure/batch/batch-custom-images.
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId]
* 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
@ -448,14 +432,14 @@ class JobAddParameter {
* 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.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration]
* This property must not be specified if the imageReference or osDisk
* property specifies a Linux OS image.
* @member {boolean}
* This property must not be specified if the imageReference property
* specifies a Linux OS image.
* @property {boolean}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates]
* If omitted, the default value is true.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks]
* 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
@ -467,7 +451,7 @@ class JobAddParameter {
* 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.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType]
* 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
@ -476,106 +460,98 @@ class JobAddParameter {
*
* Windows_Server - The on-premises license is for Windows Server.
* Windows_Client - The on-premises license is for Windows Client.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration]
* 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.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames]
* 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.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries]
* If any images must be downloaded from a private registry which requires
* credentials, then those credentials must be provided here.
* @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] 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).
* @member {object}
* @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode]
* 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).
* @property {object}
* [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy]
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType]
* Possible values include: 'spread', 'pack'
* @member {moment.duration}
* @property {moment.duration}
* [poolInfo.autoPoolSpecification.pool.resizeTimeout] 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).
* @member {number}
* @property {number}
* [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] 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.
* @member {number}
* @property {number}
* [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] 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.
* @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] 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
* @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale]
* 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.
* @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula]
* @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula]
* 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.
* @member {moment.duration}
* @property {moment.duration}
* [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] 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).
* @member {boolean}
* @property {boolean}
* [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication]
* 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.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration]
* @member {string}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] 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:
* @property {string}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] 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. 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
* @member {object}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope]
* Possible values include: 'none', 'job'
* @property {object}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration]
* Pool endpoint configuration is only supported on pools with the
* virtualMachineConfiguration property.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools]
* 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.
* @member {object} [poolInfo.autoPoolSpecification.pool.startTask]
* @member {string}
* @property {object} [poolInfo.autoPoolSpecification.pool.startTask]
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.commandLine] 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
@ -585,56 +561,56 @@ class JobAddParameter {
* 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).
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] 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.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions]
* These additional options are supplied as arguments to the "docker create"
* command, in addition to those controlled by the Batch Service.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName]
* 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.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry]
* This setting can be omitted if was already provided at pool creation.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer]
* If omitted, the default is "docker.io".
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName]
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password]
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed
* under this element are located in the task's working directory.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings]
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted,
* the task runs as a non-administrative user unique to the task.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The
* userName and autoUser properties are mutually exclusive; you must specify
* one but not both.
* @member {object}
* @property {object}
* [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The
* userName and autoUser properties are mutually exclusive; you must specify
* one but not both.
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope]
* The default value is task. Possible values include: 'task', 'pool'
* @member {string}
* @property {string}
* [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel]
* The default value is nonAdmin. Possible values include: 'nonAdmin',
* 'admin'
* @member {number}
* @property {number}
* [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] 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
@ -643,7 +619,7 @@ class JobAddParameter {
* 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.
* @member {boolean}
* @property {boolean}
* [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] 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
@ -655,7 +631,7 @@ class JobAddParameter {
* 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.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows
* compute nodes, the Batch service installs the certificates to the
* specified certificate store and location. For Linux compute nodes, the
@ -665,39 +641,50 @@ class JobAddParameter {
* '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.
* @member {array}
* @property {array}
* [poolInfo.autoPoolSpecification.pool.applicationPackageReferences]
* @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses]
* 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.
* @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts]
* @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch
* @property {array}
* [poolInfo.autoPoolSpecification.pool.applicationLicenses] 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.
* @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts]
* @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch
* service does not assign any meaning to metadata; it is solely for the use
* of user code.
* @member {string} [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'
* @member {string} [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',
* @property {string} [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'
* @property {string} [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'
* @member {array} [metadata] A list of name-value pairs associated with the
* job as metadata. The Batch service does not assign any meaning to
* @property {array} [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.
* @member {boolean} [usesTaskDependencies] Whether tasks in the job can
* @property {boolean} [usesTaskDependencies] Whether tasks in the job can
* define dependencies on each other. The default is false.
* @property {object} [networkConfiguration] The network configuration for
* the job.
* @property {string} [networkConfiguration.subnetId] 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.
*/
constructor() {
}
@ -830,6 +817,14 @@ class JobAddParameter {
type: {
name: 'Boolean'
}
},
networkConfiguration: {
required: false,
serializedName: 'networkConfiguration',
type: {
name: 'Composite',
className: 'JobNetworkConfiguration'
}
}
}
}

Просмотреть файл

@ -17,14 +17,14 @@
class JobConstraints {
/**
* Create a JobConstraints.
* @member {moment.duration} [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.
* @member {number} [maxTaskRetryCount] The maximum number of times each task
* may be retried. The Batch service retries a task if its exit code is
* @property {moment.duration} [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.
* @property {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

Просмотреть файл

@ -17,30 +17,30 @@
class JobDeleteMethodOptions {
/**
* Create a JobDeleteMethodOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @member {string} [ifMatch] An ETag value associated with the version of
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {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.
* @member {string} [ifNoneMatch] An ETag value associated with the version
* @property {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.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {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.
* @property {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.

Просмотреть файл

@ -17,30 +17,30 @@
class JobDisableOptions {
/**
* Create a JobDisableOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @member {string} [ifMatch] An ETag value associated with the version of
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {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.
* @member {string} [ifNoneMatch] An ETag value associated with the version
* @property {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.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {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.
* @property {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.

Просмотреть файл

@ -17,8 +17,8 @@
class JobDisableParameter {
/**
* Create a JobDisableParameter.
* @member {string} disableTasks What to do with active tasks associated with
* the job. Possible values include: 'requeue', 'terminate', 'wait'
* @property {string} disableTasks What to do with active tasks associated
* with the job. Possible values include: 'requeue', 'terminate', 'wait'
*/
constructor() {
}

Просмотреть файл

@ -17,30 +17,30 @@
class JobEnableOptions {
/**
* Create a JobEnableOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @member {string} [ifMatch] An ETag value associated with the version of
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
* @property {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.
* @member {string} [ifNoneMatch] An ETag value associated with the version
* @property {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.
* @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.
* @member {date} [ifUnmodifiedSince] A timestamp indicating the last
* @property {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.
* @property {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.

Просмотреть файл

@ -18,28 +18,28 @@
class JobExecutionInformation {
/**
* Create a JobExecutionInformation.
* @member {date} startTime The start time of the job. This is the time at
* @property {date} startTime The start time of the job. This is the time at
* which the job was created.
* @member {date} [endTime] The completion time of the job. This property is
* set only if the job is in the completed state.
* @member {string} [poolId] The ID of the pool to which this job is
* @property {date} [endTime] The completion time of the job. This property
* is set only if the job is in the completed state.
* @property {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.
* @member {object} [schedulingError] Details of any error encountered by the
* service in starting the job. This property is not set if there was no
* @property {object} [schedulingError] 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.
* @member {string} [schedulingError.category] Possible values include:
* @property {string} [schedulingError.category] Possible values include:
* 'userError', 'serverError'
* @member {string} [schedulingError.code]
* @member {string} [schedulingError.message]
* @member {array} [schedulingError.details]
* @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:
* @property {string} [schedulingError.code]
* @property {string} [schedulingError.message]
* @property {array} [schedulingError.details]
* @property {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

Просмотреть файл

@ -17,17 +17,17 @@
class JobGetAllLifetimeStatisticsOptions {
/**
* Create a JobGetAllLifetimeStatisticsOptions.
* @member {number} [timeout] The maximum time that the server can spend
* @property {number} [timeout] The maximum time that the server can spend
* processing the request, in seconds. The default is 30 seconds. Default
* value: 30 .
* @member {uuid} [clientRequestId] The caller-generated request identity, in
* the form of a GUID with no decoration such as curly braces, e.g.
* @property {uuid} [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.
* @member {boolean} [returnClientRequestId] Whether the server should return
* the client-request-id in the response. Default value: false .
* @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.
* @property {boolean} [returnClientRequestId] Whether the server should
* return the client-request-id in the response. Default value: false .
* @property {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.
*/
constructor() {
}

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше