swagger: '2.0'
info:
title: Microsoft Azure BatchServiceClient
version: 2024-02-01.19.0
description: A client for issuing REST requests to the Azure Batch service.
x-ms-parameterized-host:
hostTemplate: '{batchUrl}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/batchUrl'
schemes:
- https
consumes:
- application/json; odata=minimalmetadata
produces:
- application/json
security:
- azure_auth:
- user_impersonation
- api_key: []
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Microsoft Entra OAuth 2.0 auth code flow
scopes:
user_impersonation: Impersonate your user account
api_key:
type: apiKey
name: Authorization
in: header
paths:
/applications:
get:
tags:
- Applications
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureApplicationList
x-ms-examples:
List applications:
$ref: ./examples/ApplicationList.json
summary: 'Microsoft Azure Lists All Of The Applications Available In The Specified Account'
description: >-
This operation returns only Applications and versions that are available
for use on Compute Nodes; that is, that can be used in an Package
reference. For administrator information about applications and versions
that are not yet available to Compute Nodes, use the Azure portal or the
Azure Resource Manager API.
x-ms-request-id: request-id
parameters:
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 applications can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of applications.
schema:
$ref: '#/definitions/ApplicationListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/applications/{applicationId}:
get:
tags:
- Applications
operationId: microsoftAzureApplicationGet
x-ms-examples:
Get applications:
$ref: ./examples/ApplicationGet.json
summary: 'Microsoft Azure Gets Information About The Specified Application'
description: >-
This operation returns only Applications and versions that are available
for use on Compute Nodes; that is, that can be used in an Package
reference. For administrator information about Applications and versions
that are not yet available to Compute Nodes, use the Azure portal or the
Azure Resource Manager API.
x-ms-request-id: request-id
parameters:
- name: applicationId
in: path
required: true
type: string
description: The ID of the Application.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the application.
schema:
$ref: '#/definitions/ApplicationSummary'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/poolusagemetrics:
get:
tags:
- Pools
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzurePoolListusagemetrics
x-ms-examples:
Pool list usage metrics:
$ref: ./examples/PoolListUsageMetrics.json
summary: >-
Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual Time Intervals, For The Specified Account
description: >-
If you do not specify a $filter clause including a poolId, the response
includes all Pools that existed in the Account in the time range of the
returned aggregation intervals. If you do not specify a $filter clause
including a startTime or endTime these filters default to the start and
end times of the last aggregation interval currently available; that is,
only the last aggregation interval is returned.
x-ms-request-id: request-id
parameters:
- name: starttime
x-ms-client-name: startTime
in: query
required: false
type: string
format: date-time
description: >-
The earliest time from which to include metrics. This must be at
least two and a half hours before the current time. If not specified
this defaults to the start time of the last aggregation interval
currently available.
x-ms-parameter-grouping:
postfix: Options
- name: endtime
x-ms-client-name: endTime
in: query
required: false
type: string
format: date-time
description: >-
The latest time from which to include metrics. This must be at least
two hours before the current time. If not specified this defaults to
the end time of the last aggregation interval currently available.
x-ms-parameter-grouping:
postfix: Options
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 results will be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Pool usage details.
schema:
$ref: '#/definitions/PoolListUsageMetricsResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/supportedimages:
get:
tags:
- Accounts
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureAccountListsupportedimages
x-ms-examples:
Account list node agent skus:
$ref: ./examples/AccountListSupportedImages.json
summary: 'Microsoft Azure Lists All Virtual Machine Images Supported By The Azure Batch Service'
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
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-support-images.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 results will be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of supported Virtual Machine Images.
schema:
$ref: '#/definitions/AccountListSupportedImagesResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/nodecounts:
get:
x-ms-pageable:
nextLinkName: odata.nextLink
tags:
- Accounts
operationId: microsoftAzureAccountListpoolnodecounts
description: >-
Gets the number of Compute Nodes in each state, grouped by Pool. Note
that the numbers returned may not always be up to date. If you need
exact node counts, use a list query.
x-ms-examples:
NodeCountsPayload:
$ref: ./examples/AccountListPoolNodeCounts.json
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 10
minimum: 1
maximum: 10
in: query
required: false
type: integer
format: int32
description: The maximum number of items to return in the response.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
description: >-
The response contains the number of Compute Nodes in each Compute
Node state, grouped by Pool.
schema:
$ref: '#/definitions/PoolNodeCountsListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Nodecounts
/certificates:
post:
deprecated: true
tags:
- Certificates
operationId: microsoftAzureCertificateAdd
x-ms-examples:
Certificate add:
$ref: ./examples/CertificateAdd.json
summary: 'Microsoft Azure Adds A Certificate To The Specified Account'
description: >-
Warning: This operation is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: certificate
in: body
description: The Certificate to be added.
required: true
schema:
$ref: '#/definitions/CertificateAddParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
deprecated: true
tags:
- Certificates
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureCertificateList
x-ms-examples:
Certificate list:
$ref: ./examples/CertificateList.json
summary: >-
Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account
description: >-
Warning: This operation is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Certificates can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Certificates.
schema:
$ref: '#/definitions/CertificateListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete:
post:
deprecated: true
tags:
- Certificates
operationId: microsoftAzureCertificateCanceldeletion
x-ms-examples:
Certificate cancel delete:
$ref: ./examples/CertificateCancelDelete.json
summary: 'Microsoft Azure Cancels A Failed Deletion Of A Certificate From The Specified Account'
description: >-
If you try to delete a Certificate that is being used by a Pool or
Compute Node, the status of the Certificate changes to deleteFailed. If
you decide that you want to continue using the Certificate, you can use
this operation to set the status of the Certificate back to active. If
you intend to delete the Certificate, you do not need to run this
operation after the deletion failed. You must make sure that the
Certificate is not being used by any resources, and then you can try
again to delete the Certificate.
Warning: This operation is
deprecated and will be removed after February, 2024. Please use the
[Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: thumbprintAlgorithm
in: path
required: true
type: string
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
- name: thumbprint
in: path
required: true
type: string
description: The thumbprint of the Certificate being deleted.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}):
delete:
deprecated: true
tags:
- Certificates
operationId: microsoftAzureCertificateDelete
x-ms-examples:
Certificate delete:
$ref: ./examples/CertificateDelete.json
summary: 'Microsoft Azure Deletes A Certificate From The Specified Account'
description: >-
You cannot delete a Certificate if a resource (Pool or Compute Node) is
using it. Before you can delete a Certificate, you must therefore make
sure that the Certificate is not associated with any existing Pools, the
Certificate is not installed on any Nodes (even if you remove a
Certificate from a Pool, it is not removed from existing Compute Nodes
in that Pool until they restart), and no running Tasks depend on the
Certificate. If you try to delete a Certificate that is in use, the
deletion fails. The Certificate status changes to deleteFailed. You can
use Cancel Delete Certificate to set the status back to active if you
decide that you want to continue using the Certificate.
Warning:
This operation is deprecated and will be removed after February, 2024.
Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: thumbprintAlgorithm
in: path
required: true
type: string
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
- name: thumbprint
in: path
required: true
type: string
description: The thumbprint of the Certificate to be deleted.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
deprecated: true
tags:
- Certificates
operationId: microsoftAzureCertificateGet
x-ms-examples:
Certificate get:
$ref: ./examples/CertificateGet.json
summary: 'Microsoft Azure Gets Information About The Specified Certificate'
description: >-
Warning: This operation is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: thumbprintAlgorithm
in: path
required: true
type: string
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
- name: thumbprint
in: path
required: true
type: string
description: The thumbprint of the Certificate to get.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Certificate.
schema:
$ref: '#/definitions/Certificate'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/tasks/{taskId}/files/{filePath}:
delete:
tags:
- Files
operationId: microsoftAzureFileDeletefromtask
x-ms-examples:
File delete from task:
$ref: ./examples/FileDeleteFromTask.json
summary: >-
Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job that contains the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task whose file you want to delete.
- name: filePath
in: path
required: true
type: string
description: The path to the Task file or directory that you want to delete.
- name: recursive
in: query
required: false
type: boolean
description: >-
Whether to delete children of a directory. If the filePath parameter
represents a directory instead of a file, you can set recursive to
true to delete the directory and all of the files and subdirectories
in it. If recursive is false then the directory must be empty or
deletion will fail.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
get:
tags:
- Files
operationId: microsoftAzureFileGetfromtask
x-ms-examples:
Get File From Task:
$ref: ./examples/FileGetFromTask.json
description: Returns the content of the specified Task file.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job that contains the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task whose file you want to retrieve.
- name: filePath
in: path
required: true
type: string
description: The path to the Task file that you want to get the content of.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-range
in: header
required: false
type: string
description: >-
The byte range to be retrieved. The default is to retrieve the
entire file. The format is bytes=startRange-endRange.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
produces:
- application/json
- application/octet-stream
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
ocp-creation-time:
description: The file creation time.
type: string
format: date-time-rfc1123
ocp-batch-file-isdirectory:
description: Whether the object represents a directory.
type: boolean
ocp-batch-file-url:
description: The URL of the file.
type: string
ocp-batch-file-mode:
description: The file mode attribute in octal format.
type: string
Content-Type:
description: The content type of the file.
type: string
Content-Length:
description: The length of the file.
type: integer
format: int64
description: A response containing the file content.
schema:
type: object
format: file
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath
head:
tags:
- Files
operationId: microsoftAzureFileGetpropertiesfromtask
x-ms-examples:
File get properties from task:
$ref: ./examples/FileGetPropertiesFromTask.json
description: Gets the properties of the specified Task file.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job that contains the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task whose file you want to get the properties of.
- name: filePath
in: path
required: true
type: string
description: The path to the Task file that you want to get the properties of.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
ocp-creation-time:
description: The file creation time.
type: string
format: date-time-rfc1123
ocp-batch-file-isdirectory:
description: Whether the object represents a directory.
type: boolean
ocp-batch-file-url:
description: The URL of the file.
type: string
ocp-batch-file-mode:
description: The file mode attribute in octal format.
type: string
Content-Type:
description: The content type of the file.
type: string
Content-Length:
description: The length of the file.
type: integer
format: int64
description: A response containing the file properties.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath
/pools/{poolId}/nodes/{nodeId}/files/{filePath}:
delete:
tags:
- Files
operationId: microsoftAzureFileDeletefromcomputenode
x-ms-examples:
File delete from node:
$ref: ./examples/FileDeleteFromNode.json
summary: 'Microsoft Azure Deletes The Specified File From The Compute Node'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node from which you want to delete the file.
- name: filePath
in: path
required: true
type: string
description: The path to the file or directory that you want to delete.
- name: recursive
in: query
required: false
type: boolean
description: >-
Whether to delete children of a directory. If the filePath parameter
represents a directory instead of a file, you can set recursive to
true to delete the directory and all of the files and subdirectories
in it. If recursive is false then the directory must be empty or
deletion will fail.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
get:
tags:
- Files
operationId: microsoftAzureFileGetfromcomputenode
x-ms-examples:
Get File From Compute Node:
$ref: ./examples/FileGetFromNode.json
description: Returns the content of the specified Compute Node file.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that contains the file.
- name: filePath
in: path
required: true
type: string
description: >-
The path to the Compute Node file that you want to get the content
of.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-range
in: header
required: false
type: string
description: >-
The byte range to be retrieved. The default is to retrieve the
entire file. The format is bytes=startRange-endRange.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
produces:
- application/json
- application/octet-stream
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
ocp-creation-time:
description: The file creation time.
type: string
format: date-time-rfc1123
ocp-batch-file-isdirectory:
description: Whether the object represents a directory.
type: boolean
ocp-batch-file-url:
description: The URL of the file.
type: string
ocp-batch-file-mode:
description: The file mode attribute in octal format.
type: string
Content-Type:
description: The content type of the file.
type: string
Content-Length:
description: The length of the file.
type: integer
format: int64
description: The file content.
schema:
type: object
format: file
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath
head:
tags:
- Files
operationId: microsoftAzureFileGetpropertiesfromcomputenode
x-ms-examples:
File get properties from node:
$ref: ./examples/FileGetPropertiesFromNode.json
description: Gets the properties of the specified Compute Node file.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that contains the file.
- name: filePath
in: path
required: true
type: string
description: >-
The path to the Compute Node file that you want to get the
properties of.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
ocp-creation-time:
description: The file creation time.
type: string
format: date-time-rfc1123
ocp-batch-file-isdirectory:
description: Whether the object represents a directory.
type: boolean
ocp-batch-file-url:
description: The URL of the file.
type: string
ocp-batch-file-mode:
description: The file mode attribute in octal format.
type: string
Content-Type:
description: The content type of the file.
type: string
Content-Length:
description: The length of the file.
type: integer
format: int64
description: A response containing the file properties.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath
/jobs/{jobId}/tasks/{taskId}/files:
get:
tags:
- Files
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureFileListfromtask
x-ms-examples:
File list from task:
$ref: ./examples/FileListFromTask.json
summary: 'Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node'
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job that contains the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task whose files you want to list.
- name: $filter
in: query
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: recursive
in: query
required: false
type: boolean
description: >-
Whether to list children of the Task directory. This parameter can
be used in combination with the filter parameter to list specific
type of files.
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 files can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of files.
schema:
$ref: '#/definitions/NodeFileListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}/nodes/{nodeId}/files:
get:
tags:
- Files
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureFileListfromcomputenode
x-ms-examples:
File list from node:
$ref: ./examples/FileListFromNode.json
summary: >-
Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node whose files you want to list.
- name: $filter
in: query
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: recursive
in: query
required: false
type: boolean
description: Whether to list children of a directory.
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 files can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of files.
schema:
$ref: '#/definitions/NodeFileListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobschedules/{jobScheduleId}:
head:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleExists
x-ms-examples:
Check Job Schedule Exists:
$ref: ./examples/JobScheduleExists.json
summary: 'Microsoft Azure Checks The Specified Job Schedule Exists'
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule which you want to check.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: >-
A response containing headers related to the Job Schedule, if it
exists.
'404':
description: The Job Schedule does not exist.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
delete:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleDelete
x-ms-examples:
JobSchedule delete:
$ref: ./examples/JobScheduleDelete.json
summary: 'Microsoft Azure Deletes A Job Schedule From The Specified Account'
description: >-
When you delete a Job Schedule, this also deletes all Jobs and Tasks
under that schedule. When Tasks are deleted, all the files in their
working directories on the Compute Nodes are also deleted (the retention
period is ignored). The Job Schedule statistics are no longer accessible
once the Job Schedule is deleted, though they are still counted towards
Account lifetime statistics.
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to delete.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleGet
x-ms-examples:
JobSchedule get:
$ref: ./examples/JobScheduleGet.json
description: Gets information about the specified Job Schedule.
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to get.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Job Schedule.
schema:
$ref: '#/definitions/CloudJobSchedule'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Jobschedules Jobscheduleid
patch:
tags:
- JobSchedules
operationId: microsoftAzureJobschedulePatch
x-ms-examples:
JobSchedule patch:
$ref: ./examples/JobSchedulePatch.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Job Schedule'
description: >-
This replaces only the Job Schedule properties specified in the request.
For example, if the schedule property is not specified with this
request, then the Batch service will keep the existing schedule. Changes
to a Job Schedule only impact Jobs created by the schedule after the
update has taken place; currently running Jobs are unaffected.
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to update.
- name: jobSchedulePatchParameter
in: body
required: true
schema:
$ref: '#/definitions/JobSchedulePatchParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
put:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleUpdate
x-ms-examples:
JobSchedule update:
$ref: ./examples/JobScheduleUpdate.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Job Schedule'
description: >-
This fully replaces all the updatable properties of the Job Schedule.
For example, if the schedule property is not specified with this
request, then the Batch service will remove the existing schedule.
Changes to a Job Schedule only impact Jobs created by the schedule after
the update has taken place; currently running Jobs are unaffected.
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to update.
- name: jobScheduleUpdateParameter
in: body
required: true
schema:
$ref: '#/definitions/JobScheduleUpdateParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobschedules/{jobScheduleId}/disable:
post:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleDisable
x-ms-examples:
JobSchedule disable:
$ref: ./examples/JobScheduleDisable.json
summary: 'Microsoft Azure Disables A Job Schedule'
description: No new Jobs will be created until the Job Schedule is enabled again.
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to disable.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobschedules/{jobScheduleId}/enable:
post:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleEnable
x-ms-examples:
JobSchedule enable:
$ref: ./examples/JobScheduleEnable.json
summary: 'Microsoft Azure Enables A Job Schedule'
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to enable.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobschedules/{jobScheduleId}/terminate:
post:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleTerminate
x-ms-examples:
JobSchedule terminate:
$ref: ./examples/JobScheduleTerminate.json
summary: 'Microsoft Azure Terminates A Job Schedule'
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: The ID of the Job Schedule to terminates.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobschedules:
post:
tags:
- JobSchedules
operationId: microsoftAzureJobscheduleAdd
x-ms-examples:
Add a basic JobSchedule:
$ref: ./examples/JobScheduleAdd_Basic.json
Add a complex JobScheduleAdd:
$ref: ./examples/JobScheduleAdd_Complex.json
summary: 'Microsoft Azure Adds A Job Schedule To The Specified Account'
x-ms-request-id: request-id
parameters:
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: cloudJobSchedule
in: body
description: The Job Schedule to be added.
required: true
schema:
$ref: '#/definitions/JobScheduleAddParameter'
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
get:
tags:
- JobSchedules
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureJobscheduleList
x-ms-examples:
JobSchedule list:
$ref: ./examples/JobScheduleList.json
summary: 'Microsoft Azure Lists All Of The Job Schedules In The Specified Account'
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Job Schedules can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Job Schedules.
schema:
$ref: '#/definitions/CloudJobScheduleListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobs/{jobId}:
delete:
tags:
- Jobs
operationId: microsoftAzureJobDelete
x-ms-examples:
Delete Job:
$ref: ./examples/JobDelete.json
summary: 'Microsoft Azure Deletes A Job'
description: >-
Deleting a Job also deletes all Tasks that are part of that Job, and all
Job statistics. This also overrides the retention period for Task data;
that is, if the Job contains Tasks which are still retained on Compute
Nodes, the Batch services deletes those Tasks' working directories and
all their contents. When a Delete Job request is received, the Batch
service sets the Job to the deleting state. All update operations on a
Job that is in deleting state will fail with status code 409 (Conflict),
with additional information indicating that the Job is being deleted.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to delete.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- Jobs
operationId: microsoftAzureJobGet
x-ms-examples:
Job get:
$ref: ./examples/JobGet.json
summary: 'Microsoft Azure Gets Information About The Specified Job'
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Job.
schema:
$ref: '#/definitions/CloudJob'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
patch:
tags:
- Jobs
operationId: microsoftAzureJobPatch
x-ms-examples:
Job patch:
$ref: ./examples/JobPatch.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Job'
description: >-
This replaces only the Job properties specified in the request. For
example, if the Job has constraints, and a request does not specify the
constraints element, then the Job keeps the existing constraints.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job whose properties you want to update.
- name: jobPatchParameter
in: body
required: true
schema:
$ref: '#/definitions/JobPatchParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
put:
tags:
- Jobs
operationId: microsoftAzureJobUpdate
x-ms-examples:
Job update:
$ref: ./examples/JobUpdate.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Job'
description: >-
This fully replaces all the updatable properties of the Job. For
example, if the Job has constraints associated with it and if
constraints is not specified with this request, then the Batch service
will remove the existing constraints.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job whose properties you want to update.
- name: jobUpdateParameter
in: body
required: true
schema:
$ref: '#/definitions/JobUpdateParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/disable:
post:
tags:
- Jobs
operationId: microsoftAzureJobDisable
x-ms-examples:
Job disable:
$ref: ./examples/JobDisable.json
summary: 'Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running'
description: >-
The Batch Service immediately moves the Job to the disabling state.
Batch then uses the disableTasks parameter to determine what to do with
the currently running Tasks of the Job. The Job remains in the disabling
state until the disable operation is completed and all Tasks have been
dealt with according to the disableTasks option; the Job then moves to
the disabled state. No new Tasks are started under the Job until it
moves back to active state. If you try to disable a Job that is in any
state other than active, disabling, or disabled, the request fails with
status code 409.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to disable.
- name: jobDisableParameter
in: body
required: true
schema:
$ref: '#/definitions/JobDisableParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/enable:
post:
tags:
- Jobs
operationId: microsoftAzureJobEnable
x-ms-examples:
Job enable:
$ref: ./examples/JobEnable.json
summary: 'Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run'
description: >-
When you call this API, the Batch service sets a disabled Job to the
enabling state. After the this operation is completed, the Job moves to
the active state, and scheduling of new Tasks under the Job resumes. The
Batch service does not allow a Task to remain in the active state for
more than 180 days. Therefore, if you enable a Job containing active
Tasks which were added more than 180 days ago, those Tasks will not run.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to enable.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/terminate:
post:
tags:
- Jobs
operationId: microsoftAzureJobTerminate
x-ms-examples:
Job terminate:
$ref: ./examples/JobTerminate.json
summary: 'Microsoft Azure Terminates The Specified Job, Marking It As Completed'
description: >-
When a Terminate Job request is received, the Batch service sets the Job
to the terminating state. The Batch service then terminates any running
Tasks associated with the Job and runs any required Job release Tasks.
Then the Job moves into the completed state. If there are any Tasks in
the Job in the active state, they will remain in the active state. Once
a Job is terminated, new Tasks cannot be added and any remaining active
Tasks will not be scheduled.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to terminate.
- name: jobTerminateParameter
in: body
required: false
schema:
$ref: '#/definitions/JobTerminateParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs:
post:
tags:
- Jobs
operationId: microsoftAzureJobAdd
x-ms-examples:
Add a basic job:
$ref: ./examples/JobAdd_Basic.json
Add a complex job:
$ref: ./examples/JobAdd_Complex.json
summary: 'Microsoft Azure Adds A Job To The Specified Account'
description: >-
The Batch service supports two ways to control the work done as part of
a Job. In the first approach, the user specifies a Job Manager Task. The
Batch service launches this Task when it is ready to start the Job. The
Job Manager Task controls all other Tasks that run under this Job, by
using the Task APIs. In the second approach, the user directly controls
the execution of Tasks under an active Job, by using the Task APIs. Also
note: when naming Jobs, avoid including sensitive information such as
user names or secret project names. This information may appear in
telemetry logs accessible to Microsoft Support engineers.
x-ms-request-id: request-id
parameters:
- name: job
in: body
description: The Job to be added.
required: true
schema:
$ref: '#/definitions/JobAddParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- Jobs
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureJobList
x-ms-examples:
Job list:
$ref: ./examples/JobList.json
summary: 'Microsoft Azure Lists All Of The Jobs In The Specified Account'
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Jobs can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Jobs.
schema:
$ref: '#/definitions/CloudJobListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobschedules/{jobScheduleId}/jobs:
get:
tags:
- Jobs
x-ms-pageable:
nextLinkName: odata.nextLink
x-ms-examples:
List Job Under Job Schedule:
$ref: ./examples/JobListFromJobSchedule.json
operationId: microsoftAzureJobListfromjobschedule
summary: 'Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule'
x-ms-request-id: request-id
parameters:
- name: jobScheduleId
in: path
required: true
type: string
description: >-
The ID of the Job Schedule from which you want to get a list of
Jobs.
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Jobs can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Jobs.
schema:
$ref: '#/definitions/CloudJobListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/jobs/{jobId}/jobpreparationandreleasetaskstatus:
get:
tags:
- Jobs
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureJobListpreparationandreleasetaskstatus
x-ms-examples:
Job list preparation and release task status:
$ref: ./examples/JobListPreparationAndReleaseTaskStatus.json
summary: >-
Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The Specified Job Across The Compute Nodes Where The Job Has Run
description: >-
This API returns the Job Preparation and Job Release Task status on all
Compute Nodes that have run the Job Preparation or Job Release Task.
This includes Compute Nodes which have since been removed from the Pool.
If this API is invoked on a Job which has no Job Preparation or Job
Release Task, the Batch service returns HTTP status code 409 (Conflict)
with an error code of JobPreparationTaskNotSpecified.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job.
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Tasks can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: >-
A response containing a list of Job Preparation and Job Release Task
statuses.
schema:
$ref: '#/definitions/CloudJobListPreparationAndReleaseTaskStatusResult'
default:
description: >-
The error from the Batch service. If this API is invoked on a Job
which has no Job Preparation or Job Release Task, the Batch service
returns HTTP status code 409.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/taskcounts:
get:
tags:
- Jobs
operationId: microsoftAzureJobGettaskcounts
x-ms-examples:
Job get task counts:
$ref: ./examples/JobGetTaskCounts.json
summary: 'Microsoft Azure Gets The Task Counts For The Specified Job'
description: >-
Task counts provide a count of the Tasks by active, running or completed
Task state, and a count of Tasks which succeeded or failed. Tasks in the
preparing state are counted as running. Note that the numbers returned
may not always be up to date. If you need exact task counts, use a list
query.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
description: A response containing the Task counts for the specified Job.
schema:
$ref: '#/definitions/TaskCountsResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools:
post:
tags:
- Pools
operationId: microsoftAzurePoolAdd
x-ms-examples:
Add a simple pool with resourceTags:
$ref: ./examples/PoolAdd_ResourceTags.json
Add a CloudServiceConfiguration pool:
$ref: ./examples/PoolAdd_CloudServiceConfiguration.json
Add a VirtualMachineConfiguration pool:
$ref: ./examples/PoolAdd_VirtualMachineConfiguration.json
Add a VirtualMachineConfiguration pool with containers:
$ref: ./examples/PoolAdd_VirtualMachineConfigurationWithContainers.json
Add a VirtualMachineConfiguration pool with extensions:
$ref: ./examples/PoolAdd_VirtualMachineConfigurationWithExtensions.json
Add a pool with mount drive specified:
$ref: ./examples/PoolAdd_MountConfiguration.json
Add a pool with accelerated networking:
$ref: ./examples/PoolAdd_AcceleratedNetworking.json
Add a pool with SecurityProfile:
$ref: ./examples/PoolAdd_SecurityProfile.json
Add a pool with UpgradePolicy:
$ref: ./examples/PoolAdd_UpgradePolicy.json
Add a VirtualMachineConfiguration pool with ServiceArtifactReference:
$ref: >-
./examples/PoolAdd_VirtualMachineConfigurationWithServiceArtifactReference.json
Add a VirtualMachineConfiguration pool with OS disk:
$ref: ./examples/PoolAdd_OSDisk.json
summary: 'Microsoft Azure Adds A Pool To The Specified Account'
description: >-
When naming Pools, avoid including sensitive information such as user
names or secret project names. This information may appear in telemetry
logs accessible to Microsoft Support engineers.
x-ms-request-id: request-id
parameters:
- name: pool
in: body
description: The Pool to be added.
required: true
schema:
$ref: '#/definitions/PoolAddParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- Pools
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzurePoolList
x-ms-examples:
Pool list:
$ref: ./examples/PoolList_Basic.json
summary: 'Microsoft Azure Lists All Of The Pools In The Specified Account'
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Pools can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Pools.
schema:
$ref: '#/definitions/CloudPoolListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}:
delete:
tags:
- Pools
operationId: microsoftAzurePoolDelete
x-ms-examples:
Pool delete:
$ref: ./examples/PoolDelete.json
summary: 'Microsoft Azure Deletes A Pool From The Specified Account'
description: >-
When you request that a Pool be deleted, the following actions occur:
the Pool state is set to deleting; any ongoing resize operation on the
Pool are stopped; the Batch service starts resizing the Pool to zero
Compute Nodes; any Tasks running on existing Compute Nodes are
terminated and requeued (as if a resize Pool operation had been
requested with the default requeue option); finally, the Pool is removed
from the system. Because running Tasks are requeued, the user can rerun
these Tasks by updating their Job to target a different Pool. The Tasks
can then run on the new Pool. If you want to override the requeue
behavior, then you should call resize Pool explicitly to shrink the Pool
to zero size before deleting the Pool. If you call an Update, Patch or
Delete API on a Pool in the deleting state, it will fail with HTTP
status code 409 with error code PoolBeingDeleted.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to delete.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
head:
tags:
- Pools
operationId: microsoftAzurePoolExists
x-ms-examples:
Check Pool Exists:
$ref: ./examples/PoolExists.json
description: Gets basic properties of a Pool.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to get.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing headers related to the Pool, if it exists.
'404':
description: The Pool does not exist.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Head Pools Poolid
get:
tags:
- Pools
operationId: microsoftAzurePoolGet
x-ms-examples:
Pool get:
$ref: ./examples/PoolGet_Basic.json
Get a VirtualMachineConfiguration pool with extensions:
$ref: ./examples/PoolGet_VirtualMachineConfigurationWithExtensions.json
Get a pool with AcceleratedNetworking:
$ref: ./examples/PoolGet_AcceleratedNetworking.json
Get a VirtualMachineConfiguration pool with SecurityProfile:
$ref: ./examples/PoolGet_SecurityProfile.json
Get a VirtualMachineConfiguration pool with UpgradePolicy:
$ref: ./examples/PoolGet_UpgradePolicy.json
Get a VirtualMachineConfiguration pool with ServiceArtifactReference:
$ref: >-
./examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json
Add a VirtualMachineConfiguration pool with OS disk:
$ref: ./examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json
description: Gets information about the specified Pool.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to get.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Pool.
schema:
$ref: '#/definitions/CloudPool'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Pools Poolid
patch:
tags:
- Pools
operationId: microsoftAzurePoolPatch
x-ms-examples:
Patch the Pool:
$ref: ./examples/PoolPatch.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Pool'
description: >-
This only replaces the Pool properties specified in the request. For
example, if the Pool has a StartTask associated with it, and a request
does not specify a StartTask element, then the Pool keeps the existing
StartTask.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to update.
- name: poolPatchParameter
in: body
required: true
schema:
$ref: '#/definitions/PoolPatchParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/disableautoscale:
post:
tags:
- Pools
operationId: microsoftAzurePoolDisableautoscale
x-ms-examples:
Disable pool autoscale:
$ref: ./examples/PoolDisableAutoScale.json
summary: 'Microsoft Azure Disables Automatic Scaling For A Pool'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool on which to disable automatic scaling.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}/enableautoscale:
post:
tags:
- Pools
operationId: microsoftAzurePoolEnableautoscale
x-ms-examples:
Pool enable autoscale:
$ref: ./examples/PoolEnableAutoscale.json
summary: 'Microsoft Azure Enables Automatic Scaling For A Pool'
description: >-
You cannot enable automatic scaling on a Pool if a resize operation is
in progress on the Pool. If automatic scaling of the Pool is currently
disabled, you must specify a valid autoscale formula as part of the
request. If automatic scaling of the Pool is already enabled, you may
specify a new autoscale formula and/or a new evaluation interval. You
cannot call this API for the same Pool more than once every 30 seconds.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool on which to enable automatic scaling.
- name: poolEnableAutoScaleParameter
in: body
required: true
schema:
$ref: '#/definitions/PoolEnableAutoScaleParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/evaluateautoscale:
post:
tags:
- Pools
operationId: microsoftAzurePoolEvaluateautoscale
x-ms-examples:
Pool evaluate autoscale:
$ref: ./examples/PoolEvaluateAutoscale.json
summary: 'Microsoft Azure Gets The Result Of Evaluating An Automatic Scaling Formula On The Pool'
description: >-
This API is primarily for validating an autoscale formula, as it simply
returns the result without applying the formula to the Pool. The Pool
must have auto scaling enabled in order to evaluate a formula.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: >-
The ID of the Pool on which to evaluate the automatic scaling
formula.
- name: poolEvaluateAutoScaleParameter
in: body
required: true
schema:
$ref: '#/definitions/PoolEvaluateAutoScaleParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: A response containing the results of the autoscale evaluation.
schema:
$ref: '#/definitions/AutoScaleRun'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/resize:
post:
tags:
- Pools
operationId: microsoftAzurePoolResize
x-ms-examples:
Pool resize:
$ref: ./examples/PoolResize.json
summary: 'Microsoft Azure Changes The Number Of Compute Nodes That Are Assigned To A Pool'
description: >-
You can only resize a Pool when its allocation state is steady. If the
Pool is already resizing, the request fails with status code 409. When
you resize a Pool, the Pool's allocation state changes from steady to
resizing. You cannot resize Pools which are configured for automatic
scaling. If you try to do this, the Batch service returns an error 409.
If you resize a Pool downwards, the Batch service chooses which Compute
Nodes to remove. To remove specific Compute Nodes, use the Pool remove
Compute Nodes API instead.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to resize.
- name: poolResizeParameter
in: body
required: true
schema:
$ref: '#/definitions/PoolResizeParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/stopresize:
post:
tags:
- Pools
operationId: microsoftAzurePoolStopresize
x-ms-examples:
Pool stop resize:
$ref: ./examples/PoolStopResize.json
summary: 'Microsoft Azure Stops An Ongoing Resize Operation On The Pool'
description: >-
This does not restore the Pool to its previous state before the resize
operation: it only stops any further changes being made, and the Pool
maintains its current state. After stopping, the Pool stabilizes at the
number of Compute Nodes it was at when the stop operation was done.
During the stop operation, the Pool allocation state changes first to
stopping and then to steady. A resize operation need not be an explicit
resize Pool request; this API can also be used to halt the initial
sizing of the Pool when it is created.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool whose resizing you want to stop.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: >-
The error from the Batch service. If you call this API on a Pool
which is not in the resizing state, the request fails with HTTP
status code 409.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/updateproperties:
post:
tags:
- Pools
operationId: microsoftAzurePoolUpdateproperties
x-ms-examples:
Pool update:
$ref: ./examples/PoolUpdate.json
summary: 'Microsoft Azure Updates The Properties Of The Specified Pool'
description: >-
This fully replaces all the updatable properties of the Pool. For
example, if the Pool has a StartTask associated with it and if StartTask
is not specified with this request, then the Batch service will remove
the existing StartTask.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool to update.
- name: poolUpdatePropertiesParameter
in: body
required: true
schema:
$ref: '#/definitions/PoolUpdatePropertiesParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/removenodes:
post:
tags:
- ComputeNodes
operationId: microsoftAzurePoolRemovenodes
x-ms-examples:
Pool remove nodes:
$ref: ./examples/PoolRemoveNodes.json
summary: 'Microsoft Azure Removes Compute Nodes From The Specified Pool'
description: >-
This operation can only run when the allocation state of the Pool is
steady. When this operation runs, the allocation state changes from
steady to resizing. Each request may remove up to 100 nodes.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool from which you want to remove Compute Nodes.
- name: nodeRemoveParameter
in: body
required: true
schema:
$ref: '#/definitions/NodeRemoveParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/tasks:
post:
tags:
- Tasks
operationId: microsoftAzureTaskAdd
x-ms-examples:
Add a basic task:
$ref: ./examples/TaskAdd_Basic.json
Add a task with exit conditions:
$ref: ./examples/TaskAdd_ExitConditions.json
Add a task with container settings:
$ref: ./examples/TaskAdd_ContainerSettings.json
Add a task with extra slot requirement:
$ref: ./examples/TaskAdd_RequiredSlots.json
summary: 'Microsoft Azure Adds A Task To The Specified Job'
description: >-
The maximum lifetime of a Task from addition to completion is 180 days.
If a Task has not completed within 180 days of being added it will be
terminated by the Batch service and left in whatever state it was in at
that time.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to which the Task is to be added.
- name: task
in: body
description: The Task to be added.
required: true
schema:
$ref: '#/definitions/TaskAddParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- Tasks
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureTaskList
x-ms-examples:
Task list:
$ref: ./examples/TaskList.json
summary: 'Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job'
description: >-
For multi-instance Tasks, information such as affinityId, executionInfo
and nodeInfo refer to the primary Task. Use the list subtasks API to
retrieve information about subtasks.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job.
- name: $filter
in: query
required: false
type: string
description: >-
An OData $filter clause. For more information on constructing this
filter, see
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Tasks can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Tasks.
schema:
$ref: '#/definitions/CloudTaskListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/addtaskcollection:
post:
tags:
- Tasks
operationId: microsoftAzureTaskAddcollection
x-ms-examples:
Add a basic collection of tasks:
$ref: ./examples/TaskAddCollection_Basic.json
Add a complex collection of tasks:
$ref: ./examples/TaskAddCollection_Complex.json
summary: 'Microsoft Azure Adds A Collection Of Tasks To The Specified Job'
description: >-
Note that each Task must have a unique ID. The Batch service may not
return the results for each Task in the same order the Tasks were
submitted in this request. If the server times out or the connection is
closed during the request, the request may have been partially or fully
processed, or not at all. In such cases, the user should re-issue the
request. Note that it is up to the user to correctly handle failures
when re-issuing a request. For example, you should use the same Task IDs
during a retry so that if the prior operation succeeded, the retry will
not create extra Tasks unexpectedly. If the response contains any Tasks
which failed to add, a client can retry the request. In a retry, it is
most efficient to resubmit only Tasks that failed to add, and to omit
Tasks that were successfully added on the first attempt. The maximum
lifetime of a Task from addition to completion is 180 days. If a Task
has not completed within 180 days of being added it will be terminated
by the Batch service and left in whatever state it was in at that time.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job to which the Task collection is to be added.
- name: taskCollection
in: body
description: The Tasks to be added.
required: true
schema:
$ref: '#/definitions/TaskAddCollectionParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 120
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 2 minutes. If the value is larger than
120, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
schema:
$ref: '#/definitions/TaskAddCollectionResult'
description: >-
A response containing the results of the add Task collection
operation.
default:
description: Unexpected error
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/tasks/{taskId}:
delete:
tags:
- Tasks
operationId: microsoftAzureTaskDelete
x-ms-examples:
Task delete:
$ref: ./examples/TaskDelete.json
summary: 'Microsoft Azure Deletes A Task From The Specified Job'
description: >-
When a Task is deleted, all of the files in its directory on the Compute
Node where it ran are also deleted (regardless of the retention time).
For multi-instance Tasks, the delete Task operation applies
synchronously to the primary task; subtasks and their files are then
deleted asynchronously in the background.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job from which to delete the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task to delete.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
tags:
- Tasks
operationId: microsoftAzureTaskGet
x-ms-examples:
Task get:
$ref: ./examples/TaskGet.json
summary: 'Microsoft Azure Gets Information About The Specified Task'
description: >-
For multi-instance Tasks, information such as affinityId, executionInfo
and nodeInfo refer to the primary Task. Use the list subtasks API to
retrieve information about subtasks.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job that contains the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task to get information about.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: $expand
in: query
required: false
type: string
description: An OData $expand clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: A response containing the Task.
schema:
$ref: '#/definitions/CloudTask'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
put:
tags:
- Tasks
operationId: microsoftAzureTaskUpdate
x-ms-examples:
Task update:
$ref: ./examples/TaskUpdate.json
description: Updates the properties of the specified Task.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job containing the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task to update.
- name: taskUpdateParameter
in: body
required: true
schema:
$ref: '#/definitions/TaskUpdateParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Put Jobs Jobid Tasks Taskid
/jobs/{jobId}/tasks/{taskId}/subtasksinfo:
get:
tags:
- Tasks
operationId: microsoftAzureTaskListsubtasks
x-ms-examples:
Task list subtasks:
$ref: ./examples/TaskListSubtasks.json
summary: >-
Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance Task
description: >-
If the Task is not a multi-instance Task then this returns an empty
collection.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of subtasks.
schema:
$ref: '#/definitions/CloudTaskListSubtasksResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/tasks/{taskId}/terminate:
post:
tags:
- Tasks
operationId: microsoftAzureTaskTerminate
x-ms-examples:
Task terminate:
$ref: ./examples/TaskTerminate.json
summary: 'Microsoft Azure Terminates The Specified Task'
description: >-
When the Task has been terminated, it moves to the completed state. For
multi-instance Tasks, the terminate Task operation applies synchronously
to the primary task; subtasks are then terminated asynchronously in the
background.
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job containing the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task to terminate.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/jobs/{jobId}/tasks/{taskId}/reactivate:
post:
tags:
- Tasks
operationId: microsoftAzureTaskReactivate
x-ms-examples:
Task reactivate:
$ref: ./examples/TaskReactivate.json
summary: >-
Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been Exhausted
description: >-
Reactivation makes a Task eligible to be retried again up to its maximum
retry count. The Task's state is changed to active. As the Task is no
longer in the completed state, any previous exit code or failure
information is no longer available after reactivation. Each time a Task
is reactivated, its retry count is reset to 0. Reactivation will fail
for Tasks that are not completed or that previously completed
successfully (with an exit code of 0). Additionally, it will fail if the
Job has completed (or is terminating or deleting).
x-ms-request-id: request-id
parameters:
- name: jobId
in: path
required: true
type: string
description: The ID of the Job containing the Task.
- name: taskId
in: path
required: true
type: string
description: The ID of the Task to reactivate.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: If-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-None-Match
in: header
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Modified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: If-Unmodified-Since
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'204':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/users:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeAdduser
x-ms-examples:
Node add user:
$ref: ./examples/NodeAddUser.json
summary: 'Microsoft Azure Adds A User Account To The Specified Compute Node'
description: >-
You can add a user Account to a Compute Node only when it is in the idle
or running state.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the machine on which you want to create a user Account.
- name: user
in: body
description: The user Account to be created.
required: true
schema:
$ref: '#/definitions/ComputeNodeUser'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/users/{userName}:
delete:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeDeleteuser
x-ms-examples:
Node delete user:
$ref: ./examples/NodeDeleteUser.json
summary: 'Microsoft Azure Deletes A User Account From The Specified Compute Node'
description: >-
You can delete a user Account to a Compute Node only when it is in the
idle or running state.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the machine on which you want to delete a user Account.
- name: userName
in: path
required: true
type: string
description: The name of the user Account to delete.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
put:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeUpdateuser
x-ms-examples:
Node update user:
$ref: ./examples/NodeUpdateUser.json
summary: >-
Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node
description: >-
This operation replaces of all the updatable properties of the Account.
For example, if the expiryTime element is not specified, the current
value is replaced with the default value, not left unmodified. You can
update a user Account on a Compute Node only when it is in the idle or
running state.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the machine on which you want to update a user Account.
- name: userName
in: path
required: true
type: string
description: The name of the user Account to update.
- name: nodeUpdateUserParameter
in: body
required: true
schema:
$ref: '#/definitions/NodeUpdateUserParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}:
get:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeGet
x-ms-examples:
Node get:
$ref: ./examples/NodeGet_Basic.json
summary: 'Microsoft Azure Gets Information About The Specified Compute Node'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that you want to get information about.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Compute Node.
schema:
$ref: '#/definitions/ComputeNode'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}/nodes/{nodeId}/reboot:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeReboot
x-ms-examples:
Node reboot:
$ref: ./examples/NodeReboot.json
summary: 'Microsoft Azure Restarts The Specified Compute Node'
description: >-
You can restart a Compute Node only if it is in an idle or running
state.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that you want to restart.
- name: nodeRebootParameter
in: body
required: false
schema:
$ref: '#/definitions/NodeRebootParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/reimage:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeReimage
x-ms-examples:
Node reimage:
$ref: ./examples/NodeReimage.json
summary: 'Microsoft Azure Reinstalls The Operating System On The Specified Compute Node'
description: >-
You can reinstall the operating system on a Compute Node only if it is
in an idle or running state. This API can be invoked only on Pools
created with the cloud service configuration property.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that you want to restart.
- name: nodeReimageParameter
in: body
required: false
schema:
$ref: '#/definitions/NodeReimageParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'202':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/disablescheduling:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeDisablescheduling
x-ms-examples:
Node disable scheduling:
$ref: ./examples/NodeDisableScheduling.json
summary: 'Microsoft Azure Disables Task Scheduling On The Specified Compute Node'
description: >-
You can disable Task scheduling on a Compute Node only if its current
scheduling state is enabled.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: >-
The ID of the Compute Node on which you want to disable Task
scheduling.
- name: nodeDisableSchedulingParameter
in: body
required: false
schema:
$ref: '#/definitions/NodeDisableSchedulingParameter'
description: The parameters for the request.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/enablescheduling:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeEnablescheduling
x-ms-examples:
Node enable scheduling:
$ref: ./examples/NodeEnableScheduling.json
summary: 'Microsoft Azure Enables Task Scheduling On The Specified Compute Node'
description: >-
You can enable Task scheduling on a Compute Node only if its current
scheduling state is disabled
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: >-
The ID of the Compute Node on which you want to enable Task
scheduling.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/remoteloginsettings:
get:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeGetremoteloginsettings
x-ms-examples:
Node get remote login settings:
$ref: ./examples/NodeGetRemoteLoginSettings.json
summary: 'Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node'
description: >-
Before you can remotely login to a Compute Node using the remote login
settings, you must create a user Account on the Compute Node. This API
can be invoked only on Pools created with the virtual machine
configuration property. For Pools created with a cloud service
configuration, see the GetRemoteDesktop API.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: >-
The ID of the Compute Node for which to obtain the remote login
settings.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the login settings.
schema:
$ref: '#/definitions/ComputeNodeGetRemoteLoginSettingsResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/rdp:
get:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeGetremotedesktop
x-ms-examples:
Get RDP file of the compute node:
$ref: ./examples/NodeGetRemoteDesktop.json
summary: 'Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node'
description: >-
Before you can access a Compute Node by using the RDP file, you must
create a user Account on the Compute Node. This API can only be invoked
on Pools created with a cloud service configuration. For Pools created
with a virtual machine configuration, see the GetRemoteLoginSettings
API.
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: >-
The ID of the Compute Node for which you want to get the Remote
Desktop Protocol file.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
produces:
- application/json
- application/octet-stream
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the RDP information.
schema:
type: object
format: file
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs:
post:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeUploadbatchservicelogs
summary: >-
Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure Blob Storage
description: >-
This is for gathering Azure Batch service log files in an automated
fashion from Compute Nodes if you are experiencing an error and wish to
escalate to Azure support. The Azure Batch service log files should be
shared with Azure support to aid in debugging issues with the Batch
service.
x-ms-examples:
Upload BatchService Logs:
$ref: ./examples/NodeUploadBatchServiceLogs.json
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: >-
The ID of the Compute Node from which you want to upload the Azure
Batch service log files.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- name: uploadBatchServiceLogsConfiguration
in: body
description: The Azure Batch service log files upload configuration.
required: true
schema:
$ref: '#/definitions/UploadBatchServiceLogsConfiguration'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
description: The request to the Batch service was successful.
schema:
$ref: '#/definitions/UploadBatchServiceLogsResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/pools/{poolId}/nodes:
get:
tags:
- ComputeNodes
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureComputenodeList
x-ms-examples:
Node list:
$ref: ./examples/NodeList.json
summary: 'Microsoft Azure Lists The Compute Nodes In The Specified Pool'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool from which you want to list Compute Nodes.
- name: $filter
in: query
required: false
type: string
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Compute Nodes can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Compute Nodes.
schema:
$ref: '#/definitions/ComputeNodeListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}:
get:
tags:
- ComputeNodes
operationId: microsoftAzureComputenodeextensionGet
x-ms-examples:
Get compute node extension:
$ref: ./examples/ComputeNodeExtensionGet.json
summary: 'Microsoft Azure Gets Information About The Specified Compute Node Extension'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains the Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that contains the extensions.
- name: extensionName
in: path
required: true
type: string
description: >-
The name of the of the Compute Node Extension that you want to get
information about.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the Compute Node Extension.
schema:
$ref: '#/definitions/NodeVMExtension'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/pools/{poolId}/nodes/{nodeId}/extensions:
get:
tags:
- ComputeNodes
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureComputenodeextensionList
x-ms-examples:
List compute node extensions:
$ref: ./examples/ComputeNodeExtensionList.json
summary: 'Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool'
x-ms-request-id: request-id
parameters:
- name: poolId
in: path
required: true
type: string
description: The ID of the Pool that contains Compute Node.
- name: nodeId
in: path
required: true
type: string
description: The ID of the Compute Node that you want to list extensions.
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Compute Nodes can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
description: >-
The maximum time that the server can spend processing the request,
in seconds. The default is 30 seconds. If the value is larger than
30, the default will be used instead.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
description: >-
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
description: >-
The time the request was issued. Client libraries typically set this
to the current system clock time; set it explicitly if you are
calling the REST API directly.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
description: >-
The client-request-id provided by the client during the request.
This will be returned only if the return-client-request-id
parameter was set to true.
type: string
format: uuid
request-id:
description: >-
A unique identifier for the request that was made to the Batch
service. If a request is consistently failing and you have
verified that the request is properly formulated, you may use
this value to report the error to Microsoft. In your report,
include the value of this request ID, the approximate time that
the request was made, the Batch Account against which the
request was made, and the region that Account resides in.
type: string
format: uuid
ETag:
description: >-
The ETag HTTP response header. This is an opaque string. You can
use it to detect whether the resource has changed between
requests. In particular, you can pass the ETag to one of the
If-Modified-Since, If-Unmodified-Since, If-Match or
If-None-Match headers.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Compute Nodes.
schema:
$ref: '#/definitions/NodeVMExtensionList'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
definitions:
PoolUsageMetrics:
type: object
properties:
poolId:
type: string
title: The ID of the Pool whose metrics are aggregated in this entry.
startTime:
type: string
format: date-time
title: The start time of the aggregation interval covered by this entry.
endTime:
type: string
format: date-time
title: The end time of the aggregation interval covered by this entry.
vmSize:
type: string
title: >-
The size of virtual machines in the Pool. All VMs in a Pool are the
same size.
description: >-
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).
totalCoreHours:
type: number
format: double
title: >-
The total core hours used in the Pool during this aggregation
interval.
required:
- poolId
- startTime
- endTime
- vmSize
- totalCoreHours
title: Usage metrics for a Pool across an aggregation interval.
PoolListUsageMetricsResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/PoolUsageMetrics'
title: The Pool usage metrics data.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of a listing the usage metrics for an Account.
ImageInformation:
type: object
properties:
nodeAgentSKUId:
type: string
title: The ID of the Compute Node agent SKU which the Image supports.
imageReference:
$ref: '#/definitions/ImageReference'
title: The reference to the Azure Virtual Machine's Marketplace Image.
osType:
type: string
title: The type of operating system (e.g. Windows or Linux) of the Image.
enum:
- linux
- windows
x-ms-enum:
name: OSType
modelAsString: false
values:
- value: linux
description: The Linux operating system.
- value: windows
description: The Windows operating system.
capabilities:
type: array
items:
type: string
title: The capabilities or features which the Image supports.
description: >-
Not every capability of the Image is listed. Capabilities in this list
are considered of special interest and are generally related to
integration with other features in the Azure Batch service.
batchSupportEndOfLife:
type: string
format: date-time
title: >-
The time when the Azure Batch service will stop accepting create Pool
requests for the Image.
verificationType:
type: string
title: >-
Whether the Azure Batch service actively verifies that the Image is
compatible with the associated Compute Node agent SKU.
enum:
- verified
- unverified
x-ms-enum:
name: VerificationType
modelAsString: false
values:
- value: verified
description: >-
The Image is guaranteed to be compatible with the associated
Compute Node agent SKU and all Batch features have been
confirmed to work as expected.
- value: unverified
description: >-
The associated Compute Node agent SKU should have binary
compatibility with the Image, but specific functionality has not
been verified.
required:
- imageReference
- verificationType
- osType
- nodeAgentSKUId
title: >-
A reference to the Azure Virtual Machines Marketplace Image and additional
information about the Image.
AuthenticationTokenSettings:
type: object
properties:
access:
type: array
items:
type: string
x-nullable: false
enum:
- job
x-ms-enum:
name: AccessScope
modelAsString: false
values:
- value: job
description: >-
Grants access to perform all operations on the Job containing
the Task.
title: The Batch resources to which the token grants access.
description: >-
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.
title: >-
The settings for an authentication token that the Task can use to perform
Batch service operations.
AccountListSupportedImagesResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ImageInformation'
title: The list of supported Virtual Machine Images.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the supported Virtual Machine Images.
UsageStatistics:
type: object
properties:
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
dedicatedCoreTime:
type: string
format: duration
title: >-
The aggregated wall-clock time of the dedicated Compute Node cores
being part of the Pool.
required:
- startTime
- lastUpdateTime
- dedicatedCoreTime
title: Statistics related to Pool usage information.
ResourceStatistics:
type: object
properties:
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
avgCPUPercentage:
type: number
format: double
title: >-
The average CPU usage across all Compute Nodes in the Pool (percentage
per node).
avgMemoryGiB:
type: number
format: double
title: The average memory usage in GiB across all Compute Nodes in the Pool.
peakMemoryGiB:
type: number
format: double
title: The peak memory usage in GiB across all Compute Nodes in the Pool.
avgDiskGiB:
type: number
format: double
title: >-
The average used disk space in GiB across all Compute Nodes in the
Pool.
peakDiskGiB:
type: number
format: double
title: The peak used disk space in GiB across all Compute Nodes in the Pool.
diskReadIOps:
type: integer
format: int64
title: >-
The total number of disk read operations across all Compute Nodes in
the Pool.
diskWriteIOps:
type: integer
format: int64
title: >-
The total number of disk write operations across all Compute Nodes in
the Pool.
diskReadGiB:
type: number
format: double
title: >-
The total amount of data in GiB of disk reads across all Compute Nodes
in the Pool.
diskWriteGiB:
type: number
format: double
title: >-
The total amount of data in GiB of disk writes across all Compute
Nodes in the Pool.
networkReadGiB:
type: number
format: double
title: >-
The total amount of data in GiB of network reads across all Compute
Nodes in the Pool.
networkWriteGiB:
type: number
format: double
title: >-
The total amount of data in GiB of network writes across all Compute
Nodes in the Pool.
required:
- startTime
- lastUpdateTime
- avgCPUPercentage
- avgMemoryGiB
- peakMemoryGiB
- avgDiskGiB
- peakDiskGiB
- diskReadIOps
- diskWriteIOps
- diskReadGiB
- diskWriteGiB
- networkReadGiB
- networkWriteGiB
title: Statistics related to resource consumption by Compute Nodes in a Pool.
PoolStatistics:
type: object
properties:
url:
type: string
title: The URL for the statistics.
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
usageStats:
$ref: '#/definitions/UsageStatistics'
title: >-
Statistics related to Pool usage, such as the amount of core-time
used.
resourceStats:
$ref: '#/definitions/ResourceStatistics'
title: >-
Statistics related to resource consumption by Compute Nodes in the
Pool.
required:
- url
- startTime
- lastUpdateTime
title: >-
Contains utilization and resource usage statistics for the lifetime of a
Pool.
JobStatistics:
type: object
properties:
url:
type: string
title: The URL of the statistics.
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
userCPUTime:
type: string
format: duration
title: >-
The total user mode CPU time (summed across all cores and all Compute
Nodes) consumed by all Tasks in the Job.
kernelCPUTime:
type: string
format: duration
title: >-
The total kernel mode CPU time (summed across all cores and all
Compute Nodes) consumed by all Tasks in the Job.
wallClockTime:
type: string
format: duration
title: The total wall clock time of all Tasks in the Job.
description: ' The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries.'
readIOps:
type: integer
format: int64
title: The total number of disk read operations made by all Tasks in the Job.
writeIOps:
type: integer
format: int64
title: >-
The total number of disk write operations made by all Tasks in the
Job.
readIOGiB:
type: number
format: double
title: >-
The total amount of data in GiB read from disk by all Tasks in the
Job.
writeIOGiB:
type: number
format: double
title: >-
The total amount of data in GiB written to disk by all Tasks in the
Job.
numSucceededTasks:
type: integer
format: int64
title: >-
The total number of Tasks successfully completed in the Job during the
given time range.
description: A Task completes successfully if it returns exit code 0.
numFailedTasks:
type: integer
format: int64
title: >-
The total number of Tasks in the Job that failed during the given time
range.
description: >-
A Task fails if it exhausts its maximum retry count without returning
exit code 0.
numTaskRetries:
type: integer
format: int64
title: >-
The total number of retries on all the Tasks in the Job during the
given time range.
waitTime:
type: string
format: duration
title: The total wait time of all Tasks in the Job.
description: >-
The wait time for a Task is defined as the elapsed time between the
creation of the Task and the start of Task execution. (If the Task is
retried due to failures, the wait time is the time to the most recent
Task execution.) This value is only reported in the Account lifetime
statistics; it is not included in the Job statistics.
required:
- url
- startTime
- lastUpdateTime
- userCPUTime
- kernelCPUTime
- wallClockTime
- readIOps
- writeIOps
- readIOGiB
- writeIOGiB
- numSucceededTasks
- numFailedTasks
- numTaskRetries
- waitTime
title: Resource usage statistics for a Job.
NameValuePair:
type: object
properties:
name:
type: string
title: The name in the name-value pair.
value:
type: string
title: The value in the name-value pair.
title: Represents a name-value pair.
DeleteCertificateError:
type: object
properties:
code:
type: string
title: >-
An identifier for the Certificate deletion error. Codes are invariant
and are intended to be consumed programmatically.
message:
type: string
title: >-
A message describing the Certificate deletion error, intended to be
suitable for display in a user interface.
values:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: >-
A list of additional error details related to the Certificate deletion
error.
description: >-
This list includes details such as the active Pools and Compute Nodes
referencing this Certificate. However, if a large number of resources
reference the Certificate, the list contains only about the first
hundred.
title: An error encountered by the Batch service when deleting a Certificate.
Certificate:
type: object
properties:
thumbprint:
type: string
title: >-
The X.509 thumbprint of the Certificate. This is a sequence of up to
40 hex digits.
thumbprintAlgorithm:
type: string
title: The algorithm used to derive the thumbprint.
url:
type: string
title: The URL of the Certificate.
state:
title: The current state of the Certificate.
$ref: '#/definitions/CertificateState'
stateTransitionTime:
type: string
format: date-time
title: The time at which the Certificate entered its current state.
previousState:
title: The previous state of the Certificate.
description: >-
This property is not set if the Certificate is in its initial active
state.
$ref: '#/definitions/CertificateState'
previousStateTransitionTime:
type: string
format: date-time
title: The time at which the Certificate entered its previous state.
description: >-
This property is not set if the Certificate is in its initial Active
state.
publicData:
type: string
title: The public part of the Certificate as a base-64 encoded .cer file.
deleteCertificateError:
$ref: '#/definitions/DeleteCertificateError'
title: >-
The error that occurred on the last attempt to delete this
Certificate.
description: >-
This property is set only if the Certificate is in the DeleteFailed
state.
description: >-
A Certificate that can be installed on Compute Nodes and can be used to
authenticate operations on the machine.
ApplicationPackageReference:
type: object
properties:
applicationId:
type: string
title: The ID of the application to deploy.
description: >-
When creating a pool, the package's application ID must be fully
qualified
(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version:
type: string
title: >-
The version of the application to deploy. If omitted, the default
version is deployed.
description: >-
If this is omitted on a Pool, and no default version is specified for
this application, the request fails with the error code
InvalidApplicationPackageReferences and HTTP status code 409. If this
is omitted on a Task, and no default version is specified for this
application, the Task fails with a pre-processing error.
required:
- applicationId
title: A reference to an Package to be deployed to Compute Nodes.
ApplicationSummary:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the application within the Account.
displayName:
type: string
title: The display name for the application.
versions:
type: array
title: The list of available versions of the application.
items:
type: string
required:
- id
- displayName
- versions
title: Contains information about an application in an Azure Batch Account.
CertificateAddParameter:
type: object
properties:
thumbprint:
type: string
title: >-
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).
thumbprintAlgorithm:
type: string
title: The algorithm used to derive the thumbprint. This must be sha1.
data:
type: string
title: >-
The base64-encoded contents of the Certificate. The maximum size is
10KB.
certificateFormat:
type: string
title: The format of the Certificate data.
enum:
- pfx
- cer
x-ms-enum:
name: CertificateFormat
modelAsString: false
values:
- value: pfx
description: >-
The Certificate is a PFX (PKCS#12) formatted Certificate or
Certificate chain.
- value: cer
description: The Certificate is a base64-encoded X.509 Certificate.
password:
type: string
title: The password to access the Certificate's private key.
description: This must be omitted if the Certificate format is cer.
required:
- thumbprint
- thumbprintAlgorithm
- data
title: >-
A Certificate that can be installed on Compute Nodes and can be used to
authenticate operations on the machine.
CertificateListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Certificate'
title: The list of Certificates.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Certificates in the Account.
FileProperties:
type: object
properties:
creationTime:
type: string
format: date-time
title: The file creation time.
description: The creation time is not returned for files on Linux Compute Nodes.
lastModified:
type: string
format: date-time
title: The time at which the file was last modified.
contentLength:
type: integer
format: int64
title: The length of the file.
contentType:
type: string
title: The content type of the file.
fileMode:
type: string
title: The file mode attribute in octal format.
description: The file mode is returned only for files on Linux Compute Nodes.
required:
- lastModified
- contentLength
title: The properties of a file on a Compute Node.
NodeFile:
type: object
properties:
name:
type: string
title: The file path.
url:
type: string
title: The URL of the file.
isDirectory:
type: boolean
title: Whether the object represents a directory.
properties:
$ref: '#/definitions/FileProperties'
title: The file properties.
title: Information about a file or directory on a Compute Node.
NodeFileListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/NodeFile'
title: The list of files.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: >-
The result of listing the files on a Compute Node, or the files associated
with a Task on a Compute Node.
Schedule:
type: object
properties:
doNotRunUntil:
type: string
format: date-time
title: >-
The earliest time at which any Job may be created under this Job
Schedule.
description: >-
If you do not specify a doNotRunUntil time, the schedule becomes ready
to create Jobs immediately.
doNotRunAfter:
type: string
format: date-time
title: >-
A time after which no Job will be created under this Job Schedule. The
schedule will move to the completed state as soon as this deadline is
past and there is no active Job under this Job Schedule.
description: >-
If you do not specify a doNotRunAfter time, and you are creating a
recurring Job Schedule, the Job Schedule will remain active until you
explicitly terminate it.
startWindow:
type: string
format: duration
title: >-
The time interval, starting from the time at which the schedule
indicates a Job should be created, within which a Job must be created.
description: >-
If a Job is not created within the startWindow interval, then the
'opportunity' is lost; no Job will be created until the next
recurrence of the schedule. If the schedule is recurring, and the
startWindow is longer than the recurrence interval, then this is
equivalent to an infinite startWindow, because the Job that is 'due'
in one recurrenceInterval is not carried forward into the next
recurrence interval. The default is infinite. The minimum value is 1
minute. If you specify a lower value, the Batch service rejects the
schedule with an error; if you are calling the REST API directly, the
HTTP status code is 400 (Bad Request).
recurrenceInterval:
type: string
format: duration
title: >-
The time interval between the start times of two successive Jobs under
the Job Schedule. A Job Schedule can have at most one active Job under
it at any given time.
description: >-
Because a Job Schedule can have at most one active Job under it at any
given time, if it is time to create a new Job under a Job Schedule,
but the previous Job is still running, the Batch service will not
create the new Job until the previous Job finishes. If the previous
Job does not finish within the startWindow period of the new
recurrenceInterval, then no new Job will be scheduled for that
interval. For recurring Jobs, you should normally specify a
jobManagerTask in the jobSpecification. If you do not use
jobManagerTask, you will need an external process to monitor when Jobs
are created, add Tasks to the Jobs and terminate the Jobs ready for
the next recurrence. The default is that the schedule does not recur:
one Job is created, within the startWindow after the doNotRunUntil
time, and the schedule is complete as soon as that Job finishes. The
minimum value is 1 minute. If you specify a lower value, the Batch
service rejects the schedule with an error; if you are calling the
REST API directly, the HTTP status code is 400 (Bad Request).
title: >-
The schedule according to which Jobs will be created. All times are fixed
respective to UTC and are not impacted by daylight saving time.
JobConstraints:
type: object
properties:
maxWallClockTime:
type: string
format: duration
title: >-
The maximum elapsed time that the Job may run, measured from the time
the Job is created.
description: >-
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.
maxTaskRetryCount:
type: integer
format: int32
title: >-
The maximum number of times each Task may be retried. The Batch
service retries a Task if its exit code is nonzero.
description: >-
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).
title: The execution constraints for a Job.
JobNetworkConfiguration:
type: object
properties:
subnetId:
type: string
title: >-
The ARM resource identifier of the virtual network subnet which
Compute Nodes running Tasks from the Job will join for the duration of
the Task. This will only work with a VirtualMachineConfiguration Pool.
description: >-
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 Compute Nodes which will run
Tasks from the Job. This can be up to the number of Compute Nodes in
the Pool. The 'MicrosoftAzureBatch' service principal must have the
'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC)
role for the specified VNet so that Azure Batch service can schedule
Tasks on the Nodes. This can be verified by checking if the specified
VNet has any associated Network Security Groups (NSG). If
communication to the Nodes in the specified subnet is denied by an
NSG, then the Batch service will set the state of the Compute Nodes to
unusable. This is of the form
/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
If the specified VNet has any associated Network Security Groups
(NSG), then a few reserved system ports must be enabled for inbound
communication from the Azure Batch service. 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. Port 443 is also
required to be open for outbound connections for communications to
Azure Storage. For more details see:
https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
externalDocs:
url: >-
https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor
description: Setting up RBAC for Azure Batch VNETs
required:
- subnetId
title: The network configuration for the Job.
TaskContainerSettings:
type: object
properties:
containerRunOptions:
type: string
title: Additional options to the container create command.
description: >-
These additional options are supplied as arguments to the "docker
create" command, in addition to those controlled by the Batch Service.
imageName:
type: string
title: The Image to use to create the container in which the Task will run.
description: >-
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.
registry:
$ref: '#/definitions/ContainerRegistry'
title: The private registry which contains the container Image.
description: This setting can be omitted if was already provided at Pool creation.
workingDirectory:
type: string
title: The location of the container Task working directory.
description: The default is 'taskWorkingDirectory'.
enum:
- taskWorkingDirectory
- containerImageDefault
x-ms-enum:
name: ContainerWorkingDirectory
modelAsString: false
values:
- value: taskWorkingDirectory
description: >-
Use the standard Batch service Task working directory, which
will contain the Task Resource Files populated by Batch.
- value: containerImageDefault
description: >-
Use the working directory defined in the container Image. Beware
that this directory will not contain the Resource Files
downloaded by Batch.
required:
- imageName
title: The container settings for a Task.
ResourceFile:
type: object
properties:
autoStorageContainerName:
type: string
title: The storage container name in the auto storage Account.
description: >-
The autoStorageContainerName, storageContainerUrl and httpUrl
properties are mutually exclusive and one of them must be specified.
storageContainerUrl:
type: string
title: The URL of the blob container within Azure Blob Storage.
description: >-
The autoStorageContainerName, storageContainerUrl and httpUrl
properties are mutually exclusive and one of them must be specified.
This URL must be readable and listable from compute nodes. There are
three ways to get such a URL for a container in Azure storage: include
a Shared Access Signature (SAS) granting read and list permissions on
the container, use a managed identity with read and list permissions,
or set the ACL for the container to allow public access.
httpUrl:
type: string
title: The URL of the file to download.
description: >-
The autoStorageContainerName, storageContainerUrl and httpUrl
properties are mutually exclusive and one of them must be specified.
If the URL points to Azure Blob Storage, it must be readable from
compute nodes. There are three ways to get such a URL for a blob in
Azure storage: include a Shared Access Signature (SAS) granting read
permissions on the blob, use a managed identity with read permission,
or set the ACL for the blob or its container to allow public access.
blobPrefix:
type: string
title: >-
The blob prefix to use when downloading blobs from an Azure Storage
container. Only the blobs whose names begin with the specified prefix
will be downloaded.
description: >-
The property is valid only when autoStorageContainerName or
storageContainerUrl is used. This prefix can be a partial filename or
a subdirectory. If a prefix is not specified, all the files in the
container will be downloaded.
filePath:
type: string
title: >-
The location on the Compute Node to which to download the file(s),
relative to the Task's working directory.
description: >-
If the httpUrl property is specified, the filePath is required and
describes the path which the file will be downloaded to, including the
filename. Otherwise, if the autoStorageContainerName or
storageContainerUrl property is specified, filePath is optional and is
the directory to download the files to. In the case where filePath is
used as a directory, any directory structure already associated with
the input data will be retained in full and appended to the specified
filePath directory. The specified relative path cannot break out of
the Task's working directory (for example by using '..').
fileMode:
type: string
title: The file permission mode attribute in octal format.
description: >-
This property applies only to files being downloaded to Linux Compute
Nodes. It will be ignored if it is specified for a resourceFile which
will be downloaded to a Windows Compute Node. If this property is not
specified for a Linux Compute Node, then a default value of 0770 is
applied to the file.
identityReference:
title: >-
The reference to the user assigned identity to use to access Azure
Blob Storage specified by storageContainerUrl or httpUrl
$ref: '#/definitions/ComputeNodeIdentityReference'
title: A single file or multiple files to be downloaded to a Compute Node.
EnvironmentSetting:
type: object
properties:
name:
type: string
title: The name of the environment variable.
value:
type: string
title: The value of the environment variable.
required:
- name
title: An environment variable to be set on a Task process.
HttpHeader:
properties:
name:
type: string
title: >-
The case-insensitive name of the header to be used while uploading
output files
value:
type: string
title: The value of the header to be used while uploading output files
required:
- name
title: An HTTP header name-value pair
ExitConditions:
type: object
properties:
exitCodes:
type: array
items:
$ref: '#/definitions/ExitCodeMapping'
title: >-
A list of individual Task exit codes and how the Batch service should
respond to them.
exitCodeRanges:
type: array
items:
$ref: '#/definitions/ExitCodeRangeMapping'
title: >-
A list of Task exit code ranges and how the Batch service should
respond to them.
preProcessingError:
$ref: '#/definitions/ExitOptions'
title: >-
How the Batch service should respond if the Task fails to start due to
an error.
fileUploadError:
$ref: '#/definitions/ExitOptions'
title: How the Batch service should respond if a file upload error occurs.
description: >-
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.
default:
$ref: '#/definitions/ExitOptions'
title: >-
How the Batch service should respond if the Task fails with an exit
condition not covered by any of the other properties.
description: >-
This value is used if the Task exits with any nonzero exit code not
listed in the exitCodes or exitCodeRanges collection, with a
pre-processing error if the preProcessingError property is not
present, or with a file upload error if the fileUploadError property
is not present. If you want non-default behavior on exit code 0, you
must list it explicitly using the exitCodes or exitCodeRanges
collection.
title: Specifies how the Batch service should respond when the Task completes.
ExitCodeMapping:
type: object
properties:
code:
type: integer
format: int32
title: A process exit code.
exitOptions:
$ref: '#/definitions/ExitOptions'
title: >-
How the Batch service should respond if the Task exits with this exit
code.
title: >-
How the Batch service should respond if a Task exits with a particular
exit code.
required:
- code
- exitOptions
ExitCodeRangeMapping:
type: object
properties:
start:
type: integer
format: int32
title: The first exit code in the range.
end:
type: integer
format: int32
title: The last exit code in the range.
exitOptions:
$ref: '#/definitions/ExitOptions'
title: >-
How the Batch service should respond if the Task exits with an exit
code in the range start to end (inclusive).
title: >-
A range of exit codes and how the Batch service should respond to exit
codes within that range.
required:
- start
- end
- exitOptions
ExitOptions:
type: object
properties:
jobAction:
type: string
title: >-
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'.
description: >-
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).
enum:
- none
- disable
- terminate
x-ms-enum:
name: JobAction
modelAsString: false
values:
- value: none
description: Take no action.
- value: disable
description: >-
Disable the Job. This is equivalent to calling the disable Job
API, with a disableTasks value of requeue.
- value: terminate
description: >-
Terminate the Job. The terminateReason in the Job's
executionInfo is set to "TaskFailed".
dependencyAction:
type: string
title: >-
An action that the Batch service performs on Tasks that depend on this
Task.
description: >-
Possible values are 'satisfy' (allowing dependent tasks to progress)
and 'block' (dependent tasks continue to wait). Batch does not yet
support cancellation of dependent tasks.
enum:
- satisfy
- block
x-ms-enum:
name: DependencyAction
modelAsString: false
values:
- value: satisfy
description: >-
Satisfy tasks waiting on this task; once all dependencies are
satisfied, the task will be scheduled to run.
- value: block
description: >-
Blocks tasks waiting on this task, preventing them from being
scheduled.
title: Specifies how the Batch service responds to a particular exit condition.
AutoUserSpecification:
type: object
properties:
scope:
type: string
title: The scope for the auto user
description: >-
The default value is pool. If the pool is running Windows a value of
Task should be specified if stricter isolation between tasks is
required. For example, if the task mutates the registry in a way which
could impact other tasks, or if certificates have been specified on
the pool which should not be accessible by normal tasks but should be
accessible by StartTasks.
enum:
- task
- pool
x-ms-enum:
name: AutoUserScope
modelAsString: false
values:
- value: task
description: >-
Specifies that the service should create a new user for the
Task.
- value: pool
description: >-
Specifies that the Task runs as the common auto user Account
which is created on every Compute Node in a Pool.
elevationLevel:
title: The elevation level of the auto user.
description: The default value is nonAdmin.
$ref: '#/definitions/ElevationLevel'
title: >-
Specifies the parameters for the auto user that runs a Task on the Batch
service.
UserIdentity:
type: object
properties:
username:
type: string
x-ms-client-name: userName
title: The name of the user identity under which the Task is run.
description: >-
The userName and autoUser properties are mutually exclusive; you must
specify one but not both.
autoUser:
$ref: '#/definitions/AutoUserSpecification'
title: The auto user under which the Task is run.
description: >-
The userName and autoUser properties are mutually exclusive; you must
specify one but not both.
title: The definition of the user identity under which the Task is run.
description: Specify either the userName or autoUser property, but not both.
LinuxUserConfiguration:
type: object
properties:
uid:
type: integer
format: int32
title: The user ID of the user Account.
description: >-
The uid and gid properties must be specified together or not at all.
If not specified the underlying operating system picks the uid.
gid:
type: integer
format: int32
title: The group ID for the user Account.
description: >-
The uid and gid properties must be specified together or not at all.
If not specified the underlying operating system picks the gid.
sshPrivateKey:
type: string
title: The SSH private key for the user Account.
description: >-
The private key must not be password protected. The private key is
used to automatically configure asymmetric-key based authentication
for SSH between Compute Nodes in a Linux Pool when the Pool's
enableInterNodeCommunication property is true (it is ignored if
enableInterNodeCommunication is false). It does this by placing the
key pair into the user's .ssh directory. If not specified,
password-less SSH is not configured between Compute Nodes (no
modification of the user's .ssh directory is done).
title: Properties used to create a user Account on a Linux Compute Node.
WindowsUserConfiguration:
type: object
properties:
loginMode:
type: string
title: The login mode for the user
description: >-
The default value for VirtualMachineConfiguration Pools is 'batch' and
for CloudServiceConfiguration Pools is 'interactive'.
enum:
- batch
- interactive
x-ms-enum:
name: LoginMode
modelAsString: false
values:
- value: batch
description: >-
The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode
is recommended for long running parallel processes.
- value: interactive
description: >-
The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled
on Windows VirtualMachineConfiguration Pools. If this option is
used with an elevated user identity in a Windows
VirtualMachineConfiguration Pool, the user session will not be
elevated unless the application executed by the Task command
line is configured to always require administrative privilege or
to always require maximum privilege.
title: Properties used to create a user Account on a Windows Compute Node.
UserAccount:
type: object
properties:
name:
type: string
title: >-
The name of the user Account. Names can contain any Unicode characters
up to a maximum length of 20.
password:
type: string
title: The password for the user Account.
elevationLevel:
title: The elevation level of the user Account.
description: The default value is nonAdmin.
$ref: '#/definitions/ElevationLevel'
linuxUserConfiguration:
title: The Linux-specific user configuration for the user Account.
description: >-
This property is ignored if specified on a Windows Pool. If not
specified, the user is created with the default options.
$ref: '#/definitions/LinuxUserConfiguration'
windowsUserConfiguration:
title: The Windows-specific user configuration for the user Account.
description: >-
This property can only be specified if the user is on a Windows Pool.
If not specified and on a Windows Pool, the user is created with the
default options.
$ref: '#/definitions/WindowsUserConfiguration'
required:
- name
- password
title: >-
Properties used to create a user used to execute Tasks on an Azure Batch
Compute Node.
TaskConstraints:
type: object
properties:
maxWallClockTime:
type: string
format: duration
title: >-
The maximum elapsed time that the Task may run, measured from the time
the Task starts. If the Task does not complete within the time limit,
the Batch service terminates it.
description: >-
If this is not specified, there is no time limit on how long the Task
may run.
retentionTime:
type: string
format: duration
title: >-
The minimum time to retain the Task directory on the Compute Node
where it ran, from the time it completes execution. After this time,
the Batch service may delete the Task directory and all its contents.
description: >-
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.
maxTaskRetryCount:
type: integer
format: int32
title: >-
The maximum number of times the Task may be retried. The Batch service
retries a Task if its exit code is nonzero.
description: >-
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, however this is not recommended for a start task or any task.
The default value is 0 (no retries).
title: Execution constraints to apply to a Task.
JobManagerTask:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Job Manager Task within the Job.
description: >-
The ID can contain any combination of alphanumeric characters
including hyphens and underscores and cannot contain more than 64
characters.
displayName:
type: string
title: The display name of the Job Manager Task.
description: >-
It need not be unique and can contain any Unicode characters up to a
maximum length of 1024.
commandLine:
type: string
title: The command line of the Job Manager Task.
description: >-
The command line does not run under a shell, and therefore cannot take
advantage of shell features such as environment variable expansion. If
you want to take advantage of such features, you should invoke the
shell in the command line, for example using "cmd /c MyCommand" in
Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers
to file paths, it should use a relative path (relative to the Task
working directory), or use the Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: The settings for the container under which the Job Manager Task runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line.
description: >-
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.
outputFiles:
type: array
items:
$ref: '#/definitions/OutputFile'
title: >-
A list of files that the Batch service will upload from the Compute
Node after running the command line.
description: >-
For multi-instance Tasks, the files will only be uploaded from the
Compute Node on which the primary Task is executed.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the Job Manager Task.
constraints:
$ref: '#/definitions/TaskConstraints'
title: Constraints that apply to the Job Manager Task.
requiredSlots:
type: integer
format: int32
title: The number of scheduling slots that the Task requires to run.
description: >-
The default is 1. A Task can only be scheduled to run on a compute
node if the node has enough free scheduling slots available. For
multi-instance Tasks, this property is not supported and must not be
specified.
killJobOnCompletion:
type: boolean
title: >-
Whether completion of the Job Manager Task signifies completion of the
entire Job.
description: >-
If true, when the Job Manager Task completes, the Batch service marks
the Job as complete. If any Tasks are still running at this time
(other than Job Release), those Tasks are terminated. If false, the
completion of the Job Manager Task does not affect the Job status. In
this case, you should either use the onAllTasksComplete attribute to
terminate the Job, or have a client or user terminate the Job
explicitly. An example of this is if the Job Manager creates a set of
Tasks but then takes no further role in their execution. The default
value is true. If you are using the onAllTasksComplete and
onTaskFailure attributes to control Job lifetime, and using the Job
Manager Task only to create the Tasks for the Job (not to monitor
progress), then it is important to set killJobOnCompletion to false.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the Job Manager Task runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task.
runExclusive:
type: boolean
title: >-
Whether the Job Manager Task requires exclusive use of the Compute
Node where it runs.
description: >-
If true, no other Tasks will run on the same 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 Compute Node's concurrent Task limit, so this is
only relevant if the Compute Node allows multiple concurrent Tasks.
The default value is true.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: >-
A list of Application Packages that the Batch service will deploy to
the Compute Node before running the command line.
description: >-
Application Packages are downloaded and deployed to a shared
directory, not the Task working directory. Therefore, if a referenced
Application 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.
authenticationTokenSettings:
title: >-
The settings for an authentication token that the Task can use to
perform Batch service operations.
description: >-
If this property is set, the Batch service provides the Task with an
authentication token which can be used to authenticate Batch service
operations without requiring an Account access key. The token is
provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable.
The operations that the Task can carry out using the token depend on
the settings. For example, a Task can request Job permissions in order
to add other Tasks to the Job, or check the status of the Job or of
other Tasks under the Job.
$ref: '#/definitions/AuthenticationTokenSettings'
allowLowPriorityNode:
type: boolean
title: >-
Whether the Job Manager Task may run on a Spot/Low-priority Compute
Node.
description: The default value is true.
required:
- id
- commandLine
title: Specifies details of a Job Manager Task.
description: >-
The Job Manager Task is automatically started when the Job is created. The
Batch service tries to schedule the Job Manager Task before any other
Tasks in the Job. When shrinking a Pool, the Batch service tries to
preserve Nodes where Job Manager Tasks are running for as long as possible
(that is, Compute Nodes running 'normal' Tasks are removed before Compute
Nodes running Job Manager Tasks). When a Job Manager Task fails and needs
to be restarted, the system tries to schedule it at the highest priority.
If there are no idle Compute Nodes available, the system may terminate one
of the running Tasks in the Pool and return it to the queue in order to
make room for the Job Manager Task to restart. Note that a Job Manager
Task in one Job does not have priority over Tasks in other Jobs. Across
Jobs, only Job level priorities are observed. For example, if a Job
Manager in a priority 0 Job needs to be restarted, it will not displace
Tasks of a priority 1 Job. Batch will retry Tasks when a recovery
operation is triggered on a Node. Examples of recovery operations include
(but are not limited to) when an unhealthy Node is rebooted or a Compute
Node disappeared due to host failure. Retries due to recovery operations
are independent of and are not counted against the maxTaskRetryCount. Even
if the maxTaskRetryCount is 0, an internal retry due to a recovery
operation may occur. Because of this, all Tasks should be idempotent. This
means Tasks need to tolerate being interrupted and restarted without
causing any corruption or duplicate data. The best practice for long
running Tasks is to use some form of checkpointing.
JobPreparationTask:
type: object
properties:
id:
type: string
title: >-
A string that uniquely identifies the Job Preparation Task within the
Job.
description: >-
The ID can contain any combination of alphanumeric characters
including hyphens and underscores and cannot contain more than 64
characters. If you do not specify this property, the Batch service
assigns a default value of 'jobpreparation'. No other Task in the Job
can have the same ID as the Job Preparation Task. If you try to submit
a Task with the same id, the Batch service rejects the request with
error code TaskIdSameAsJobPreparationTask; if you are calling the REST
API directly, the HTTP status code is 409 (Conflict).
commandLine:
type: string
title: The command line of the Job Preparation Task.
description: >-
The command line does not run under a shell, and therefore cannot take
advantage of shell features such as environment variable expansion. If
you want to take advantage of such features, you should invoke the
shell in the command line, for example using "cmd /c MyCommand" in
Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers
to file paths, it should use a relative path (relative to the Task
working directory), or use the Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: >-
The settings for the container under which the Job Preparation Task
runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line.
description: >-
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.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the Job Preparation Task.
constraints:
$ref: '#/definitions/TaskConstraints'
title: Constraints that apply to the Job Preparation Task.
waitForSuccess:
type: boolean
title: >-
Whether the Batch service should wait for the Job Preparation Task to
complete successfully before scheduling any other Tasks of the Job on
the Compute Node. A Job Preparation Task has completed successfully if
it exits with exit code 0.
description: >-
If true and the Job Preparation Task fails on a 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 Node. The Node remains active and
eligible to run Tasks of other Jobs. If false, the Batch service will
not wait for the Job Preparation Task to complete. In this case, other
Tasks of the Job can start executing on the Compute Node while the Job
Preparation Task is still running; and even if the Job Preparation
Task fails, new Tasks will continue to be scheduled on the Compute
Node. The default value is true.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the Job Preparation Task runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task on Windows Compute Nodes, or a non-administrative user unique to
the Pool on Linux Compute Nodes.
rerunOnNodeRebootAfterSuccess:
type: boolean
title: >-
Whether the Batch service should rerun the Job Preparation Task after
a Compute Node reboots.
description: >-
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.
required:
- commandLine
title: >-
A Job Preparation Task to run before any Tasks of the Job on any given
Compute Node.
description: >-
You can use Job Preparation to prepare a Node to run Tasks for the Job.
Activities commonly performed in Job Preparation include: Downloading
common resource files used by all the Tasks in the Job. The Job
Preparation Task can download these common resource files to the shared
location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local
service on the Node so that all Tasks of that Job can communicate with it.
If the Job Preparation Task fails (that is, exhausts its retry count
before exiting with exit code 0), Batch will not run Tasks of this Job on
the Node. The Compute Node remains ineligible to run Tasks of this Job
until it is reimaged. The Compute Node remains active and can be used for
other Jobs. The Job Preparation Task can run multiple times on the same
Node. Therefore, you should write the Job Preparation Task to handle
re-execution. If the Node is rebooted, the Job Preparation Task is run
again on the Compute Node before scheduling any other Task of the Job, if
rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did
not previously complete. If the Node is reimaged, the Job Preparation Task
is run again before scheduling any Task of the Job. Batch will retry Tasks
when a recovery operation is triggered on a Node. Examples of recovery
operations include (but are not limited to) when an unhealthy Node is
rebooted or a Compute Node disappeared due to host failure. Retries due to
recovery operations are independent of and are not counted against the
maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry
due to a recovery operation may occur. Because of this, all Tasks should
be idempotent. This means Tasks need to tolerate being interrupted and
restarted without causing any corruption or duplicate data. The best
practice for long running Tasks is to use some form of checkpointing.
JobReleaseTask:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Job Release Task within the Job.
description: >-
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).
commandLine:
type: string
title: The command line of the Job Release Task.
description: >-
The command line does not run under a shell, and therefore cannot take
advantage of shell features such as environment variable expansion. If
you want to take advantage of such features, you should invoke the
shell in the command line, for example using "cmd /c MyCommand" in
Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers
to file paths, it should use a relative path (relative to the Task
working directory), or use the Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: The settings for the container under which the Job Release Task runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line. There is a maximum size for the
list of resource files. When the max size is exceeded, the request
will fail and the response error code will be RequestEntityTooLarge.
If this occurs, the collection of ResourceFiles must be reduced in
size. This can be achieved using .zip files, Application Packages, or
Docker Containers.
description: >-
Files listed under this element are located in the Task's working
directory.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the Job Release Task.
maxWallClockTime:
type: string
format: duration
title: >-
The maximum elapsed time that the Job Release Task may run on a given
Compute Node, measured from the time the Task starts. If the Task does
not complete within the time limit, the Batch service terminates it.
The default value is 15 minutes. You may not specify a timeout longer
than 15 minutes. If you do, the Batch service rejects it with an
error; if you are calling the REST API directly, the HTTP status code
is 400 (Bad Request).
retentionTime:
type: string
format: duration
title: >-
The minimum time to retain the Task directory for the Job Release Task
on the Compute Node. After this time, the Batch service may delete the
Task directory and all its contents.
description: >-
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.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the Job Release Task runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task.
required:
- commandLine
title: >-
A Job Release Task to run on Job completion on any Compute Node where the
Job has run.
description: >-
The Job Release Task runs when the Job ends, because of one of the
following: The user calls the Terminate Job API, or the Delete Job API
while the Job is still active, the Job's maximum wall clock time
constraint is reached, and the Job is still active, or the Job's Job
Manager Task completed, and the Job is configured to terminate when the
Job Manager completes. The Job Release Task runs on each Node where Tasks
of the Job have run and the Job Preparation Task ran and completed. If you
reimage a Node after it has run the Job Preparation Task, and the Job ends
without any further Tasks of the Job running on that Node (and hence the
Job Preparation Task does not re-run), then the Job Release Task does not
run on that Compute Node. If a Node reboots while the Job Release Task is
still running, the Job Release Task runs again when the Compute Node
starts up. The Job is not marked as complete until all Job Release Tasks
have completed. The Job Release Task runs in the background. It does not
occupy a scheduling slot; that is, it does not count towards the
taskSlotsPerNode limit specified on the Pool.
TaskSchedulingPolicy:
type: object
properties:
nodeFillType:
type: string
title: How Tasks are distributed across Compute Nodes in a Pool.
description: If not specified, the default is spread.
enum:
- spread
- pack
x-ms-enum:
name: ComputeNodeFillType
modelAsString: false
values:
- value: spread
description: >-
Tasks should be assigned evenly across all Compute Nodes in the
Pool.
- value: pack
description: >-
As many Tasks as possible (taskSlotsPerNode) should be assigned
to each Compute Node in the Pool before any Tasks are assigned
to the next Compute Node in the Pool.
required:
- nodeFillType
title: Specifies how Tasks should be distributed across Compute Nodes.
StartTask:
type: object
properties:
commandLine:
type: string
title: The command line of the StartTask.
description: >-
The command line does not run under a shell, and therefore cannot take
advantage of shell features such as environment variable expansion. If
you want to take advantage of such features, you should invoke the
shell in the command line, for example using "cmd /c MyCommand" in
Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers
to file paths, it should use a relative path (relative to the Task
working directory), or use the Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: The settings for the container under which the StartTask runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line. There is a maximum size for the
list of resource files. When the max size is exceeded, the request
will fail and the response error code will be RequestEntityTooLarge.
If this occurs, the collection of ResourceFiles must be reduced in
size. This can be achieved using .zip files, Application Packages, or
Docker Containers.
description: >-
Files listed under this element are located in the Task's working
directory.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the StartTask.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the StartTask runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task.
maxTaskRetryCount:
type: integer
format: int32
title: The maximum number of times the Task may be retried.
description: >-
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, however
this is not recommended for a start task or any task. The default
value is 0 (no retries).
waitForSuccess:
type: boolean
title: >-
Whether the Batch service should wait for the StartTask to complete
successfully (that is, to exit with exit code 0) before scheduling any
Tasks on the Compute Node.
description: >-
If true and the StartTask fails on a Node, the Batch service retries
the StartTask up to its maximum retry count (maxTaskRetryCount). If
the Task has still not completed successfully after all retries, then
the Batch service marks the Node unusable, and will not schedule Tasks
to it. This condition can be detected via the Compute Node state and
failure info details. If false, the Batch service will not wait for
the StartTask to complete. In this case, other Tasks can start
executing on the Compute Node while the StartTask is still running;
and even if the StartTask fails, new Tasks will continue to be
scheduled on the Compute Node. The default is true.
required:
- commandLine
title: >-
A Task which is run when a Node joins a Pool in the Azure Batch service,
or when the Compute Node is rebooted or reimaged.
description: >-
Batch will retry Tasks when a recovery operation is triggered on a Node.
Examples of recovery operations include (but are not limited to) when an
unhealthy Node is rebooted or a Compute Node disappeared due to host
failure. Retries due to recovery operations are independent of and are not
counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0,
an internal retry due to a recovery operation may occur. Because of this,
all Tasks should be idempotent. This means Tasks need to tolerate being
interrupted and restarted without causing any corruption or duplicate
data. The best practice for long running Tasks is to use some form of
checkpointing. In some cases the StartTask may be re-run even though the
Compute Node was not rebooted. Special care should be taken to avoid
StartTasks which create breakaway process or install/launch services from
the StartTask working directory, as this will block Batch from being able
to re-run the StartTask.
CertificateReference:
type: object
properties:
thumbprint:
type: string
title: The thumbprint of the Certificate.
thumbprintAlgorithm:
type: string
title: >-
The algorithm with which the thumbprint is associated. This must be
sha1.
storeLocation:
type: string
title: >-
The location of the Certificate store on the Compute Node into which
to install the Certificate.
description: >-
The default value is currentuser. This property is applicable only for
Pools configured with Windows Compute 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.
enum:
- currentuser
- localmachine
x-ms-enum:
name: CertificateStoreLocation
modelAsString: false
values:
- value: currentuser
description: >-
Certificates should be installed to the CurrentUser Certificate
store.
name: currentUser
- value: localmachine
description: >-
Certificates should be installed to the LocalMachine Certificate
store.
name: localMachine
storeName:
type: string
title: >-
The name of the Certificate store on the Compute Node into which to
install the Certificate.
description: >-
This property is applicable only for Pools configured with Windows
Compute 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.
visibility:
type: array
items:
type: string
x-nullable: false
enum:
- starttask
- task
- remoteuser
x-ms-enum:
name: CertificateVisibility
modelAsString: false
values:
- value: starttask
description: >-
The Certificate should be visible to the user account under
which the StartTask is run. Note that if AutoUser Scope is
Pool for both the StartTask and a Task, this certificate will
be visible to the Task as well.
name: startTask
- value: task
description: >-
The Certificate should be visible to the user accounts under
which Job Tasks are run.
- value: remoteuser
description: >-
The Certificate should be visible to the user accounts under
which users remotely access the Compute Node.
name: remoteUser
title: >-
Which user Accounts on the Compute Node should have access to the
private data of the Certificate.
description: >-
You can specify more than one visibility in this collection. The
default is all Accounts.
required:
- thumbprint
- thumbprintAlgorithm
description: >-
Warning: This object is deprecated and will be removed after February,
2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
title: A reference to a Certificate to be installed on Compute Nodes in a Pool.
MetadataItem:
type: object
properties:
name:
type: string
title: The name of the metadata item.
value:
type: string
title: The value of the metadata item.
required:
- name
- value
title: A name-value pair associated with a Batch service resource.
description: >-
The Batch service does not assign any meaning to this metadata; it is
solely for the use of user code.
PoolSpecification:
type: object
properties:
displayName:
type: string
title: The display name for the Pool.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
vmSize:
type: string
title: >-
The size of the virtual machines in the Pool. All virtual machines in
a Pool are the same size.
description: >-
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).
cloudServiceConfiguration:
$ref: '#/definitions/CloudServiceConfiguration'
title: The cloud service configuration for the Pool.
description: >-
This property must be specified if the Pool needs to be created with
Azure PaaS VMs. This property and virtualMachineConfiguration are
mutually exclusive and one of the properties must be specified. If
neither is specified then the Batch service returns an error; if you
are calling the REST API directly, the HTTP status code is 400 (Bad
Request). This property cannot be specified if the Batch Account was
created with its poolAllocationMode property set to
'UserSubscription'.
virtualMachineConfiguration:
$ref: '#/definitions/VirtualMachineConfiguration'
title: The virtual machine configuration for the Pool.
description: >-
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).
taskSlotsPerNode:
type: integer
format: int32
title: >-
The number of task slots that can be used to run concurrent tasks on a
single compute node in the pool.
description: >-
The default value is 1. The maximum value is the smaller of 4 times
the number of cores of the vmSize of the pool or 256.
taskSchedulingPolicy:
$ref: '#/definitions/TaskSchedulingPolicy'
title: How Tasks are distributed across Compute Nodes in a Pool.
description: If not specified, the default is spread.
resizeTimeout:
type: string
format: duration
title: The timeout for allocation of Compute Nodes to the Pool.
description: >-
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).
targetDedicatedNodes:
type: integer
format: int32
title: The desired number of dedicated Compute Nodes in the Pool.
description: >-
This property must not be specified if enableAutoScale is set to true.
If enableAutoScale is set to false, then you must set either
targetDedicatedNodes, targetLowPriorityNodes, or both.
targetLowPriorityNodes:
type: integer
format: int32
title: The desired number of Spot/Low-priority Compute Nodes in the Pool.
description: >-
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.
enableAutoScale:
type: boolean
title: Whether the Pool size should automatically adjust over time.
description: >-
If false, at least one of targetDedicatedNodes 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.
autoScaleFormula:
type: string
title: The formula for the desired number of Compute Nodes in the Pool.
description: >-
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.
autoScaleEvaluationInterval:
type: string
format: duration
title: >-
The time interval at which to automatically adjust the Pool size
according to the autoscale formula.
description: >-
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).
enableInterNodeCommunication:
type: boolean
title: Whether the Pool permits direct communication between Compute Nodes.
description: >-
Enabling inter-node communication limits the maximum size of the Pool
due to deployment restrictions on the Compute Nodes of the Pool. This
may result in the Pool not reaching its desired size. The default
value is false.
networkConfiguration:
$ref: '#/definitions/NetworkConfiguration'
title: The network configuration for the Pool.
startTask:
$ref: '#/definitions/StartTask'
title: >-
A Task to run on each Compute Node as it joins the Pool. The Task runs
when the Compute Node is added to the Pool or when the Compute Node is
restarted.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: >-
A list of Certificates to be installed on each Compute Node in the
Pool.
description: >-
For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: The list of Packages to be installed on each Compute Node in the Pool.
description: >-
When creating a pool, the package's application ID must be fully
qualified
(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
Changes to Package references affect all new Nodes joining the Pool,
but do not affect Compute Nodes that are already in the Pool until
they are rebooted or reimaged. There is a maximum of 10 Package
references on any given Pool.
applicationLicenses:
type: array
items:
type: string
title: >-
The list of application licenses the Batch service will make available
on each Compute Node in the Pool.
description: >-
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.
userAccounts:
type: array
items:
$ref: '#/definitions/UserAccount'
title: >-
The list of user Accounts to be created on each Compute Node in the
Pool.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Pool as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
mountConfiguration:
type: array
items:
$ref: '#/definitions/MountConfiguration'
title: A list of file systems to mount on each node in the pool.
description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
targetNodeCommunicationMode:
title: The desired node communication mode for the pool.
description: If omitted, the default value is Default.
$ref: '#/definitions/NodeCommunicationMode'
upgradePolicy:
$ref: '#/definitions/UpgradePolicy'
title: The upgrade policy for the pool.
resourceTags:
type: object
additionalProperties:
type: string
title: The user-specified tags associated with the pool.
description: >-
The user-defined tags to be associated with the Azure Batch Pool. When
specified, these tags are propagated to the backing Azure resources
associated with the pool. This property can only be specified when the
Batch account was created with the poolAllocationMode property set to
'UserSubscription'.
required:
- vmSize
title: Specification for creating a new Pool.
AutoPoolSpecification:
type: object
properties:
autoPoolIdPrefix:
type: string
title: >-
A prefix to be added to the unique identifier when a Pool is
automatically created.
description: >-
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.
poolLifetimeOption:
type: string
title: >-
The minimum lifetime of created auto Pools, and how multiple Jobs on a
schedule are assigned to Pools.
enum:
- jobschedule
- job
x-ms-enum:
name: PoolLifetimeOption
modelAsString: false
values:
- value: jobschedule
description: >-
The Pool exists for the lifetime of the Job Schedule. The Batch
Service creates the Pool when it creates the first Job on the
schedule. You may apply this option only to Job Schedules, not
to Jobs.
name: jobSchedule
- value: job
description: >-
The Pool exists for the lifetime of the Job to which it is
dedicated. The Batch service creates the Pool when it creates
the Job. If the 'job' option is applied to a Job Schedule, the
Batch service creates a new auto Pool for every Job created on
the schedule.
keepAlive:
type: boolean
title: Whether to keep an auto Pool alive after its lifetime expires.
description: >-
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.
pool:
$ref: '#/definitions/PoolSpecification'
title: The Pool specification for the auto Pool.
required:
- poolLifetimeOption
title: >-
Specifies characteristics for a temporary 'auto pool'. The Batch service
will create this auto Pool when the Job is submitted.
PoolInformation:
type: object
properties:
poolId:
type: string
title: >-
The ID of an existing Pool. All the Tasks of the Job will run on the
specified Pool.
description: >-
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.
autoPoolSpecification:
$ref: '#/definitions/AutoPoolSpecification'
title: >-
Characteristics for a temporary 'auto pool'. The Batch service will
create this auto Pool when the Job is submitted.
description: >-
If auto Pool creation fails, the Batch service moves the Job to a
completed state, and the Pool creation error is set in the Job's
scheduling error property. The Batch service manages the lifetime
(both creation and, unless keepAlive is specified, deletion) of the
auto Pool. Any user actions that affect the lifetime of the auto Pool
while the Job is active will result in unexpected behavior. You must
specify either the Pool ID or the auto Pool specification, but not
both.
title: Specifies how a Job should be assigned to a Pool.
JobSpecification:
type: object
properties:
priority:
type: integer
format: int32
title: The priority of Jobs created under this schedule.
description: >-
Priority values can range from -1000 to 1000, with -1000 being the
lowest priority and 1000 being the highest priority. The default value
is 0. This priority is used as the default for all Jobs under the Job
Schedule. You can update a Job's priority after it has been created
using by using the update Job API.
allowTaskPreemption:
type: boolean
title: Whether Tasks in this job can be preempted by other high priority jobs
description: >-
If the value is set to True, other high priority jobs submitted to the
system will take precedence and will be able requeue tasks from this
job. You can update a job's allowTaskPreemption after it has been
created using the update job API.
maxParallelTasks:
type: integer
format: int32
default: -1
title: >-
The maximum number of tasks that can be executed in parallel for the
job.
description: >-
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once. You
can update a job's maxParallelTasks after it has been created using
the update job API.
displayName:
type: string
title: The display name for Jobs created under this schedule.
description: >-
The name need not be unique and can contain any Unicode characters up
to a maximum length of 1024.
usesTaskDependencies:
type: boolean
title: >-
Whether Tasks in the Job can define dependencies on each other. The
default is false.
onAllTasksComplete:
title: >-
The action the Batch service should take when all Tasks in a Job
created under this schedule are in the completed state.
description: >-
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.
$ref: '#/definitions/OnAllTasksComplete'
onTaskFailure:
title: >-
The action the Batch service should take when any Task fails in a Job
created under this schedule. A Task is considered to have failed if it
have failed if has a failureInfo. A failureInfo is set if the Task
completes with a non-zero exit code after exhausting its retry count,
or if there was an error starting the Task, for example due to a
resource file download error.
description: The default is noaction.
$ref: '#/definitions/OnTaskFailure'
networkConfiguration:
$ref: '#/definitions/JobNetworkConfiguration'
title: The network configuration for the Job.
constraints:
$ref: '#/definitions/JobConstraints'
title: The execution constraints for Jobs created under this schedule.
jobManagerTask:
$ref: '#/definitions/JobManagerTask'
title: >-
The details of a Job Manager Task to be launched when a Job is started
under this schedule.
description: >-
If the Job does not specify a Job Manager Task, the user must
explicitly add Tasks to the Job using the Task API. If the Job does
specify a Job Manager Task, the Batch service creates the Job Manager
Task when the Job is created, and will try to schedule the Job Manager
Task before scheduling other Tasks in the Job.
jobPreparationTask:
$ref: '#/definitions/JobPreparationTask'
title: The Job Preparation Task for Jobs created under this schedule.
description: >-
If a Job has a Job Preparation Task, the Batch service will run the
Job Preparation Task on a Node before starting any Tasks of that Job
on that Compute Node.
jobReleaseTask:
$ref: '#/definitions/JobReleaseTask'
title: The Job Release Task for Jobs created under this schedule.
description: >-
The primary purpose of the Job Release Task is to undo changes to
Nodes made by the Job Preparation Task. Example activities include
deleting local files, or shutting down services that were started as
part of Job preparation. A Job Release Task cannot be specified
without also specifying a Job Preparation Task for the Job. The Batch
service runs the Job Release Task on the Compute Nodes that have run
the Job Preparation Task.
commonEnvironmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: >-
A list of common environment variable settings. These environment
variables are set for all Tasks in Jobs created under this schedule
(including the Job Manager, Job Preparation and Job Release Tasks).
description: >-
Individual Tasks can override an environment setting specified here by
specifying the same setting name with a different value.
poolInfo:
$ref: '#/definitions/PoolInformation'
title: >-
The Pool on which the Batch service runs the Tasks of Jobs created
under this schedule.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: >-
A list of name-value pairs associated with each Job created under this
schedule as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
required:
- poolInfo
title: Specifies details of the Jobs to be created on a schedule.
RecentJob:
type: object
properties:
id:
type: string
title: The ID of the Job.
url:
type: string
title: The URL of the Job.
title: Information about the most recent Job to run under the Job Schedule.
JobScheduleExecutionInformation:
type: object
properties:
nextRunTime:
type: string
format: date-time
title: The next time at which a Job will be created under this schedule.
description: >-
This property is meaningful only if the schedule is in the active
state when the time comes around. For example, if the schedule is
disabled, no Job will be created at nextRunTime unless the Job is
enabled before then.
recentJob:
$ref: '#/definitions/RecentJob'
title: Information about the most recent Job under the Job Schedule.
description: >-
This property is present only if the at least one Job has run under
the schedule.
endTime:
type: string
format: date-time
title: The time at which the schedule ended.
description: >-
This property is set only if the Job Schedule is in the completed
state.
title: >-
Contains information about Jobs that have been and will be run under a Job
Schedule.
JobScheduleStatistics:
type: object
properties:
url:
type: string
title: The URL of the statistics.
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
userCPUTime:
type: string
format: duration
title: >-
The total user mode CPU time (summed across all cores and all Compute
Nodes) consumed by all Tasks in all Jobs created under the schedule.
kernelCPUTime:
type: string
format: duration
title: >-
The total kernel mode CPU time (summed across all cores and all
Compute Nodes) consumed by all Tasks in all Jobs created under the
schedule.
wallClockTime:
type: string
format: duration
title: >-
The total wall clock time of all the Tasks in all the Jobs created
under the schedule.
description: >-
The wall clock time is the elapsed time from when the Task started
running on a Compute Node to when it finished (or to the last time the
statistics were updated, if the Task had not finished by then). If a
Task was retried, this includes the wall clock time of all the Task
retries.
readIOps:
type: integer
format: int64
title: >-
The total number of disk read operations made by all Tasks in all Jobs
created under the schedule.
writeIOps:
type: integer
format: int64
title: >-
The total number of disk write operations made by all Tasks in all
Jobs created under the schedule.
readIOGiB:
type: number
format: double
title: >-
The total gibibytes read from disk by all Tasks in all Jobs created
under the schedule.
writeIOGiB:
type: number
format: double
title: >-
The total gibibytes written to disk by all Tasks in all Jobs created
under the schedule.
numSucceededTasks:
type: integer
format: int64
title: >-
The total number of Tasks successfully completed during the given time
range in Jobs created under the schedule. A Task completes
successfully if it returns exit code 0.
numFailedTasks:
type: integer
format: int64
title: >-
The total number of Tasks that failed during the given time range in
Jobs created under the schedule. A Task fails if it exhausts its
maximum retry count without returning exit code 0.
numTaskRetries:
type: integer
format: int64
title: >-
The total number of retries during the given time range on all Tasks
in all Jobs created under the schedule.
waitTime:
type: string
format: duration
title: >-
The total wait time of all Tasks in all Jobs created under the
schedule. The wait time for a Task is defined as the elapsed time
between the creation of the Task and the start of Task execution. (If
the Task is retried due to failures, the wait time is the time to the
most recent Task execution.)
description: >-
This value is only reported in the Account lifetime statistics; it is
not included in the Job statistics.
required:
- url
- startTime
- lastUpdateTime
- userCPUTime
- kernelCPUTime
- wallClockTime
- readIOps
- writeIOps
- readIOGiB
- writeIOGiB
- numSucceededTasks
- numFailedTasks
- numTaskRetries
- waitTime
title: Resource usage statistics for a Job Schedule.
CloudJobSchedule:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the schedule within the Account.
displayName:
type: string
title: The display name for the schedule.
url:
type: string
title: The URL of the Job Schedule.
eTag:
type: string
title: The ETag of the Job Schedule.
description: >-
This is an opaque string. You can use it to detect whether the Job
Schedule has changed between requests. In particular, you can be pass
the ETag with an Update Job Schedule request to specify that your
changes should take effect only if nobody else has modified the
schedule in the meantime.
lastModified:
type: string
format: date-time
title: The last modified time of the Job Schedule.
description: >-
This is the last time at which the schedule level data, such as the
Job specification or recurrence information, changed. It does not
factor in job-level changes such as new Jobs being created or Jobs
changing state.
creationTime:
type: string
format: date-time
title: The creation time of the Job Schedule.
state:
title: The current state of the Job Schedule.
$ref: '#/definitions/JobScheduleState'
stateTransitionTime:
type: string
format: date-time
title: The time at which the Job Schedule entered the current state.
previousState:
title: The previous state of the Job Schedule.
description: >-
This property is not present if the Job Schedule is in its initial
active state.
$ref: '#/definitions/JobScheduleState'
previousStateTransitionTime:
type: string
format: date-time
title: The time at which the Job Schedule entered its previous state.
description: >-
This property is not present if the Job Schedule is in its initial
active state.
schedule:
$ref: '#/definitions/Schedule'
title: The schedule according to which Jobs will be created.
description: >-
All times are fixed respective to UTC and are not impacted by daylight
saving time.
jobSpecification:
$ref: '#/definitions/JobSpecification'
title: The details of the Jobs to be created on this schedule.
executionInfo:
$ref: '#/definitions/JobScheduleExecutionInformation'
title: >-
Information about Jobs that have been and will be run under this
schedule.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the schedule as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
stats:
$ref: '#/definitions/JobScheduleStatistics'
title: >-
The lifetime resource usage statistics for the Job Schedule. The
statistics may not be immediately available. The Batch service
performs periodic roll-up of statistics. The typical delay is about 30
minutes.
title: >-
A Job Schedule that allows recurring Jobs by specifying when to run Jobs
and a specification used to create each Job.
JobScheduleAddParameter:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the schedule within the Account.
description: >-
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).
displayName:
type: string
title: The display name for the schedule.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
schedule:
$ref: '#/definitions/Schedule'
title: The schedule according to which Jobs will be created.
description: >-
All times are fixed respective to UTC and are not impacted by daylight
saving time.
jobSpecification:
$ref: '#/definitions/JobSpecification'
title: The details of the Jobs to be created on this schedule.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the schedule as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
required:
- id
- schedule
- jobSpecification
title: >-
A Job Schedule that allows recurring Jobs by specifying when to run Jobs
and a specification used to create each Job.
CloudJobScheduleListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/CloudJobSchedule'
title: The list of Job Schedules.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Job Schedules in an Account.
JobSchedulingError:
type: object
properties:
category:
title: The category of the Job scheduling error.
$ref: '#/definitions/ErrorCategory'
code:
type: string
title: >-
An identifier for the Job scheduling error. Codes are invariant and
are intended to be consumed programmatically.
message:
type: string
title: >-
A message describing the Job scheduling error, intended to be suitable
for display in a user interface.
details:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: A list of additional error details related to the scheduling error.
required:
- category
title: An error encountered by the Batch service when scheduling a Job.
JobExecutionInformation:
type: object
properties:
startTime:
type: string
format: date-time
title: The start time of the Job.
description: This is the time at which the Job was created.
endTime:
type: string
format: date-time
title: The completion time of the Job.
description: This property is set only if the Job is in the completed state.
poolId:
type: string
title: The ID of the Pool to which this Job is assigned.
description: >-
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.
schedulingError:
$ref: '#/definitions/JobSchedulingError'
title: Details of any error encountered by the service in starting the Job.
description: This property is not set if there was no error starting the Job.
terminateReason:
type: string
title: A string describing the reason the Job ended.
description: >-
This property is set only if the Job is in the completed state. If the
Batch service terminates the Job, it sets the reason as follows:
JMComplete - the Job Manager Task completed, and killJobOnCompletion
was set to true. MaxWallClockTimeExpiry - the Job reached its
maxWallClockTime constraint. TerminateJobSchedule - the Job ran as
part of a schedule, and the schedule terminated. AllTasksComplete -
the Job's onAllTasksComplete attribute is set to terminatejob, and all
Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure
attribute is set to performExitOptionsJobAction, and a Task in the Job
failed with an exit condition that specified a jobAction of
terminatejob. Any other string is a user-defined reason specified in a
call to the 'Terminate a Job' operation.
required:
- startTime
title: >-
Contains information about the execution of a Job in the Azure Batch
service.
CloudJob:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Job within the Account.
description: >-
The ID is case-preserving and case-insensitive (that is, you may not
have two IDs within an Account that differ only by case).
displayName:
type: string
title: The display name for the Job.
usesTaskDependencies:
type: boolean
title: >-
Whether Tasks in the Job can define dependencies on each other. The
default is false.
url:
type: string
title: The URL of the Job.
eTag:
type: string
title: The ETag of the Job.
description: >-
This is an opaque string. You can use it to detect whether the Job has
changed between requests. In particular, you can be pass the ETag when
updating a Job to specify that your changes should take effect only if
nobody else has modified the Job in the meantime.
lastModified:
type: string
format: date-time
title: The last modified time of the Job.
description: >-
This is the last time at which the Job level data, such as the Job
state or priority, changed. It does not factor in task-level changes
such as adding new Tasks or Tasks changing state.
creationTime:
type: string
format: date-time
title: The creation time of the Job.
state:
title: The current state of the Job.
$ref: '#/definitions/JobState'
stateTransitionTime:
type: string
format: date-time
title: The time at which the Job entered its current state.
previousState:
title: The previous state of the Job.
description: This property is not set if the Job is in its initial Active state.
$ref: '#/definitions/JobState'
previousStateTransitionTime:
type: string
format: date-time
title: The time at which the Job entered its previous state.
description: This property is not set if the Job is in its initial Active state.
priority:
type: integer
format: int32
title: The priority of the Job.
description: >-
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.
allowTaskPreemption:
type: boolean
title: Whether Tasks in this job can be preempted by other high priority jobs
description: >-
If the value is set to True, other high priority jobs submitted to the
system will take precedence and will be able requeue tasks from this
job. You can update a job's allowTaskPreemption after it has been
created using the update job API.
maxParallelTasks:
type: integer
format: int32
default: -1
title: >-
The maximum number of tasks that can be executed in parallel for the
job.
description: >-
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once. You
can update a job's maxParallelTasks after it has been created using
the update job API.
constraints:
$ref: '#/definitions/JobConstraints'
title: The execution constraints for the Job.
jobManagerTask:
$ref: '#/definitions/JobManagerTask'
title: Details of a Job Manager Task to be launched when the Job is started.
jobPreparationTask:
$ref: '#/definitions/JobPreparationTask'
title: The Job Preparation Task.
description: >-
The Job Preparation Task is a special Task run on each Compute Node
before any other Task of the Job.
jobReleaseTask:
$ref: '#/definitions/JobReleaseTask'
title: The Job Release Task.
description: >-
The Job Release Task is a special Task run at the end of the Job on
each Compute Node that has run any other Task of the Job.
commonEnvironmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: >-
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).
description: >-
Individual Tasks can override an environment setting specified here by
specifying the same setting name with a different value.
poolInfo:
$ref: '#/definitions/PoolInformation'
title: The Pool settings associated with the Job.
onAllTasksComplete:
title: >-
The action the Batch service should take when all Tasks in the Job are
in the completed state.
description: The default is noaction.
$ref: '#/definitions/OnAllTasksComplete'
onTaskFailure:
title: >-
The action the Batch service should take when any Task in the Job
fails.
description: >-
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.
$ref: '#/definitions/OnTaskFailure'
networkConfiguration:
$ref: '#/definitions/JobNetworkConfiguration'
title: The network configuration for the Job.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Job as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
executionInfo:
$ref: '#/definitions/JobExecutionInformation'
title: The execution information for the Job.
stats:
$ref: '#/definitions/JobStatistics'
title: Resource usage statistics for the entire lifetime of the Job.
description: >-
This property is populated only if the CloudJob was retrieved with an
expand clause including the 'stats' attribute; otherwise it is null.
The statistics may not be immediately available. The Batch service
performs periodic roll-up of statistics. The typical delay is about 30
minutes.
title: An Azure Batch Job.
JobAddParameter:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Job within the Account.
description: >-
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).
displayName:
type: string
title: The display name for the Job.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
priority:
type: integer
format: int32
title: The priority of the Job.
description: >-
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.
maxParallelTasks:
type: integer
format: int32
default: -1
title: >-
The maximum number of tasks that can be executed in parallel for the
job.
description: >-
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once. You
can update a job's maxParallelTasks after it has been created using
the update job API.
allowTaskPreemption:
type: boolean
title: Whether Tasks in this job can be preempted by other high priority jobs
description: >-
If the value is set to True, other high priority jobs submitted to the
system will take precedence and will be able requeue tasks from this
job. You can update a job's allowTaskPreemption after it has been
created using the update job API.
constraints:
$ref: '#/definitions/JobConstraints'
description: The execution constraints for the Job.
jobManagerTask:
$ref: '#/definitions/JobManagerTask'
title: Details of a Job Manager Task to be launched when the Job is started.
description: >-
If the Job does not specify a Job Manager Task, the user must
explicitly add Tasks to the Job. If the Job does specify a Job Manager
Task, the Batch service creates the Job Manager Task when the Job is
created, and will try to schedule the Job Manager Task before
scheduling other Tasks in the Job. The Job Manager Task's typical
purpose is to control and/or monitor Job execution, for example by
deciding what additional Tasks to run, determining when the work is
complete, etc. (However, a Job Manager Task is not restricted to these
activities - it is a fully-fledged Task in the system and perform
whatever actions are required for the Job.) For example, a Job Manager
Task might download a file specified as a parameter, analyze the
contents of that file and submit additional Tasks based on those
contents.
jobPreparationTask:
$ref: '#/definitions/JobPreparationTask'
title: The Job Preparation Task.
description: >-
If a Job has a Job Preparation Task, the Batch service will run the
Job Preparation Task on a Node before starting any Tasks of that Job
on that Compute Node.
jobReleaseTask:
$ref: '#/definitions/JobReleaseTask'
title: The Job Release Task.
description: >-
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 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.
commonEnvironmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: >-
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).
description: >-
Individual Tasks can override an environment setting specified here by
specifying the same setting name with a different value.
poolInfo:
$ref: '#/definitions/PoolInformation'
title: The Pool on which the Batch service runs the Job's Tasks.
onAllTasksComplete:
title: >-
The action the Batch service should take when all Tasks in the Job are
in the completed state.
description: >-
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.
$ref: '#/definitions/OnAllTasksComplete'
onTaskFailure:
title: >-
The action the Batch service should take when any Task in the Job
fails.
description: >-
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.
$ref: '#/definitions/OnTaskFailure'
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Job as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
usesTaskDependencies:
type: boolean
title: >-
Whether Tasks in the Job can define dependencies on each other. The
default is false.
networkConfiguration:
$ref: '#/definitions/JobNetworkConfiguration'
title: The network configuration for the Job.
required:
- id
- poolInfo
title: An Azure Batch Job to add.
CloudJobListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/CloudJob'
title: The list of Jobs.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Jobs in an Account.
TaskContainerExecutionInformation:
type: object
properties:
containerId:
type: string
title: The ID of the container.
state:
type: string
title: The state of the container.
description: >-
This is the state of the container according to the Docker service. It
is equivalent to the status field returned by "docker inspect".
error:
type: string
title: Detailed error information about the container.
description: >-
This is the detailed error string from the Docker service, if
available. It is equivalent to the error field returned by "docker
inspect".
title: Contains information about the container which a Task is executing.
TaskFailureInformation:
type: object
properties:
category:
title: The category of the Task error.
$ref: '#/definitions/ErrorCategory'
code:
type: string
title: >-
An identifier for the Task error. Codes are invariant and are intended
to be consumed programmatically.
message:
type: string
title: >-
A message describing the Task error, intended to be suitable for
display in a user interface.
details:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: A list of additional details related to the error.
required:
- category
title: Information about a Task failure.
JobPreparationTaskExecutionInformation:
type: object
properties:
startTime:
type: string
format: date-time
title: The time at which the Task started running.
description: >-
If the Task has been restarted or retried, this is the most recent
time at which the Task started running.
endTime:
type: string
format: date-time
title: The time at which the Job Preparation Task completed.
description: This property is set only if the Task is in the Completed state.
state:
type: string
title: The current state of the Job Preparation Task on the Compute Node.
enum:
- running
- completed
x-ms-enum:
name: JobPreparationTaskState
modelAsString: false
values:
- value: running
description: The Task is currently running (including retrying).
- value: completed
description: >-
The Task has exited with exit code 0, or the Task has exhausted
its retry limit, or the Batch service was unable to start the
Task due to Task preparation errors (such as resource file
download failures).
taskRootDirectory:
type: string
title: >-
The root directory of the Job Preparation Task on the Compute Node.
You can use this path to retrieve files created by the Task, such as
log files.
taskRootDirectoryUrl:
type: string
title: >-
The URL to the root directory of the Job Preparation Task on the
Compute Node.
exitCode:
type: integer
format: int32
title: The exit code of the program specified on the Task command line.
description: >-
This parameter is returned only if the Task is in the completed state.
The exit code for a process reflects the specific convention
implemented by the application developer for that process. If you use
the exit code value to make decisions in your code, be sure that you
know the exit code convention used by the application process. Note
that the exit code may also be generated by the Compute Node operating
system, such as when a process is forcibly terminated.
containerInfo:
$ref: '#/definitions/TaskContainerExecutionInformation'
title: Information about the container under which the Task is executing.
description: This property is set only if the Task runs in a container context.
failureInfo:
$ref: '#/definitions/TaskFailureInformation'
title: Information describing the Task failure, if any.
description: >-
This property is set only if the Task is in the completed state and
encountered a failure.
retryCount:
type: integer
format: int32
title: >-
The number of times the Task has been retried by the Batch service.
Task application failures (non-zero exit code) are retried,
pre-processing errors (the Task could not be run) and file upload
errors are not retried. The Batch service will retry the Task up to
the limit specified by the constraints.
description: >-
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.
lastRetryTime:
type: string
format: date-time
title: >-
The most recent time at which a retry of the Job Preparation Task
started running.
description: >-
This property is set only if the Task was retried (i.e. retryCount is
nonzero). If present, this is typically the same as startTime, but may
be different if the Task has been restarted for reasons other than
retry; for example, if the Compute Node was rebooted during a retry,
then the startTime is updated but the lastRetryTime is not.
result:
$ref: '#/definitions/TaskExecutionResult'
title: The result of the Task execution.
description: >-
If the value is 'failed', then the details of the failure can be found
in the failureInfo property.
required:
- startTime
- retryCount
- state
title: >-
Contains information about the execution of a Job Preparation Task on a
Compute Node.
JobReleaseTaskExecutionInformation:
type: object
properties:
startTime:
type: string
format: date-time
title: The time at which the Task started running.
description: >-
If the Task has been restarted or retried, this is the most recent
time at which the Task started running.
endTime:
type: string
format: date-time
title: The time at which the Job Release Task completed.
description: This property is set only if the Task is in the Completed state.
state:
type: string
title: The current state of the Job Release Task on the Compute Node.
enum:
- running
- completed
x-ms-enum:
name: JobReleaseTaskState
modelAsString: false
values:
- value: running
description: The Task is currently running (including retrying).
- value: completed
description: >-
The Task has exited with exit code 0, or the Task has exhausted
its retry limit, or the Batch service was unable to start the
Task due to Task preparation errors (such as resource file
download failures).
taskRootDirectory:
type: string
title: >-
The root directory of the Job Release Task on the Compute Node. You
can use this path to retrieve files created by the Task, such as log
files.
taskRootDirectoryUrl:
type: string
title: >-
The URL to the root directory of the Job Release Task on the Compute
Node.
exitCode:
type: integer
format: int32
title: The exit code of the program specified on the Task command line.
description: >-
This parameter is returned only if the Task is in the completed state.
The exit code for a process reflects the specific convention
implemented by the application developer for that process. If you use
the exit code value to make decisions in your code, be sure that you
know the exit code convention used by the application process. Note
that the exit code may also be generated by the Compute Node operating
system, such as when a process is forcibly terminated.
containerInfo:
$ref: '#/definitions/TaskContainerExecutionInformation'
title: Information about the container under which the Task is executing.
description: This property is set only if the Task runs in a container context.
failureInfo:
$ref: '#/definitions/TaskFailureInformation'
title: Information describing the Task failure, if any.
description: >-
This property is set only if the Task is in the completed state and
encountered a failure.
result:
$ref: '#/definitions/TaskExecutionResult'
title: The result of the Task execution.
description: >-
If the value is 'failed', then the details of the failure can be found
in the failureInfo property.
required:
- startTime
- state
title: >-
Contains information about the execution of a Job Release Task on a
Compute Node.
JobPreparationAndReleaseTaskExecutionInformation:
type: object
properties:
poolId:
type: string
title: >-
The ID of the Pool containing the Compute Node to which this entry
refers.
nodeId:
type: string
title: The ID of the Compute Node to which this entry refers.
nodeUrl:
type: string
title: The URL of the Compute Node to which this entry refers.
jobPreparationTaskExecutionInfo:
$ref: '#/definitions/JobPreparationTaskExecutionInformation'
title: >-
Information about the execution status of the Job Preparation Task on
this Compute Node.
jobReleaseTaskExecutionInfo:
$ref: '#/definitions/JobReleaseTaskExecutionInformation'
title: >-
Information about the execution status of the Job Release Task on this
Compute Node.
description: >-
This property is set only if the Job Release Task has run on the
Compute Node.
title: The status of the Job Preparation and Job Release Tasks on a Compute Node.
CloudJobListPreparationAndReleaseTaskStatusResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/JobPreparationAndReleaseTaskExecutionInformation'
title: A list of Job Preparation and Job Release Task execution information.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: >-
The result of listing the status of the Job Preparation and Job Release
Tasks for a Job.
TaskCountsResult:
type: object
properties:
taskCounts:
$ref: '#/definitions/TaskCounts'
title: The number of Tasks per state.
taskSlotCounts:
$ref: '#/definitions/TaskSlotCounts'
title: The number of TaskSlots required by Tasks per state.
required:
- taskCounts
- taskSlotCounts
title: The Task and TaskSlot counts for a Job.
TaskCounts:
type: object
properties:
active:
type: integer
format: int32
title: The number of Tasks in the active state.
running:
type: integer
format: int32
title: The number of Tasks in the running or preparing state.
completed:
type: integer
format: int32
title: The number of Tasks in the completed state.
succeeded:
type: integer
format: int32
title: >-
The number of Tasks which succeeded. A Task succeeds if its result
(found in the executionInfo property) is 'success'.
failed:
type: integer
format: int32
title: >-
The number of Tasks which failed. A Task fails if its result (found in
the executionInfo property) is 'failure'.
required:
- active
- running
- completed
- succeeded
- failed
title: The Task counts for a Job.
TaskSlotCounts:
type: object
properties:
active:
type: integer
format: int32
title: The number of TaskSlots for active Tasks.
running:
type: integer
format: int32
title: The number of TaskSlots for running Tasks.
completed:
type: integer
format: int32
title: The number of TaskSlots for completed Tasks.
succeeded:
type: integer
format: int32
title: The number of TaskSlots for succeeded Tasks.
failed:
type: integer
format: int32
title: The number of TaskSlots for failed Tasks.
required:
- active
- running
- completed
- succeeded
- failed
title: The TaskSlot counts for a Job.
AutoScaleRunError:
type: object
properties:
code:
type: string
title: >-
An identifier for the autoscale error. Codes are invariant and are
intended to be consumed programmatically.
message:
type: string
title: >-
A message describing the autoscale error, intended to be suitable for
display in a user interface.
values:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: A list of additional error details related to the autoscale error.
title: >-
An error that occurred when executing or evaluating a Pool autoscale
formula.
AutoScaleRun:
type: object
properties:
timestamp:
type: string
format: date-time
title: The time at which the autoscale formula was last evaluated.
results:
type: string
title: >-
The final values of all variables used in the evaluation of the
autoscale formula.
description: >-
Each variable value is returned in the form $variable=value, and
variables are separated by semicolons.
error:
$ref: '#/definitions/AutoScaleRunError'
title: >-
Details of the error encountered evaluating the autoscale formula on
the Pool, if the evaluation was unsuccessful.
required:
- timestamp
title: The results and errors from an execution of a Pool autoscale formula.
ResizeError:
type: object
properties:
code:
type: string
title: >-
An identifier for the Pool resize error. Codes are invariant and are
intended to be consumed programmatically.
message:
type: string
title: >-
A message describing the Pool resize error, intended to be suitable
for display in a user interface.
values:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: A list of additional error details related to the Pool resize error.
title: An error that occurred when resizing a Pool.
CloudServiceConfiguration:
type: object
properties:
osFamily:
type: string
title: >-
The Azure Guest OS family to be installed on the virtual machines in
the Pool.
description: >-
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.
6 - OS Family 6, equivalent to Windows Server 2019. For more
information, see Azure Guest OS Releases
(https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion:
type: string
title: >-
The Azure Guest OS version to be installed on the virtual machines in
the Pool.
description: >-
The default value is * which specifies the latest operating system
version for the specified OS family.
required:
- osFamily
title: >-
The configuration for Compute Nodes in a Pool based on the Azure Cloud
Services platform.
ImageReference:
type: object
properties:
publisher:
type: string
title: The publisher of the Azure Virtual Machines Marketplace Image.
description: For example, Canonical or MicrosoftWindowsServer.
offer:
type: string
title: The offer type of the Azure Virtual Machines Marketplace Image.
description: For example, UbuntuServer or WindowsServer.
sku:
type: string
title: The SKU of the Azure Virtual Machines Marketplace Image.
description: For example, 18.04-LTS or 2019-Datacenter.
version:
type: string
title: The version of the Azure Virtual Machines Marketplace Image.
description: >-
A value of 'latest' can be specified to select the latest version of
an Image. If omitted, the default is 'latest'.
virtualMachineImageId:
type: string
title: >-
The ARM resource identifier of the Azure Compute Gallery Image.
Compute Nodes in the Pool will be created using this Image Id. This is
of the form
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId}
or
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}
for always defaulting to the latest image version.
description: >-
This property is mutually exclusive with other ImageReference
properties. The Azure Compute Gallery Image must have replicas in the
same region and must be in the same subscription as the Azure Batch
account. If the image version is not specified in the imageId, the
latest version will be used. For information about the firewall
settings for the Batch Compute 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.
exactVersion:
type: string
readOnly: true
description: >-
The specific version of the platform image or marketplace image used
to create the node. This read-only field differs from 'version' only
if the value specified for 'version' when the pool was created was
'latest'.
title: >-
A reference to an Azure Virtual Machines Marketplace Image or a Azure
Compute Gallery Image. To get the list of all Azure Marketplace Image
references verified by Azure Batch, see the 'List Supported Images'
operation.
WindowsConfiguration:
type: object
properties:
enableAutomaticUpdates:
type: boolean
title: Whether automatic updates are enabled on the virtual machine.
description: If omitted, the default value is true.
title: Windows operating system settings to apply to the virtual machine.
DataDisk:
type: object
properties:
lun:
type: integer
format: int32
title: The logical unit number.
description: >-
The lun is used to uniquely identify each data disk. If attaching
multiple disks, each should have a distinct lun. The value must be
between 0 and 63, inclusive.
caching:
$ref: '#/definitions/CachingType'
title: The type of caching to be enabled for the data disks.
description: >-
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/.
diskSizeGB:
type: integer
format: int32
title: The initial disk size in gigabytes.
storageAccountType:
title: The storage Account type to be used for the data disk.
description: If omitted, the default is "standard_lrs".
$ref: '#/definitions/StorageAccountType'
required:
- lun
- diskSizeGB
title: >-
Settings which will be used by the data disks associated to Compute Nodes
in the Pool. When using attached data disks, you need to mount and format
the disks from within a VM to use them.
StorageAccountType:
type: string
title: The storage Account type for use in creating data disks or OS disk.
enum:
- standard_lrs
- premium_lrs
- standardssd_lrs
x-ms-enum:
name: StorageAccountType
modelAsString: false
values:
- value: standard_lrs
description: >-
The data disk / OS disk should use standard locally redundant
storage.
name: StandardLRS
- value: premium_lrs
description: >-
The data disk / OS disk should use premium locally redundant
storage.
name: PremiumLRS
- value: standardssd_lrs
description: >-
The data disk / OS disk should use standard SSD locally redundant
storage.
name: StandardSSDLRS
CachingType:
type: string
title: The type of caching to enable for the disk.
description: >-
The default value for caching is none. For information about the caching
options see:
https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
enum:
- none
- readonly
- readwrite
x-ms-enum:
name: CachingType
modelAsString: false
values:
- value: none
description: The caching mode for the disk is not enabled.
- value: readonly
description: The caching mode for the disk is read only.
name: readOnly
- value: readwrite
description: The caching mode for the disk is read and write.
name: readWrite
ServiceArtifactReference:
type: object
properties:
id:
type: string
title: The service artifact reference id of ServiceArtifactReference
description: >-
The service artifact reference id in the form of
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
required:
- id
description: >-
Specifies the service artifact reference id used to set same image version
for all virtual machines in the scale set when using 'latest' image
version.
VirtualMachineConfiguration:
type: object
properties:
imageReference:
$ref: '#/definitions/ImageReference'
title: >-
A reference to the Azure Virtual Machines Marketplace Image or the
custom Virtual Machine Image to use.
nodeAgentSKUId:
type: string
title: >-
The SKU of the Batch Compute Node agent to be provisioned on Compute
Nodes in the Pool.
description: >-
The Batch Compute Node agent is a program that runs on each Compute
Node in the Pool, and provides the command-and-control interface
between the Compute Node and the Batch service. There are different
implementations of the Compute Node agent, known as SKUs, for
different operating systems. You must specify a Compute Node agent SKU
which matches the selected Image reference. To get the list of
supported Compute Node agent SKUs along with their list of verified
Image references, see the 'List supported Compute Node agent SKUs'
operation.
windowsConfiguration:
$ref: '#/definitions/WindowsConfiguration'
title: Windows operating system settings on the virtual machine.
description: >-
This property must not be specified if the imageReference property
specifies a Linux OS Image.
dataDisks:
type: array
items:
$ref: '#/definitions/DataDisk'
title: >-
The configuration for data disks attached to the Compute Nodes in the
Pool.
description: >-
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 Compute Node gets its own disk (the disk is not a file share).
Existing disks cannot be attached, each attached disk is empty. When
the Compute 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.
licenseType:
type: string
title: >-
The type of on-premises license to be used when deploying the
operating system.
description: >
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 Compute 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.
containerConfiguration:
$ref: '#/definitions/ContainerConfiguration'
title: The container configuration for the Pool.
description: >-
If specified, setup is performed on each Compute 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.
diskEncryptionConfiguration:
$ref: '#/definitions/DiskEncryptionConfiguration'
title: The disk encryption configuration for the pool.
description: >-
If specified, encryption is performed on each node in the pool during
node provisioning.
nodePlacementConfiguration:
$ref: '#/definitions/NodePlacementConfiguration'
title: The node placement configuration for the pool.
description: >-
This configuration will specify rules on how nodes in the pool will be
physically allocated.
extensions:
type: array
items:
$ref: '#/definitions/VMExtension'
title: The virtual machine extension for the pool.
description: >-
If specified, the extensions mentioned in this configuration will be
installed on each node.
osDisk:
$ref: '#/definitions/OSDisk'
title: Settings for the operating system disk of the Virtual Machine.
securityProfile:
$ref: '#/definitions/SecurityProfile'
title: >-
Specifies the security profile settings for the virtual machine or
virtual machine scale set.
serviceArtifactReference:
$ref: '#/definitions/ServiceArtifactReference'
title: >-
Specifies the service artifact reference id used to set same image
version for all virtual machines in the scale set when using 'latest'
image version.
description: >-
The service artifact reference id in the form of
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
required:
- nodeAgentSKUId
- imageReference
title: >-
The configuration for Compute Nodes in a Pool based on the Azure Virtual
Machines infrastructure.
ContainerRegistry:
type: object
properties:
username:
type: string
x-ms-client-name: userName
title: The user name to log into the registry server.
password:
type: string
title: The password to log into the registry server.
registryServer:
type: string
title: The registry URL.
description: If omitted, the default is "docker.io".
identityReference:
title: >-
The reference to the user assigned identity to use to access an Azure
Container Registry instead of username and password.
$ref: '#/definitions/ComputeNodeIdentityReference'
title: A private container registry.
ContainerConfiguration:
type: object
properties:
type:
type: string
title: The container technology to be used.
enum:
- dockerCompatible
- criCompatible
x-ms-enum:
name: ContainerType
modelAsString: true
values:
- value: dockerCompatible
description: >-
A Docker compatible container technology will be used to launch
the containers.
- value: criCompatible
description: A CRI based technology will be used to launch the containers.
containerImageNames:
type: array
items:
type: string
title: The collection of container Image names.
description: >-
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.
containerRegistries:
type: array
items:
$ref: '#/definitions/ContainerRegistry'
title: Additional private registries from which containers can be pulled.
description: >-
If any Images must be downloaded from a private registry which
requires credentials, then those credentials must be provided here.
required:
- type
title: The configuration for container-enabled Pools.
DiskEncryptionConfiguration:
type: object
properties:
targets:
type: array
items:
type: string
x-nullable: false
title: A disk to encrypt.
enum:
- osdisk
- temporarydisk
x-ms-enum:
name: DiskEncryptionTarget
modelAsString: false
values:
- value: osdisk
description: The OS Disk on the compute node is encrypted.
name: OsDisk
- value: temporarydisk
description: >-
The temporary disk on the compute node is encrypted. On Linux
this encryption applies to other partitions (such as those on
mounted data disks) when encryption occurs at boot time.
name: TemporaryDisk
title: >-
The list of disk targets Batch Service will encrypt on the compute
node.
description: >-
If omitted, no disks on the compute nodes in the pool will be
encrypted. On Linux pool, only "TemporaryDisk" is supported; on
Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
description: >-
The disk encryption configuration applied on compute nodes in the pool.
Disk encryption configuration is not supported on Linux pool created with
Azure Compute Gallery Image.
NodePlacementPolicyType:
type: string
title: The placement policy for allocating nodes in the pool.
description: The default value is regional.
enum:
- regional
- zonal
x-ms-enum:
name: NodePlacementPolicyType
modelAsString: false
values:
- value: regional
description: All nodes in the pool will be allocated in the same region.
name: regional
- value: zonal
description: >-
Nodes in the pool will be spread across different availability zones
with best effort balancing.
name: zonal
NodePlacementConfiguration:
type: object
title: Node placement configuration for a pool.
description: >-
For regional placement, nodes in the pool will be allocated in the same
region. For zonal placement, nodes in the pool will be spread across
different zones with best effort balancing.
properties:
policy:
$ref: '#/definitions/NodePlacementPolicyType'
title: Node placement Policy type on Batch Pools.
description: >-
Allocation policy used by Batch Service to provision the nodes. If not
specified, Batch will use the regional policy.
VMExtension:
type: object
properties:
name:
type: string
title: The name of the virtual machine extension.
publisher:
type: string
title: The name of the extension handler publisher.
type:
type: string
title: The type of the extension.
typeHandlerVersion:
type: string
title: The version of script handler.
autoUpgradeMinorVersion:
type: boolean
description: >-
Indicates whether the extension should use a newer minor version if
one is available at deployment time. Once deployed, however, the
extension will not upgrade minor versions unless redeployed, even with
this property set to true.
enableAutomaticUpgrade:
type: boolean
description: >-
Indicates whether the extension should be automatically upgraded by
the platform if there is a newer version of the extension available.
settings:
type: object
title: JSON formatted public settings for the extension.
protectedSettings:
x-ms-secret: true
type: object
description: >-
The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
provisionAfterExtensions:
type: array
items:
type: string
title: The collection of extension names.
description: >-
Collection of extension names after which this extension needs to be
provisioned.
required:
- name
- publisher
- type
title: The configuration for virtual machine extensions.
InstanceViewStatus:
type: object
properties:
code:
type: string
title: The status code.
displayStatus:
type: string
title: The localized label for the status.
level:
type: string
title: Level code.
enum:
- Error
- Info
- Warning
x-ms-enum:
name: StatusLevelTypes
modelAsString: false
values:
- value: Error
- value: Info
- value: Warning
message:
type: string
title: The detailed status message.
time:
type: string
description: The time of the status.
title: The instance view status.
VMExtensionInstanceView:
type: object
properties:
name:
type: string
title: The name of the vm extension instance view.
statuses:
type: array
items:
$ref: '#/definitions/InstanceViewStatus'
description: The resource status information.
subStatuses:
type: array
items:
$ref: '#/definitions/InstanceViewStatus'
description: The resource status information.
title: The vm extension instance view.
NodeVMExtension:
type: object
properties:
provisioningState:
type: string
title: The provisioning state of the virtual machine extension.
vmExtension:
$ref: '#/definitions/VMExtension'
title: The virtual machine extension
instanceView:
$ref: '#/definitions/VMExtensionInstanceView'
title: The vm extension instance view.
title: The configuration for virtual machine extension instance view.
NodeVMExtensionList:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/NodeVMExtension'
title: The list of Compute Node extensions.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Compute Node extensions in a Node.
DiffDiskPlacement:
type: string
title: >-
Specifies the ephemeral disk placement for operating system disk for all
compute nodes (VMs) in the pool.
description: >-
This property can be used by user in the request to choose which location
the operating system should be in. e.g., cache disk space for Ephemeral OS
disk provisioning. For more information on Ephemeral OS disk size
requirements, please refer to Ephemeral OS disk size requirements for
Windows VMs at
https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements
and Linux VMs at
https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
enum:
- CacheDisk
x-ms-enum:
name: DiffDiskPlacement
modelAsString: false
values:
- value: CacheDisk
description: The Ephemeral OS Disk is stored on the VM cache.
name: CacheDisk
DiffDiskSettings:
type: object
properties:
placement:
$ref: '#/definitions/DiffDiskPlacement'
title: >-
Specifies the ephemeral disk placement for operating system disk for
all VMs in the pool.
description: >-
This property can be used by user in the request to choose the
location e.g., cache disk space for Ephemeral OS disk provisioning.
For more information on Ephemeral OS disk size requirements, please
refer to Ephemeral OS disk size requirements for Windows VMs at
https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements
and Linux VMs at
https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
title: >-
Specifies the ephemeral Disk Settings for the operating system disk used
by the compute node (VM).
OSDisk:
type: object
properties:
ephemeralOSDiskSettings:
$ref: '#/definitions/DiffDiskSettings'
title: >-
Specifies the ephemeral Disk Settings for the operating system disk
used by the compute node (VM).
caching:
$ref: '#/definitions/CachingType'
title: >-
Specifies the caching requirements. Possible values are: None,
ReadOnly, ReadWrite. The default values are: None for Standard
storage. ReadOnly for Premium storage.
managedDisk:
$ref: '#/definitions/ManagedDisk'
title: The managed disk parameters.
diskSizeGB:
type: integer
format: int32
title: The initial disk size in GB when creating new OS disk.
writeAcceleratorEnabled:
type: boolean
title: >-
Specifies whether writeAccelerator should be enabled or disabled on
the disk.
title: Settings for the operating system disk of the compute node (VM).
IPAddressProvisioningType:
type: string
title: The provisioning type for Public IP Addresses for the Pool.
enum:
- batchmanaged
- usermanaged
- nopublicipaddresses
x-ms-enum:
name: IPAddressProvisioningType
modelAsString: false
values:
- value: batchmanaged
description: >-
A public IP will be created and managed by Batch. There may be
multiple public IPs depending on the size of the Pool.
name: batchManaged
- value: usermanaged
description: >-
Public IPs are provided by the user and will be used to provision
the Compute Nodes.
name: userManaged
- value: nopublicipaddresses
description: No public IP Address will be created.
name: noPublicIPAddresses
PublicIPAddressConfiguration:
type: object
properties:
provision:
$ref: '#/definitions/IPAddressProvisioningType'
title: The provisioning type for Public IP Addresses for the Pool.
description: The default value is BatchManaged.
ipAddressIds:
type: array
items:
type: string
title: >-
The list of public IPs which the Batch service will use when
provisioning Compute Nodes.
description: >-
The number of IPs specified here limits the maximum size of the Pool -
100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated
for each public IP. For example, a pool needing 250 dedicated VMs
would need at least 3 public IPs specified. Each element of this
collection is of the form:
/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
description: >-
The public IP Address configuration of the networking configuration of a
Pool.
NetworkConfiguration:
type: object
properties:
subnetId:
type: string
title: >-
The ARM resource identifier of the virtual network subnet which the
Compute Nodes of the Pool will join. This is of the form
/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
description: >-
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 Compute Nodes in the Pool. If
the subnet doesn't have enough free IP addresses, the Pool will
partially allocate 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 Nodes. This
can be verified by checking if the specified VNet has any associated
Network Security Groups (NSG). If communication to the 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:
https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
externalDocs:
url: >-
https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor
description: Setting up RBAC for Azure Batch VNETs
dynamicVNetAssignmentScope:
type: string
title: The scope of dynamic vnet assignment.
enum:
- none
- job
x-ms-enum:
name: DynamicVNetAssignmentScope
modelAsString: false
values:
- value: none
description: No dynamic VNet assignment is enabled.
- value: job
description: Dynamic VNet assignment is done per-job.
endpointConfiguration:
$ref: '#/definitions/PoolEndpointConfiguration'
title: The configuration for endpoints on Compute Nodes in the Batch Pool.
description: >-
Pool endpoint configuration is only supported on Pools with the
virtualMachineConfiguration property.
publicIPAddressConfiguration:
$ref: '#/definitions/PublicIPAddressConfiguration'
title: >-
The Public IPAddress configuration for Compute Nodes in the Batch
Pool.
description: >-
Public IP configuration property is only supported on Pools with the
virtualMachineConfiguration property.
enableAcceleratedNetworking:
type: boolean
title: Whether this pool should enable accelerated networking.
description: >-
Accelerated networking enables single root I/O virtualization (SR-IOV)
to a VM, which may lead to improved networking performance. For more
details, see:
https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
externalDocs:
url: >-
https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview
description: Create a VM with Accelerated Networking.
description: The network configuration for a Pool.
NodeCommunicationMode:
type: string
title: Determines how a pool communicates with the Batch service.
enum:
- default
- classic
- simplified
x-ms-enum:
name: NodeCommunicationMode
modelAsString: false
values:
- value: default
description: >-
The node communication mode is automatically set by the Batch
service.
- value: classic
description: >-
Nodes using the classic communication mode require inbound TCP
communication on ports 29876 and 29877 from the
"BatchNodeManagement.{region}" service tag and outbound TCP
communication on port 443 to the "Storage.region" and
"BatchNodeManagement.{region}" service tags.
- value: simplified
description: >-
Nodes using the simplified communication mode require outbound TCP
communication on port 443 to the "BatchNodeManagement.{region}"
service tag. No open inbound ports are required.
CloudPool:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Pool within the Account.
description: >-
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).
displayName:
type: string
title: The display name for the Pool.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
url:
type: string
title: The URL of the Pool.
eTag:
type: string
title: The ETag of the Pool.
description: >-
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.
lastModified:
type: string
format: date-time
title: The last modified time of the Pool.
description: >-
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.
creationTime:
type: string
format: date-time
title: The creation time of the Pool.
state:
type: string
title: The current state of the Pool.
enum:
- active
- deleting
x-ms-enum:
name: PoolState
modelAsString: false
values:
- value: active
description: >-
The Pool is available to run Tasks subject to the availability
of Compute Nodes.
- value: deleting
description: >-
The user has requested that the Pool be deleted, but the delete
operation has not yet completed.
stateTransitionTime:
type: string
format: date-time
title: The time at which the Pool entered its current state.
allocationState:
type: string
title: Whether the Pool is resizing.
enum:
- steady
- resizing
- stopping
x-ms-enum:
name: AllocationState
modelAsString: false
values:
- value: steady
description: >-
The Pool is not resizing. There are no changes to the number of
Compute Nodes in the Pool in progress. A Pool enters this state
when it is created and when no operations are being performed on
the Pool to change the number of Compute Nodes.
- value: resizing
description: >-
The Pool is resizing; that is, Compute Nodes are being added to
or removed from the Pool.
- value: stopping
description: >-
The Pool was resizing, but the user has requested that the
resize be stopped, but the stop request has not yet been
completed.
allocationStateTransitionTime:
type: string
format: date-time
title: The time at which the Pool entered its current allocation state.
vmSize:
type: string
title: >-
The size of virtual machines in the Pool. All virtual machines in a
Pool are the same size.
description: >-
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).
cloudServiceConfiguration:
$ref: '#/definitions/CloudServiceConfiguration'
title: The cloud service configuration for the Pool.
description: >-
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'.
virtualMachineConfiguration:
$ref: '#/definitions/VirtualMachineConfiguration'
title: The virtual machine configuration for the Pool.
description: >-
This property and cloudServiceConfiguration are mutually exclusive and
one of the properties must be specified.
resizeTimeout:
type: string
format: duration
title: The timeout for allocation of Compute Nodes to the Pool.
description: >-
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.
resizeErrors:
type: array
items:
$ref: '#/definitions/ResizeError'
title: >-
A list of errors encountered while performing the last resize on the
Pool.
description: >-
This property is set only if one or more errors occurred during the
last Pool resize, and only when the Pool allocationState is Steady.
currentDedicatedNodes:
type: integer
format: int32
title: The number of dedicated Compute Nodes currently in the Pool.
currentLowPriorityNodes:
type: integer
format: int32
title: The number of Spot/Low-priority Compute Nodes currently in the Pool.
description: >-
Spot/Low-priority Compute Nodes which have been preempted are included
in this count.
targetDedicatedNodes:
type: integer
format: int32
title: The desired number of dedicated Compute Nodes in the Pool.
targetLowPriorityNodes:
type: integer
format: int32
title: The desired number of Spot/Low-priority Compute Nodes in the Pool.
enableAutoScale:
type: boolean
title: Whether the Pool size should automatically adjust over time.
description: >-
If false, at least one of targetDedicatedNodes 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.
autoScaleFormula:
type: string
title: A formula for the desired number of Compute Nodes in the Pool.
description: >-
This property is set only if the Pool automatically scales, i.e.
enableAutoScale is true.
autoScaleEvaluationInterval:
type: string
format: duration
title: >-
The time interval at which to automatically adjust the Pool size
according to the autoscale formula.
description: >-
This property is set only if the Pool automatically scales, i.e.
enableAutoScale is true.
autoScaleRun:
$ref: '#/definitions/AutoScaleRun'
title: >-
The results and errors from the last execution of the autoscale
formula.
description: >-
This property is set only if the Pool automatically scales, i.e.
enableAutoScale is true.
enableInterNodeCommunication:
type: boolean
title: Whether the Pool permits direct communication between Compute Nodes.
description: >-
This imposes restrictions on which Compute Nodes can be assigned to
the Pool. Specifying this value can reduce the chance of the requested
number of Compute Nodes to be allocated in the Pool.
networkConfiguration:
$ref: '#/definitions/NetworkConfiguration'
title: The network configuration for the Pool.
startTask:
$ref: '#/definitions/StartTask'
title: A Task specified to run on each Compute Node as it joins the Pool.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: >-
The list of Certificates to be installed on each Compute Node in the
Pool.
description: >-
For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: The list of Packages to be installed on each Compute Node in the Pool.
description: >-
Changes to Package references affect all new Nodes joining the Pool,
but do not affect Compute Nodes that are already in the Pool until
they are rebooted or reimaged. There is a maximum of 10 Package
references on any given Pool.
applicationLicenses:
type: array
items:
type: string
title: >-
The list of application licenses the Batch service will make available
on each Compute Node in the Pool.
description: >-
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.
taskSlotsPerNode:
type: integer
format: int32
title: >-
The number of task slots that can be used to run concurrent tasks on a
single compute node in the pool.
description: >-
The default value is 1. The maximum value is the smaller of 4 times
the number of cores of the vmSize of the pool or 256.
taskSchedulingPolicy:
$ref: '#/definitions/TaskSchedulingPolicy'
title: How Tasks are distributed across Compute Nodes in a Pool.
description: If not specified, the default is spread.
userAccounts:
type: array
items:
$ref: '#/definitions/UserAccount'
title: >-
The list of user Accounts to be created on each Compute Node in the
Pool.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Pool as metadata.
stats:
$ref: '#/definitions/PoolStatistics'
title: >-
Utilization and resource usage statistics for the entire lifetime of
the Pool.
description: >-
This property is populated only if the CloudPool was retrieved with an
expand clause including the 'stats' attribute; otherwise it is null.
The statistics may not be immediately available. The Batch service
performs periodic roll-up of statistics. The typical delay is about 30
minutes.
mountConfiguration:
type: array
items:
$ref: '#/definitions/MountConfiguration'
title: A list of file systems to mount on each node in the pool.
description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
identity:
title: The identity of the Batch pool, if configured.
description: >-
The list of user identities associated with the Batch pool. The user
identity dictionary key references will be ARM resource ids in the
form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
$ref: '#/definitions/BatchPoolIdentity'
targetNodeCommunicationMode:
title: The desired node communication mode for the pool.
description: If omitted, the default value is Default.
$ref: '#/definitions/NodeCommunicationMode'
currentNodeCommunicationMode:
title: The current state of the pool communication mode.
$ref: '#/definitions/NodeCommunicationMode'
x-nullable: true
readOnly: true
upgradePolicy:
$ref: '#/definitions/UpgradePolicy'
title: The upgrade policy for the Pool.
description: Describes an upgrade policy - automatic, manual, or rolling.
resourceTags:
type: object
additionalProperties:
type: string
title: The user-specified tags associated with the pool.
description: >-
The user-defined tags to be associated with the Azure Batch Pool. When
specified, these tags are propagated to the backing Azure resources
associated with the pool. This property can only be specified when the
Batch account was created with the poolAllocationMode property set to
'UserSubscription'.
title: A Pool in the Azure Batch service.
PoolAddParameter:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Pool within the Account.
description: >-
The ID can contain any combination of alphanumeric characters
including hyphens and underscores, and cannot contain more than 64
characters. The ID is case-preserving and case-insensitive (that is,
you may not have two Pool IDs within an Account that differ only by
case).
displayName:
type: string
title: The display name for the Pool.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
vmSize:
type: string
title: >-
The size of virtual machines in the Pool. All virtual machines in a
Pool are the same size.
description: >-
For information about available sizes of virtual machines for Cloud
Services Pools (pools created with cloudServiceConfiguration), see
Sizes for Cloud Services
(https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and
A2V2. For information about available VM sizes for Pools using Images
from the Virtual Machines Marketplace (pools created with
virtualMachineConfiguration) see Sizes for Virtual Machines (Linux)
(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)
or Sizes for Virtual Machines (Windows)
(https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/).
Batch supports all Azure VM sizes except STANDARD_A0 and those with
premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
cloudServiceConfiguration:
$ref: '#/definitions/CloudServiceConfiguration'
title: The cloud service configuration for the Pool.
description: >-
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'.
virtualMachineConfiguration:
$ref: '#/definitions/VirtualMachineConfiguration'
title: The virtual machine configuration for the Pool.
description: >-
This property and cloudServiceConfiguration are mutually exclusive and
one of the properties must be specified.
resizeTimeout:
type: string
format: duration
title: The timeout for allocation of Compute Nodes to the Pool.
description: >-
This timeout applies only to manual scaling; it has no effect when
enableAutoScale is set to true. The default value is 15 minutes. The
minimum value is 5 minutes. If you specify a value less than 5
minutes, the Batch service returns an error; if you are calling the
REST API directly, the HTTP status code is 400 (Bad Request).
targetDedicatedNodes:
type: integer
format: int32
title: The desired number of dedicated Compute Nodes in the Pool.
description: >-
This property must not be specified if enableAutoScale is set to true.
If enableAutoScale is set to false, then you must set either
targetDedicatedNodes, targetLowPriorityNodes, or both.
targetLowPriorityNodes:
type: integer
format: int32
title: The desired number of Spot/Low-priority Compute Nodes in the Pool.
description: >-
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.
enableAutoScale:
type: boolean
title: Whether the Pool size should automatically adjust over time.
description: >-
If false, at least one of targetDedicatedNodes 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.
autoScaleFormula:
type: string
title: A formula for the desired number of Compute Nodes in the Pool.
description: >-
This property must not be specified if enableAutoScale is set to
false. It is required if enableAutoScale is set to true. The formula
is checked for validity before the Pool is created. If the formula is
not valid, the Batch service rejects the request with detailed error
information. For more information about specifying this formula, see
'Automatically scale Compute Nodes in an Azure Batch Pool'
(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
autoScaleEvaluationInterval:
type: string
format: duration
title: >-
The time interval at which to automatically adjust the Pool size
according to the autoscale formula.
description: >-
The default value is 15 minutes. The minimum and maximum value are 5
minutes and 168 hours respectively. If you specify a value less than 5
minutes or greater than 168 hours, the Batch service returns an error;
if you are calling the REST API directly, the HTTP status code is 400
(Bad Request).
enableInterNodeCommunication:
type: boolean
title: Whether the Pool permits direct communication between Compute Nodes.
description: >-
Enabling inter-node communication limits the maximum size of the Pool
due to deployment restrictions on the Compute Nodes of the Pool. This
may result in the Pool not reaching its desired size. The default
value is false.
networkConfiguration:
$ref: '#/definitions/NetworkConfiguration'
title: The network configuration for the Pool.
startTask:
$ref: '#/definitions/StartTask'
title: A Task specified to run on each Compute Node as it joins the Pool.
description: >-
The Task runs when the Compute Node is added to the Pool or when the
Compute Node is restarted.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: >-
The list of Certificates to be installed on each Compute Node in the
Pool.
description: >-
For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: The list of Packages to be installed on each Compute Node in the Pool.
description: >-
When creating a pool, the package's application ID must be fully
qualified
(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
Changes to Package references affect all new Nodes joining the Pool,
but do not affect Compute Nodes that are already in the Pool until
they are rebooted or reimaged. There is a maximum of 10 Package
references on any given Pool.
applicationLicenses:
type: array
items:
type: string
title: >-
The list of application licenses the Batch service will make available
on each Compute Node in the Pool.
description: >-
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.
taskSlotsPerNode:
type: integer
format: int32
title: >-
The number of task slots that can be used to run concurrent tasks on a
single compute node in the pool.
description: >-
The default value is 1. The maximum value is the smaller of 4 times
the number of cores of the vmSize of the pool or 256.
taskSchedulingPolicy:
$ref: '#/definitions/TaskSchedulingPolicy'
title: How Tasks are distributed across Compute Nodes in a Pool.
description: If not specified, the default is spread.
userAccounts:
type: array
items:
$ref: '#/definitions/UserAccount'
title: >-
The list of user Accounts to be created on each Compute Node in the
Pool.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Pool as metadata.
description: >-
The Batch service does not assign any meaning to metadata; it is
solely for the use of user code.
mountConfiguration:
type: array
items:
$ref: '#/definitions/MountConfiguration'
title: >-
Mount storage using specified file system for the entire lifetime of
the pool.
description: >-
Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based
file system.
targetNodeCommunicationMode:
title: The desired node communication mode for the pool.
description: If omitted, the default value is Default.
$ref: '#/definitions/NodeCommunicationMode'
upgradePolicy:
$ref: '#/definitions/UpgradePolicy'
title: The upgrade policy for the Pool.
description: Describes an upgrade policy - automatic, manual, or rolling.
resourceTags:
type: object
additionalProperties:
type: string
title: The user-specified tags associated with the pool.
description: >-
The user-defined tags to be associated with the Azure Batch Pool. When
specified, these tags are propagated to the backing Azure resources
associated with the pool. This property can only be specified when the
Batch account was created with the poolAllocationMode property set to
'UserSubscription'.
required:
- id
- vmSize
title: A Pool in the Azure Batch service to add.
ApplicationListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ApplicationSummary'
title: The list of applications available in the Account.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the applications available in an Account.
CloudPoolListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/CloudPool'
title: The list of Pools.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Pools in an Account.
AffinityInformation:
type: object
properties:
affinityId:
type: string
title: >-
An opaque string representing the location of a Compute Node or a Task
that has run previously.
description: >-
You can pass the affinityId of a Node to indicate that this Task needs
to run on that Compute Node. Note that this is just a soft affinity.
If the target Compute Node is busy or unavailable at the time the Task
is scheduled, then the Task will be scheduled elsewhere.
required:
- affinityId
title: >-
A locality hint that can be used by the Batch service to select a Compute
Node on which to start a Task.
TaskExecutionInformation:
type: object
properties:
startTime:
type: string
format: date-time
title: The time at which the Task started running.
description: >-
'Running' corresponds to the running state, so if the Task specifies
resource files or 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.
endTime:
type: string
format: date-time
title: The time at which the Task completed.
description: This property is set only if the Task is in the Completed state.
exitCode:
type: integer
format: int32
title: The exit code of the program specified on the Task command line.
description: >-
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.
containerInfo:
$ref: '#/definitions/TaskContainerExecutionInformation'
title: Information about the container under which the Task is executing.
description: This property is set only if the Task runs in a container context.
failureInfo:
$ref: '#/definitions/TaskFailureInformation'
title: Information describing the Task failure, if any.
description: >-
This property is set only if the Task is in the completed state and
encountered a failure.
retryCount:
type: integer
format: int32
title: The number of times the Task has been retried by the Batch service.
description: >-
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.
lastRetryTime:
type: string
format: date-time
title: The most recent time at which a retry of the Task started running.
description: >-
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.
requeueCount:
type: integer
format: int32
title: >-
The number of times the Task has been requeued by the Batch service as
the result of a user request.
description: >-
When the user removes Compute 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 Compute Nodes be requeued for execution. This
count tracks how many times the Task has been requeued for these
reasons.
lastRequeueTime:
type: string
format: date-time
title: >-
The most recent time at which the Task has been requeued by the Batch
service as the result of a user request.
description: This property is set only if the requeueCount is nonzero.
result:
$ref: '#/definitions/TaskExecutionResult'
title: The result of the Task execution.
description: >-
If the value is 'failed', then the details of the failure can be found
in the failureInfo property.
required:
- requeueCount
- retryCount
title: Information about the execution of a Task.
ComputeNodeInformation:
type: object
properties:
affinityId:
type: string
title: >-
An identifier for the 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.
nodeUrl:
type: string
title: 'The URL of the Compute Node on which the Task ran. '
poolId:
type: string
title: The ID of the Pool on which the Task ran.
nodeId:
type: string
title: The ID of the Compute Node on which the Task ran.
taskRootDirectory:
type: string
title: The root directory of the Task on the Compute Node.
taskRootDirectoryUrl:
type: string
title: The URL to the root directory of the Task on the Compute Node.
title: Information about the Compute Node on which a Task ran.
NodeAgentInformation:
type: object
properties:
version:
type: string
title: >-
The version of the Batch Compute Node agent running on the Compute
Node.
description: >-
This version number can be checked against the Compute Node agent
release notes located at
https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.
lastUpdateTime:
type: string
format: date-time
title: The time when the Compute Node agent was updated on the Compute Node.
description: >-
This is the most recent time that the Compute Node agent was updated
to a new version.
required:
- version
- lastUpdateTime
title: Information about the Compute Node agent.
description: >-
The Batch Compute Node agent is a program that runs on each Compute Node
in the Pool and provides Batch capability on the Compute Node.
MultiInstanceSettings:
type: object
properties:
numberOfInstances:
type: integer
format: int32
title: The number of Compute Nodes required by the Task.
description: If omitted, the default is 1.
coordinationCommandLine:
type: string
title: >-
The command line to run on all the Compute Nodes to enable them to
coordinate when the primary runs the main Task command.
description: >-
A typical coordination command line launches a background service and
verifies that the service is ready to process inter-node messages.
commonResourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download before running
the coordination command line.
description: >-
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.
required:
- coordinationCommandLine
title: Settings which specify how to run a multi-instance Task.
description: >-
Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI
case, if any of the subtasks fail (for example due to exiting with a
non-zero exit code) the entire multi-instance Task fails. The
multi-instance Task is then terminated and retried, up to its retry limit.
TaskStatistics:
type: object
properties:
url:
type: string
title: The URL of the statistics.
startTime:
type: string
format: date-time
title: The start time of the time range covered by the statistics.
lastUpdateTime:
type: string
format: date-time
title: >-
The time at which the statistics were last updated. All statistics are
limited to the range between startTime and lastUpdateTime.
userCPUTime:
type: string
format: duration
title: >-
The total user mode CPU time (summed across all cores and all Compute
Nodes) consumed by the Task.
kernelCPUTime:
type: string
format: duration
title: >-
The total kernel mode CPU time (summed across all cores and all
Compute Nodes) consumed by the Task.
wallClockTime:
type: string
format: duration
title: The total wall clock time of the Task.
description: >-
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.
readIOps:
type: integer
format: int64
title: The total number of disk read operations made by the Task.
writeIOps:
type: integer
format: int64
title: The total number of disk write operations made by the Task.
readIOGiB:
type: number
format: double
title: The total gibibytes read from disk by the Task.
writeIOGiB:
type: number
format: double
title: The total gibibytes written to disk by the Task.
waitTime:
type: string
format: duration
title: >-
The total wait time of the Task. The wait time for a Task is defined
as the elapsed time between the creation of the Task and the start of
Task execution. (If the Task is retried due to failures, the wait time
is the time to the most recent Task execution.)
required:
- url
- startTime
- lastUpdateTime
- userCPUTime
- kernelCPUTime
- wallClockTime
- readIOps
- writeIOps
- readIOGiB
- writeIOGiB
- waitTime
title: Resource usage statistics for a Task.
TaskDependencies:
type: object
properties:
taskIds:
type: array
items:
type: string
title: >-
The list of Task IDs that this Task depends on. All Tasks in this list
must complete successfully before the dependent Task can be scheduled.
description: >-
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.
taskIdRanges:
type: array
items:
$ref: '#/definitions/TaskIdRange'
title: >-
The list of Task ID ranges that this Task depends on. All Tasks in all
ranges must complete successfully before the dependent Task can be
scheduled.
title: >-
Specifies any dependencies of a Task. Any Task that is explicitly
specified or within a dependency range must complete before the dependant
Task will be scheduled.
TaskIdRange:
type: object
properties:
start:
type: integer
format: int32
title: The first Task ID in the range.
end:
type: integer
format: int32
title: The last Task ID in the range.
title: >-
A range of Task IDs that a Task can depend on. All Tasks with IDs in the
range must complete successfully before the dependent Task can be
scheduled.
description: >-
The start and end of the range are inclusive. For example, if a range has
start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.
required:
- start
- end
CloudTask:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Task within the Job.
description: >-
The ID can contain any combination of alphanumeric characters
including hyphens and underscores, and cannot contain more than 64
characters.
displayName:
type: string
title: A display name for the Task.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
url:
type: string
title: The URL of the Task.
eTag:
type: string
title: The ETag of the Task.
description: >-
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.
lastModified:
type: string
format: date-time
title: The last modified time of the Task.
creationTime:
type: string
format: date-time
title: The creation time of the Task.
exitConditions:
$ref: '#/definitions/ExitConditions'
description: How the Batch service should respond when the Task completes.
state:
title: The current state of the Task.
$ref: '#/definitions/TaskState'
stateTransitionTime:
type: string
format: date-time
title: The time at which the Task entered its current state.
previousState:
title: The previous state of the Task.
description: This property is not set if the Task is in its initial Active state.
$ref: '#/definitions/TaskState'
previousStateTransitionTime:
type: string
format: date-time
title: The time at which the Task entered its previous state.
description: This property is not set if the Task is in its initial Active state.
commandLine:
type: string
title: The command line of the Task.
description: >-
For multi-instance Tasks, the command line is executed as the primary
Task, after the primary Task and all subtasks have finished executing
the coordination command line. The command line does not run under a
shell, and therefore cannot take advantage of shell features such as
environment variable expansion. If you want to take advantage of such
features, you should invoke the shell in the command line, for example
using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in
Linux. If the command line refers to file paths, it should use a
relative path (relative to the Task working directory), or use the
Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: The settings for the container under which the Task runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line.
description: >-
For multi-instance Tasks, the resource files will only be downloaded
to the Compute Node on which the primary Task is executed. There is a
maximum size for the list of resource files. When the max size is
exceeded, the request will fail and the response error code will be
RequestEntityTooLarge. If this occurs, the collection of ResourceFiles
must be reduced in size. This can be achieved using .zip files,
Application Packages, or Docker Containers.
outputFiles:
type: array
items:
$ref: '#/definitions/OutputFile'
title: >-
A list of files that the Batch service will upload from the Compute
Node after running the command line.
description: >-
For multi-instance Tasks, the files will only be uploaded from the
Compute Node on which the primary Task is executed.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the Task.
affinityInfo:
$ref: '#/definitions/AffinityInformation'
title: >-
A locality hint that can be used by the Batch service to select a
Compute Node on which to start the new Task.
constraints:
$ref: '#/definitions/TaskConstraints'
title: The execution constraints that apply to this Task.
requiredSlots:
type: integer
format: int32
title: The number of scheduling slots that the Task requires to run.
description: >-
The default is 1. A Task can only be scheduled to run on a compute
node if the node has enough free scheduling slots available. For
multi-instance Tasks, this must be 1.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the Task runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task.
executionInfo:
$ref: '#/definitions/TaskExecutionInformation'
title: Information about the execution of the Task.
nodeInfo:
$ref: '#/definitions/ComputeNodeInformation'
title: Information about the Compute Node on which the Task ran.
multiInstanceSettings:
$ref: '#/definitions/MultiInstanceSettings'
title: >-
An object that indicates that the Task is a multi-instance Task, and
contains information about how to run the multi-instance Task.
stats:
$ref: '#/definitions/TaskStatistics'
title: Resource usage statistics for the Task.
dependsOn:
$ref: '#/definitions/TaskDependencies'
title: The Tasks that this Task depends on.
description: >-
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.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: >-
A list of Packages that the Batch service will deploy to the Compute
Node before running the command line.
description: >-
Application packages are downloaded and deployed to a shared
directory, not the Task working directory. Therefore, if a referenced
package is already on the Node, and is up to date, then it is not
re-downloaded; the existing copy on the Compute Node is used. If a
referenced Package cannot be installed, for example because the
package has been deleted or because download failed, the Task fails.
authenticationTokenSettings:
title: >-
The settings for an authentication token that the Task can use to
perform Batch service operations.
description: >-
If this property is set, the Batch service provides the Task with an
authentication token which can be used to authenticate Batch service
operations without requiring an Account access key. The token is
provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable.
The operations that the Task can carry out using the token depend on
the settings. For example, a Task can request Job permissions in order
to add other Tasks to the Job, or check the status of the Job or of
other Tasks under the Job.
$ref: '#/definitions/AuthenticationTokenSettings'
title: An Azure Batch Task.
description: >-
Batch will retry Tasks when a recovery operation is triggered on a Node.
Examples of recovery operations include (but are not limited to) when an
unhealthy Node is rebooted or a Compute Node disappeared due to host
failure. Retries due to recovery operations are independent of and are not
counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0,
an internal retry due to a recovery operation may occur. Because of this,
all Tasks should be idempotent. This means Tasks need to tolerate being
interrupted and restarted without causing any corruption or duplicate
data. The best practice for long running Tasks is to use some form of
checkpointing.
TaskAddParameter:
type: object
properties:
id:
type: string
title: A string that uniquely identifies the Task within the Job.
description: >-
The ID can contain any combination of alphanumeric characters
including hyphens and underscores, and cannot contain more than 64
characters. The ID is case-preserving and case-insensitive (that is,
you may not have two IDs within a Job that differ only by case).
displayName:
type: string
title: A display name for the Task.
description: >-
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
commandLine:
type: string
title: The command line of the Task.
description: >-
For multi-instance Tasks, the command line is executed as the primary
Task, after the primary Task and all subtasks have finished executing
the coordination command line. The command line does not run under a
shell, and therefore cannot take advantage of shell features such as
environment variable expansion. If you want to take advantage of such
features, you should invoke the shell in the command line, for example
using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in
Linux. If the command line refers to file paths, it should use a
relative path (relative to the Task working directory), or use the
Batch provided environment variable
(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings:
$ref: '#/definitions/TaskContainerSettings'
title: The settings for the container under which the Task runs.
description: >-
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. Files produced in the container outside of
AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those files.
exitConditions:
$ref: '#/definitions/ExitConditions'
description: How the Batch service should respond when the Task completes.
resourceFiles:
type: array
items:
$ref: '#/definitions/ResourceFile'
title: >-
A list of files that the Batch service will download to the Compute
Node before running the command line.
description: >-
For multi-instance Tasks, the resource files will only be downloaded
to the Compute Node on which the primary Task is executed. There is a
maximum size for the list of resource files. When the max size is
exceeded, the request will fail and the response error code will be
RequestEntityTooLarge. If this occurs, the collection of ResourceFiles
must be reduced in size. This can be achieved using .zip files,
Application Packages, or Docker Containers.
outputFiles:
type: array
items:
$ref: '#/definitions/OutputFile'
title: >-
A list of files that the Batch service will upload from the Compute
Node after running the command line.
description: >-
For multi-instance Tasks, the files will only be uploaded from the
Compute Node on which the primary Task is executed.
environmentSettings:
type: array
items:
$ref: '#/definitions/EnvironmentSetting'
title: A list of environment variable settings for the Task.
affinityInfo:
$ref: '#/definitions/AffinityInformation'
title: >-
A locality hint that can be used by the Batch service to select a
Compute Node on which to start the new Task.
constraints:
$ref: '#/definitions/TaskConstraints'
title: The execution constraints that apply to this Task.
description: >-
If you do not specify constraints, the maxTaskRetryCount is the
maxTaskRetryCount specified for the Job, the maxWallClockTime is
infinite, and the retentionTime is 7 days.
requiredSlots:
type: integer
format: int32
title: The number of scheduling slots that the Task required to run.
description: >-
The default is 1. A Task can only be scheduled to run on a compute
node if the node has enough free scheduling slots available. For
multi-instance Tasks, this must be 1.
userIdentity:
$ref: '#/definitions/UserIdentity'
title: The user identity under which the Task runs.
description: >-
If omitted, the Task runs as a non-administrative user unique to the
Task.
multiInstanceSettings:
$ref: '#/definitions/MultiInstanceSettings'
title: >-
An object that indicates that the Task is a multi-instance Task, and
contains information about how to run the multi-instance Task.
dependsOn:
$ref: '#/definitions/TaskDependencies'
title: The Tasks that this Task depends on.
description: >-
This Task will not be scheduled until all Tasks that it depends on
have completed successfully. If any of those Tasks fail and exhaust
their retry counts, this Task will never be scheduled. If the Job does
not have usesTaskDependencies set to true, and this element is
present, the request fails with error code
TaskDependenciesNotSpecifiedOnJob.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: >-
A list of Packages that the Batch service will deploy to the Compute
Node before running the command line.
description: >-
Application packages are downloaded and deployed to a shared
directory, not the Task working directory. Therefore, if a referenced
package is already on the Node, and is up to date, then it is not
re-downloaded; the existing copy on the Compute Node is used. If a
referenced Package cannot be installed, for example because the
package has been deleted or because download failed, the Task fails.
authenticationTokenSettings:
title: >-
The settings for an authentication token that the Task can use to
perform Batch service operations.
description: >-
If this property is set, the Batch service provides the Task with an
authentication token which can be used to authenticate Batch service
operations without requiring an Account access key. The token is
provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable.
The operations that the Task can carry out using the token depend on
the settings. For example, a Task can request Job permissions in order
to add other Tasks to the Job, or check the status of the Job or of
other Tasks under the Job.
$ref: '#/definitions/AuthenticationTokenSettings'
required:
- id
- commandLine
title: An Azure Batch Task to add.
description: >-
Batch will retry Tasks when a recovery operation is triggered on a Node.
Examples of recovery operations include (but are not limited to) when an
unhealthy Node is rebooted or a Compute Node disappeared due to host
failure. Retries due to recovery operations are independent of and are not
counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0,
an internal retry due to a recovery operation may occur. Because of this,
all Tasks should be idempotent. This means Tasks need to tolerate being
interrupted and restarted without causing any corruption or duplicate
data. The best practice for long running Tasks is to use some form of
checkpointing.
TaskAddCollectionParameter:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/TaskAddParameter'
maxItems: 100
title: The collection of Tasks to add. The maximum count of Tasks is 100.
description: >-
The total serialized size of this collection must be less than 1MB. If
it is greater than 1MB (for example if each Task has 100's of resource
files or environment variables), the request will fail with code
'RequestBodyTooLarge' and should be retried again with fewer Tasks.
required:
- value
title: A collection of Azure Batch Tasks to add.
TaskAddResult:
type: object
properties:
status:
type: string
title: The status of the add Task request.
enum:
- success
- clienterror
- servererror
x-ms-enum:
name: TaskAddStatus
modelAsString: false
values:
- value: success
description: The Task was added successfully.
- value: clienterror
description: >-
The Task failed to add due to a client error and should not be
retried without modifying the request as appropriate.
name: clientError
- value: servererror
description: >-
Task failed to add due to a server error and can be retried
without modification.
name: serverError
taskId:
type: string
title: The ID of the Task for which this is the result.
eTag:
type: string
title: The ETag of the Task, if the Task was successfully added.
description: >-
You can use this to detect whether the Task has changed between
requests. In particular, you can be pass the ETag with an Update Task
request to specify that your changes should take effect only if nobody
else has modified the Job in the meantime.
lastModified:
type: string
format: date-time
title: The last modified time of the Task.
location:
type: string
title: The URL of the Task, if the Task was successfully added.
error:
$ref: '#/definitions/BatchError'
title: The error encountered while attempting to add the Task.
required:
- status
- taskId
title: >-
Result for a single Task added as part of an add Task collection
operation.
TaskAddCollectionResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/TaskAddResult'
title: The results of the add Task collection operation.
title: The result of adding a collection of Tasks to a Job.
SubtaskInformation:
type: object
properties:
id:
type: integer
format: int32
title: The ID of the subtask.
nodeInfo:
$ref: '#/definitions/ComputeNodeInformation'
title: Information about the Compute Node on which the subtask ran.
startTime:
type: string
format: date-time
title: >-
The time at which the subtask started running. If the subtask has been
restarted or retried, this is the most recent time at which the
subtask started running.
endTime:
type: string
format: date-time
title: The time at which the subtask completed.
description: This property is set only if the subtask is in the Completed state.
exitCode:
type: integer
format: int32
title: The exit code of the program specified on the subtask command line.
description: >-
This property is set only if the subtask is in the completed state. In
general, the exit code for a process reflects the specific convention
implemented by the application developer for that process. If you use
the exit code value to make decisions in your code, be sure that you
know the exit code convention used by the application process.
However, if the Batch service terminates the subtask (due to timeout,
or user termination via the API) you may see an operating
system-defined exit code.
containerInfo:
$ref: '#/definitions/TaskContainerExecutionInformation'
title: Information about the container under which the Task is executing.
description: This property is set only if the Task runs in a container context.
failureInfo:
$ref: '#/definitions/TaskFailureInformation'
title: Information describing the Task failure, if any.
description: >-
This property is set only if the Task is in the completed state and
encountered a failure.
state:
title: The current state of the subtask.
$ref: '#/definitions/SubtaskState'
stateTransitionTime:
type: string
format: date-time
title: The time at which the subtask entered its current state.
previousState:
title: The previous state of the subtask.
description: >-
This property is not set if the subtask is in its initial running
state.
$ref: '#/definitions/SubtaskState'
previousStateTransitionTime:
type: string
format: date-time
title: The time at which the subtask entered its previous state.
description: >-
This property is not set if the subtask is in its initial running
state.
result:
$ref: '#/definitions/TaskExecutionResult'
title: The result of the Task execution.
description: >-
If the value is 'failed', then the details of the failure can be found
in the failureInfo property.
title: Information about an Azure Batch subtask.
CloudTaskListSubtasksResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/SubtaskInformation'
title: The list of subtasks.
title: The result of listing the subtasks of a Task.
CloudTaskListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/CloudTask'
title: The list of Tasks.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Tasks in a Job.
TaskInformation:
type: object
properties:
taskUrl:
type: string
title: The URL of the Task.
jobId:
type: string
title: The ID of the Job to which the Task belongs.
taskId:
type: string
title: The ID of the Task.
subtaskId:
type: integer
format: int32
title: The ID of the subtask if the Task is a multi-instance Task.
taskState:
title: The current state of the Task.
$ref: '#/definitions/TaskState'
executionInfo:
$ref: '#/definitions/TaskExecutionInformation'
title: Information about the execution of the Task.
required:
- taskState
title: Information about a Task running on a Compute Node.
StartTaskInformation:
type: object
properties:
state:
type: string
title: The state of the StartTask on the Compute Node.
enum:
- running
- completed
x-ms-enum:
name: StartTaskState
modelAsString: false
values:
- value: running
description: The StartTask is currently running.
- value: completed
description: >-
The StartTask has exited with exit code 0, or the StartTask has
failed and the retry limit has reached, or the StartTask process
did not run due to Task preparation errors (such as resource
file download failures).
startTime:
type: string
format: date-time
title: The time at which the StartTask started running.
description: >-
This value is reset every time the Task is restarted or retried (that
is, this is the most recent time at which the StartTask started
running).
endTime:
type: string
format: date-time
title: The time at which the StartTask stopped running.
description: >-
This is the end time of the most recent run of the StartTask, if that
run has completed (even if that run failed and a retry is pending).
This element is not present if the StartTask is currently running.
exitCode:
type: integer
format: int32
title: The exit code of the program specified on the StartTask command line.
description: >-
This property is set only if the StartTask 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 StartTask (due
to timeout, or user termination via the API) you may see an operating
system-defined exit code.
containerInfo:
$ref: '#/definitions/TaskContainerExecutionInformation'
title: Information about the container under which the Task is executing.
description: This property is set only if the Task runs in a container context.
failureInfo:
$ref: '#/definitions/TaskFailureInformation'
title: Information describing the Task failure, if any.
description: >-
This property is set only if the Task is in the completed state and
encountered a failure.
retryCount:
type: integer
format: int32
title: The number of times the Task has been retried by the Batch service.
description: >-
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.
lastRetryTime:
type: string
format: date-time
title: The most recent time at which a retry of the Task started running.
description: >-
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.
result:
$ref: '#/definitions/TaskExecutionResult'
title: The result of the Task execution.
description: >-
If the value is 'failed', then the details of the failure can be found
in the failureInfo property.
required:
- state
- startTime
- retryCount
title: Information about a StartTask running on a Compute Node.
ComputeNodeError:
type: object
properties:
code:
type: string
title: >-
An identifier for the Compute Node error. Codes are invariant and are
intended to be consumed programmatically.
message:
type: string
title: >-
A message describing the Compute Node error, intended to be suitable
for display in a user interface.
errorDetails:
type: array
items:
$ref: '#/definitions/NameValuePair'
title: >-
The list of additional error details related to the Compute Node
error.
title: An error encountered by a Compute Node.
ComputeNode:
type: object
properties:
id:
type: string
title: The ID of the Compute Node.
description: >-
Every Compute Node that is added to a Pool is assigned a unique ID.
Whenever a Compute Node is removed from a Pool, all of its local files
are deleted, and the ID is reclaimed and could be reused for new
Compute Nodes.
url:
type: string
title: The URL of the Compute Node.
state:
type: string
title: The current state of the Compute Node.
description: >-
The Spot/Low-priority Compute Node has been preempted. Tasks which
were running on the Compute Node when it was preempted will be
rescheduled when another Compute Node becomes available.
enum:
- idle
- rebooting
- reimaging
- running
- unusable
- creating
- starting
- waitingforstarttask
- starttaskfailed
- unknown
- leavingpool
- offline
- preempted
- upgradingos
x-ms-enum:
name: ComputeNodeState
modelAsString: false
values:
- value: idle
description: The Compute Node is not currently running a Task.
- value: rebooting
description: The Compute Node is rebooting.
- value: reimaging
description: The Compute Node is reimaging.
- value: running
description: >-
The Compute Node is running one or more Tasks (other than a
StartTask).
- value: unusable
description: >-
The Compute Node cannot be used for Task execution due to
errors.
- value: creating
description: >-
The Batch service has obtained the underlying virtual machine
from Azure Compute, but it has not yet started to join the Pool.
- value: starting
description: The Batch service is starting on the underlying virtual machine.
- value: waitingforstarttask
description: >-
The StartTask has started running on the Compute Node, but
waitForSuccess is set and the StartTask has not yet completed.
name: waitingForStartTask
- value: starttaskfailed
description: >-
The StartTask has failed on the Compute Node (and exhausted all
retries), and waitForSuccess is set. The Compute Node is not
usable for running Tasks.
name: startTaskFailed
- value: unknown
description: >-
The Batch service has lost contact with the Compute Node, and
does not know its true state.
- value: leavingpool
description: >-
The Compute Node is leaving the Pool, either because the user
explicitly removed it or because the Pool is resizing or
autoscaling down.
name: leavingPool
- value: offline
description: >-
The Compute Node is not currently running a Task, and scheduling
of new Tasks to the Compute Node is disabled.
- value: preempted
description: >-
The Spot/Low-priority Compute Node has been preempted. Tasks
which were running on the Compute Node when it was preempted
will be rescheduled when another Compute Node becomes available.
- value: upgradingos
description: The Compute Node is undergoing an OS upgrade operation.
name: upgradingOS
schedulingState:
type: string
title: Whether the Compute Node is available for Task scheduling.
enum:
- enabled
- disabled
x-ms-enum:
name: SchedulingState
modelAsString: false
values:
- value: enabled
description: Tasks can be scheduled on the Compute Node.
- value: disabled
description: >-
No new Tasks will be scheduled on the Compute Node. Tasks
already running on the Compute Node may still run to completion.
All Compute Nodes start with scheduling enabled.
stateTransitionTime:
type: string
format: date-time
title: The time at which the Compute Node entered its current state.
lastBootTime:
type: string
format: date-time
title: The last time at which the Compute Node was started.
description: >-
This property may not be present if the Compute Node state is
unusable.
allocationTime:
type: string
format: date-time
title: The time at which this Compute Node was allocated to the Pool.
description: >-
This is the time when the Compute Node was initially allocated and
doesn't change once set. It is not updated when the Compute Node is
service healed or preempted.
ipAddress:
type: string
title: >-
The IP address that other Nodes can use to communicate with this
Compute Node.
description: >-
Every Compute Node that is added to a Pool is assigned a unique IP
address. Whenever a Compute 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 Compute Nodes.
affinityId:
type: string
title: >-
An identifier which can be passed when adding a Task to request that
the Task be scheduled on this Compute Node.
description: >-
Note that this is just a soft affinity. If the target Compute Node is
busy or unavailable at the time the Task is scheduled, then the Task
will be scheduled elsewhere.
vmSize:
type: string
title: The size of the virtual machine hosting the Compute Node.
description: >-
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).
totalTasksRun:
type: integer
format: int32
title: >-
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.
runningTasksCount:
type: integer
format: int32
title: >-
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.
runningTaskSlotsCount:
type: integer
format: int32
title: >-
The total number of scheduling slots used by 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.
totalTasksSucceeded:
type: integer
format: int32
title: >-
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.
recentTasks:
type: array
items:
$ref: '#/definitions/TaskInformation'
title: A list of Tasks whose state has recently changed.
description: >-
This property is present only if at least one Task has run on this
Compute Node since it was assigned to the Pool.
startTask:
$ref: '#/definitions/StartTask'
title: The Task specified to run on the Compute Node as it joins the Pool.
startTaskInfo:
$ref: '#/definitions/StartTaskInformation'
title: >-
Runtime information about the execution of the StartTask on the
Compute Node.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: The list of Certificates installed on the Compute Node.
description: >-
For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
errors:
type: array
items:
$ref: '#/definitions/ComputeNodeError'
title: >-
The list of errors that are currently being encountered by the Compute
Node.
isDedicated:
type: boolean
title: >-
Whether this Compute Node is a dedicated Compute Node. If false, the
Compute Node is a Spot/Low-priority Compute Node.
endpointConfiguration:
$ref: '#/definitions/ComputeNodeEndpointConfiguration'
title: The endpoint configuration for the Compute Node.
nodeAgentInfo:
$ref: '#/definitions/NodeAgentInformation'
title: >-
Information about the Compute Node agent version and the time the
Compute Node upgraded to a new version.
virtualMachineInfo:
$ref: '#/definitions/VirtualMachineInfo'
title: Info about the current state of the virtual machine.
title: A Compute Node in the Batch service.
VirtualMachineInfo:
type: object
title: Info about the current state of the virtual machine.
properties:
imageReference:
$ref: '#/definitions/ImageReference'
title: The reference to the Azure Virtual Machine's Marketplace Image.
scaleSetVmResourceId:
type: string
title: >-
The resource ID of the Compute Node's current Virtual Machine Scale
Set VM. Only defined if the Batch Account was created with its
poolAllocationMode property set to 'UserSubscription'.
PoolEndpointConfiguration:
type: object
properties:
inboundNATPools:
type: array
items:
$ref: '#/definitions/InboundNATPool'
title: >-
A list of inbound NAT Pools that can be used to address specific ports
on an individual Compute Node externally.
description: >-
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. This cannot be specified if the
IPAddressProvisioningType is NoPublicIPAddresses.
required:
- inboundNATPools
title: The endpoint configuration for a Pool.
InboundNATPool:
type: object
properties:
name:
type: string
title: The name of the endpoint.
description: >-
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.
protocol:
$ref: '#/definitions/InboundEndpointProtocol'
title: The protocol of the endpoint.
backendPort:
type: integer
format: int32
title: The port number on the Compute Node.
description: >-
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.
frontendPortRangeStart:
type: integer
format: int32
title: >-
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.
description: >-
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.
frontendPortRangeEnd:
type: integer
format: int32
title: >-
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.
description: >-
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.
networkSecurityGroupRules:
type: array
title: >-
A list of network security group rules that will be applied to the
endpoint.
description: >-
The maximum number of rules that can be specified across all the
endpoints on a Batch Pool is 25. If no network security group rules
are specified, a default rule will be created to allow inbound access
to the specified backendPort. If the maximum number of network
security group rules is exceeded the request fails with HTTP status
code 400.
items:
$ref: '#/definitions/NetworkSecurityGroupRule'
required:
- name
- protocol
- backendPort
- frontendPortRangeStart
- frontendPortRangeEnd
title: >-
A inbound NAT Pool that can be used to address specific ports on Compute
Nodes in a Batch Pool externally.
NetworkSecurityGroupRule:
type: object
properties:
priority:
type: integer
format: int32
title: The priority for this rule.
description: >-
Priorities within a Pool must be unique and are evaluated in order of
priority. The lower the number the higher the priority. For example,
rules could be specified with order numbers of 150, 250, and 350. The
rule with the order number of 150 takes precedence over the rule that
has an order of 250. Allowed priorities are 150 to 4096. If any
reserved or duplicate values are provided the request fails with HTTP
status code 400.
access:
type: string
title: >-
The action that should be taken for a specified IP address, subnet
range or tag.
enum:
- allow
- deny
x-ms-enum:
name: NetworkSecurityGroupRuleAccess
modelAsString: false
values:
- value: allow
description: Allow access.
- value: deny
description: Deny access.
sourceAddressPrefix:
type: string
title: The source address prefix or tag to match for the rule.
description: >-
Valid values are a single IP address (i.e. 10.10.10.10), IP subnet
(i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any
other values are provided the request fails with HTTP status code 400.
sourcePortRanges:
type: array
items:
type: string
title: The source port ranges to match for the rule.
description: >-
Valid values are '*' (for all ports 0 - 65535), a specific port (i.e.
22), or a port range (i.e. 100-200). The ports must be in the range of
0 to 65535. Each entry in this collection must not overlap any other
entry (either a range or an individual port). If any other values are
provided the request fails with HTTP status code 400. The default
value is '*'.
required:
- priority
- access
- sourceAddressPrefix
title: A network security group rule to apply to an inbound endpoint.
ComputeNodeEndpointConfiguration:
type: object
properties:
inboundEndpoints:
type: array
items:
$ref: '#/definitions/InboundEndpoint'
title: The list of inbound endpoints that are accessible on the Compute Node.
required:
- inboundEndpoints
title: The endpoint configuration for the Compute Node.
InboundEndpoint:
type: object
properties:
name:
type: string
title: The name of the endpoint.
protocol:
$ref: '#/definitions/InboundEndpointProtocol'
title: The protocol of the endpoint.
publicIPAddress:
type: string
title: The public IP address of the Compute Node.
publicFQDN:
type: string
title: The public fully qualified domain name for the Compute Node.
frontendPort:
type: integer
format: int32
title: The public port number of the endpoint.
backendPort:
type: integer
format: int32
title: The backend port number of the endpoint.
required:
- name
- protocol
- publicIPAddress
- publicFQDN
- frontendPort
- backendPort
title: An inbound endpoint on a Compute Node.
ComputeNodeListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ComputeNode'
title: The list of Compute Nodes.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Compute Nodes in a Pool.
ComputeNodeUser:
type: object
properties:
name:
type: string
title: The user name of the Account.
isAdmin:
type: boolean
title: Whether the Account should be an administrator on the Compute Node.
description: The default value is false.
expiryTime:
type: string
format: date-time
title: The time at which the Account should expire.
description: >-
If omitted, the default is 1 day from the current time. For Linux
Compute Nodes, the expiryTime has a precision up to a day.
password:
type: string
title: The password of the Account.
description: >-
The password is required for Windows Compute 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.
sshPublicKey:
type: string
title: >-
The SSH public key that can be used for remote login to the Compute
Node.
description: >-
The public key should be compatible with OpenSSH encoding and should
be base 64 encoded. This property can be specified only for Linux
Compute Nodes. If this is specified for a Windows Compute Node, then
the Batch service rejects the request; if you are calling the REST API
directly, the HTTP status code is 400 (Bad Request).
required:
- name
title: A user Account for RDP or SSH access on a Compute Node.
ComputeNodeGetRemoteLoginSettingsResult:
type: object
properties:
remoteLoginIPAddress:
type: string
title: The IP address used for remote login to the Compute Node.
remoteLoginPort:
type: integer
format: int32
title: The port used for remote login to the Compute Node.
required:
- remoteLoginIPAddress
- remoteLoginPort
title: The remote login settings for a Compute Node.
JobSchedulePatchParameter:
type: object
properties:
schedule:
$ref: '#/definitions/Schedule'
title: The schedule according to which Jobs will be created.
description: >-
All times are fixed respective to UTC and are not impacted by daylight
saving time. If you do not specify this element, the existing schedule
is left unchanged.
jobSpecification:
$ref: '#/definitions/JobSpecification'
title: The details of the Jobs to be created on this schedule.
description: >-
Updates affect only Jobs that are started after the update has taken
place. Any currently active Job continues with the older
specification.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: >-
A list of name-value pairs associated with the Job Schedule as
metadata.
description: >-
If you do not specify this element, existing metadata is left
unchanged.
title: The set of changes to be made to a Job Schedule.
JobScheduleUpdateParameter:
type: object
properties:
schedule:
$ref: '#/definitions/Schedule'
title: The schedule according to which Jobs will be created.
description: >-
All times are fixed respective to UTC and are not impacted by daylight
saving time. If you do not specify this element, it is equivalent to
passing the default schedule: that is, a single Job scheduled to run
immediately.
jobSpecification:
$ref: '#/definitions/JobSpecification'
title: Details of the Jobs to be created on this schedule.
description: >-
Updates affect only Jobs that are started after the update has taken
place. Any currently active Job continues with the older
specification.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: >-
A list of name-value pairs associated with the Job Schedule as
metadata.
description: >-
If you do not specify this element, it takes the default value of an
empty list; in effect, any existing metadata is deleted.
required:
- schedule
- jobSpecification
title: The set of changes to be made to a Job Schedule.
JobDisableParameter:
type: object
properties:
disableTasks:
type: string
title: What to do with active Tasks associated with the Job.
enum:
- requeue
- terminate
- wait
x-ms-enum:
name: DisableJobOption
modelAsString: false
values:
- value: requeue
description: >-
Terminate running Tasks and requeue them. The Tasks will run
again when the Job is enabled.
- value: terminate
description: >-
Terminate running Tasks. The Tasks will be completed with
failureInfo indicating that they were terminated, and will not
run again.
- value: wait
description: Allow currently running Tasks to complete.
required:
- disableTasks
title: Options when disabling a Job.
JobTerminateParameter:
type: object
properties:
terminateReason:
type: string
title: >-
The text you want to appear as the Job's TerminateReason. The default
is 'UserTerminate'.
title: Options when terminating a Job.
JobPatchParameter:
type: object
properties:
priority:
type: integer
format: int32
title: The priority of the Job.
description: >-
Priority values can range from -1000 to 1000, with -1000 being the
lowest priority and 1000 being the highest priority. If omitted, the
priority of the Job is left unchanged.
maxParallelTasks:
type: integer
format: int32
title: >-
The maximum number of tasks that can be executed in parallel for the
job.
description: >-
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once. You
can update a job's maxParallelTasks after it has been created using
the update job API.
allowTaskPreemption:
type: boolean
title: Whether Tasks in this job can be preempted by other high priority jobs
description: >-
If the value is set to True, other high priority jobs submitted to the
system will take precedence and will be able requeue tasks from this
job. You can update a job's allowTaskPreemption after it has been
created using the update job API.
onAllTasksComplete:
title: >-
The action the Batch service should take when all Tasks in the Job are
in the completed state.
description: >-
If omitted, the completion behavior is left unchanged. You may not
change the value from terminatejob to noaction - that is, once you
have engaged automatic Job termination, you cannot turn it off again.
If you try to do this, the request fails with an 'invalid property
value' error response; if you are calling the REST API directly, the
HTTP status code is 400 (Bad Request).
$ref: '#/definitions/OnAllTasksComplete'
constraints:
$ref: '#/definitions/JobConstraints'
title: The execution constraints for the Job.
description: If omitted, the existing execution constraints are left unchanged.
poolInfo:
$ref: '#/definitions/PoolInformation'
title: The Pool on which the Batch service runs the Job's Tasks.
description: >-
You may change the Pool for a Job only when the Job is disabled. The
Patch Job call will fail if you include the poolInfo element and the
Job is not disabled. If you specify an autoPoolSpecification in the
poolInfo, only the keepAlive property of the autoPoolSpecification can
be updated, and then only if the autoPoolSpecification has a
poolLifetimeOption of Job (other job properties can be updated as
normal). If omitted, the Job continues to run on its current Pool.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Job as metadata.
description: If omitted, the existing Job metadata is left unchanged.
title: The set of changes to be made to a Job.
JobUpdateParameter:
type: object
properties:
priority:
type: integer
format: int32
title: The priority of the Job.
description: >-
Priority values can range from -1000 to 1000, with -1000 being the
lowest priority and 1000 being the highest priority. If omitted, it is
set to the default value 0.
maxParallelTasks:
type: integer
format: int32
default: -1
title: >-
The maximum number of tasks that can be executed in parallel for the
job.
description: >-
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once. You
can update a job's maxParallelTasks after it has been created using
the update job API.
allowTaskPreemption:
type: boolean
title: Whether Tasks in this job can be preempted by other high priority jobs
description: >-
If the value is set to True, other high priority jobs submitted to the
system will take precedence and will be able requeue tasks from this
job. You can update a job's allowTaskPreemption after it has been
created using the update job API.
constraints:
$ref: '#/definitions/JobConstraints'
title: The execution constraints for the Job.
description: If omitted, the constraints are cleared.
poolInfo:
$ref: '#/definitions/PoolInformation'
title: The Pool on which the Batch service runs the Job's Tasks.
description: >-
You may change the Pool for a Job only when the Job is disabled. The
Update Job call will fail if you include the poolInfo element and the
Job is not disabled. If you specify an autoPoolSpecification in the
poolInfo, only the keepAlive property of the autoPoolSpecification can
be updated, and then only if the autoPoolSpecification has a
poolLifetimeOption of Job (other job properties can be updated as
normal).
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Job as metadata.
description: >-
If omitted, it takes the default value of an empty list; in effect,
any existing metadata is deleted.
onAllTasksComplete:
title: >-
The action the Batch service should take when all Tasks in the Job are
in the completed state.
description: >-
If omitted, the completion behavior is set to noaction. If the current
value is terminatejob, this is an error because a Job's completion
behavior may not be changed from terminatejob to noaction. You may not
change the value from terminatejob to noaction - that is, once you
have engaged automatic Job termination, you cannot turn it off again.
If you try to do this, the request fails and Batch returns status code
400 (Bad Request) and an 'invalid property value' error response. If
you do not specify this element in a PUT request, it is equivalent to
passing noaction. This is an error if the current value is
terminatejob.
$ref: '#/definitions/OnAllTasksComplete'
required:
- poolInfo
title: The set of changes to be made to a Job.
PoolEnableAutoScaleParameter:
type: object
properties:
autoScaleFormula:
type: string
title: The formula for the desired number of Compute Nodes in the Pool.
description: >-
The formula is checked for validity before it is applied to the Pool.
If the formula is not valid, the Batch service rejects the request
with detailed error information. For more information about specifying
this formula, see Automatically scale Compute Nodes in an Azure Batch
Pool
(https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
autoScaleEvaluationInterval:
type: string
format: duration
title: >-
The time interval at which to automatically adjust the Pool size
according to the autoscale formula.
description: >-
The default value is 15 minutes. The minimum and maximum value are 5
minutes and 168 hours respectively. If you specify a value less than 5
minutes or greater than 168 hours, the Batch service rejects the
request with an invalid property value error; if you are calling the
REST API directly, the HTTP status code is 400 (Bad Request). If you
specify a new interval, then the existing autoscale evaluation
schedule will be stopped and a new autoscale evaluation schedule will
be started, with its starting time being the time when this request
was issued.
title: Options for enabling automatic scaling on a Pool.
PoolEvaluateAutoScaleParameter:
type: object
properties:
autoScaleFormula:
type: string
title: The formula for the desired number of Compute Nodes in the Pool.
description: >-
The formula is validated and its results calculated, but it is not
applied to the Pool. To apply the formula to the Pool, 'Enable
automatic scaling on a Pool'. For more information about specifying
this formula, see Automatically scale Compute Nodes in an Azure Batch
Pool
(https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
required:
- autoScaleFormula
title: Options for evaluating an automatic scaling formula on a Pool.
PoolResizeParameter:
type: object
properties:
targetDedicatedNodes:
type: integer
format: int32
title: The desired number of dedicated Compute Nodes in the Pool.
targetLowPriorityNodes:
type: integer
format: int32
title: The desired number of Spot/Low-priority Compute Nodes in the Pool.
resizeTimeout:
type: string
format: duration
title: >-
The timeout for allocation of Nodes to the Pool or removal of Compute
Nodes from the Pool.
description: >-
The default value is 15 minutes. The minimum value is 5 minutes. If
you specify a value less than 5 minutes, the Batch service returns an
error; if you are calling the REST API directly, the HTTP status code
is 400 (Bad Request).
nodeDeallocationOption:
title: >-
Determines what to do with a Compute Node and its running task(s) if
the Pool size is decreasing.
description: The default value is requeue.
$ref: '#/definitions/ComputeNodeDeallocationOption'
title: Options for changing the size of a Pool.
PoolUpdatePropertiesParameter:
type: object
properties:
startTask:
$ref: '#/definitions/StartTask'
title: >-
A Task to run on each Compute Node as it joins the Pool. The Task runs
when the Compute Node is added to the Pool or when the Compute Node is
restarted.
description: >-
If this element is present, it overwrites any existing StartTask. If
omitted, any existing StartTask is removed from the Pool.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: >-
A list of Certificates to be installed on each Compute Node in the
Pool.
description: >-
This list replaces any existing Certificate references configured on
the Pool. If you specify an empty collection, any existing Certificate
references are removed from the Pool. For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: >-
The list of Application Packages to be installed on each Compute Node
in the Pool.
description: >-
The list replaces any existing Application Package references on the
Pool. Changes to Application Package references affect all new Compute
Nodes joining the Pool, but do not affect Compute Nodes that are
already in the Pool until they are rebooted or reimaged. There is a
maximum of 10 Application Package references on any given Pool. If
omitted, or if you specify an empty collection, any existing
Application Packages references are removed from the Pool. A maximum
of 10 references may be specified on a given Pool.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Pool as metadata.
description: >-
This list replaces any existing metadata configured on the Pool. If
omitted, or if you specify an empty collection, any existing metadata
is removed from the Pool.
targetNodeCommunicationMode:
title: The desired node communication mode for the pool.
description: >-
This setting replaces any existing targetNodeCommunication setting on
the Pool. If omitted, the existing setting is default.
$ref: '#/definitions/NodeCommunicationMode'
required:
- certificateReferences
- metadata
- applicationPackageReferences
title: The set of changes to be made to a Pool.
PoolPatchParameter:
type: object
properties:
startTask:
$ref: '#/definitions/StartTask'
title: >-
A Task to run on each Compute Node as it joins the Pool. The Task runs
when the Compute Node is added to the Pool or when the Compute Node is
restarted.
description: >-
If this element is present, it overwrites any existing StartTask. If
omitted, any existing StartTask is left unchanged.
certificateReferences:
type: array
items:
$ref: '#/definitions/CertificateReference'
title: >-
A list of Certificates to be installed on each Compute Node in the
Pool.
description: >-
If this element is present, it replaces any existing Certificate
references configured on the Pool. If omitted, any existing
Certificate references are left unchanged. For Windows 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.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
applicationPackageReferences:
type: array
items:
$ref: '#/definitions/ApplicationPackageReference'
title: A list of Packages to be installed on each Compute Node in the Pool.
description: >-
Changes to Package references affect all new Nodes joining the Pool,
but do not affect Compute Nodes that are already in the Pool until
they are rebooted or reimaged. If this element is present, it replaces
any existing Package references. If you specify an empty collection,
then all Package references are removed from the Pool. If omitted, any
existing Package references are left unchanged.
metadata:
type: array
items:
$ref: '#/definitions/MetadataItem'
title: A list of name-value pairs associated with the Pool as metadata.
description: >-
If this element is present, it replaces any existing metadata
configured on the Pool. If you specify an empty collection, any
metadata is removed from the Pool. If omitted, any existing metadata
is left unchanged.
targetNodeCommunicationMode:
title: The desired node communication mode for the pool.
description: >-
If this element is present, it replaces the existing
targetNodeCommunicationMode configured on the Pool. If omitted, any
existing metadata is left unchanged.
$ref: '#/definitions/NodeCommunicationMode'
title: The set of changes to be made to a Pool.
TaskUpdateParameter:
type: object
properties:
constraints:
$ref: '#/definitions/TaskConstraints'
title: Constraints that apply to this Task.
description: >-
If omitted, the Task is given the default constraints. For
multi-instance Tasks, updating the retention time applies only to the
primary Task and not subtasks.
title: The set of changes to be made to a Task.
NodeUpdateUserParameter:
type: object
properties:
password:
type: string
title: The password of the Account.
description: >-
The password is required for Windows Compute Nodes (those created with
'cloudServiceConfiguration', or created with
'virtualMachineConfiguration' using a Windows Image reference). For
Linux Compute Nodes, the password can optionally be specified along
with the sshPublicKey property. If omitted, any existing password is
removed.
expiryTime:
type: string
format: date-time
title: The time at which the Account should expire.
description: >-
If omitted, the default is 1 day from the current time. For Linux
Compute Nodes, the expiryTime has a precision up to a day.
sshPublicKey:
type: string
title: >-
The SSH public key that can be used for remote login to the Compute
Node.
description: >-
The public key should be compatible with OpenSSH encoding and should
be base 64 encoded. This property can be specified only for Linux
Compute Nodes. If this is specified for a Windows Compute Node, then
the Batch service rejects the request; if you are calling the REST API
directly, the HTTP status code is 400 (Bad Request). If omitted, any
existing SSH public key is removed.
title: The set of changes to be made to a user Account on a Compute Node.
NodeRebootParameter:
type: object
properties:
nodeRebootOption:
type: string
title: >-
When to reboot the Compute Node and what to do with currently running
Tasks.
description: The default value is requeue.
enum:
- requeue
- terminate
- taskcompletion
- retaineddata
x-ms-enum:
name: ComputeNodeRebootOption
modelAsString: false
values:
- value: requeue
description: >-
Terminate running Task processes and requeue the Tasks. The
Tasks will run again when a Compute Node is available. Restart
the Compute Node as soon as Tasks have been terminated.
- value: terminate
description: >-
Terminate running Tasks. The Tasks will be completed with
failureInfo indicating that they were terminated, and will not
run again. Restart the Compute Node as soon as Tasks have been
terminated.
- value: taskcompletion
description: >-
Allow currently running Tasks to complete. Schedule no new Tasks
while waiting. Restart the Compute Node when all Tasks have
completed.
name: taskCompletion
- value: retaineddata
description: >-
Allow currently running Tasks to complete, then wait for all
Task data retention periods to expire. Schedule no new Tasks
while waiting. Restart the Compute Node when all Task retention
periods have expired.
name: retainedData
title: Options for rebooting a Compute Node.
NodeReimageParameter:
type: object
properties:
nodeReimageOption:
type: string
title: >-
When to reimage the Compute Node and what to do with currently running
Tasks.
description: The default value is requeue.
enum:
- requeue
- terminate
- taskcompletion
- retaineddata
x-ms-enum:
name: ComputeNodeReimageOption
modelAsString: false
values:
- value: requeue
description: >-
Terminate running Task processes and requeue the Tasks. The
Tasks will run again when a Compute Node is available. Reimage
the Compute Node as soon as Tasks have been terminated.
- value: terminate
description: >-
Terminate running Tasks. The Tasks will be completed with
failureInfo indicating that they were terminated, and will not
run again. Reimage the Compute Node as soon as Tasks have been
terminated.
- value: taskcompletion
description: >-
Allow currently running Tasks to complete. Schedule no new Tasks
while waiting. Reimage the Compute Node when all Tasks have
completed.
name: taskCompletion
- value: retaineddata
description: >-
Allow currently running Tasks to complete, then wait for all
Task data retention periods to expire. Schedule no new Tasks
while waiting. Reimage the Compute Node when all Task retention
periods have expired.
name: retainedData
title: Options for reimaging a Compute Node.
NodeDisableSchedulingParameter:
type: object
properties:
nodeDisableSchedulingOption:
type: string
title: >-
What to do with currently running Tasks when disabling Task scheduling
on the Compute Node.
description: The default value is requeue.
enum:
- requeue
- terminate
- taskcompletion
x-ms-enum:
name: DisableComputeNodeSchedulingOption
modelAsString: false
values:
- value: requeue
description: >-
Terminate running Task processes and requeue the Tasks. The
Tasks may run again on other Compute Nodes, or when Task
scheduling is re-enabled on this Compute Node. Enter offline
state as soon as Tasks have been terminated.
- value: terminate
description: >-
Terminate running Tasks. The Tasks will be completed with
failureInfo indicating that they were terminated, and will not
run again. Enter offline state as soon as Tasks have been
terminated.
- value: taskcompletion
description: >-
Allow currently running Tasks to complete. Schedule no new Tasks
while waiting. Enter offline state when all Tasks have
completed.
name: taskCompletion
title: Options for disabling scheduling on a Compute Node.
NodeRemoveParameter:
type: object
properties:
nodeList:
type: array
maxItems: 100
items:
type: string
title: >-
A list containing the IDs of the Compute Nodes to be removed from the
specified Pool.
description: A maximum of 100 nodes may be removed per request.
resizeTimeout:
type: string
format: duration
title: The timeout for removal of Compute Nodes to the Pool.
description: >-
The default value is 15 minutes. The minimum value is 5 minutes. If
you specify a value less than 5 minutes, the Batch service returns an
error; if you are calling the REST API directly, the HTTP status code
is 400 (Bad Request).
nodeDeallocationOption:
title: >-
Determines what to do with a Compute Node and its running task(s)
after it has been selected for deallocation.
description: The default value is requeue.
$ref: '#/definitions/ComputeNodeDeallocationOption'
required:
- nodeList
title: Options for removing Compute Nodes from a Pool.
OutputFile:
type: object
properties:
filePattern:
type: string
title: A pattern indicating which file(s) to upload.
description: >-
Both relative and absolute paths are supported. Relative paths are
relative to the Task working directory. The following wildcards are
supported: * matches 0 or more characters (for example pattern abc*
would match abc or abcdef), ** matches any directory, ? matches any
single character, [abc] matches one character in the brackets, and
[a-c] matches one character in the range. Brackets can include a
negation to match any character not specified (for example [!abc]
matches any character but a, b, or c). If a file name starts with "."
it is ignored by default but may be matched by specifying it
explicitly (for example *.gif will not match .a.gif, but .*.gif will).
A simple example: **\*.txt matches any file that does not start in '.'
and ends with .txt in the Task working directory or any subdirectory.
If the filename contains a wildcard character it can be escaped using
brackets (for example abc[*] would match a file named abc*). Note that
both \ and / are treated as directory separators on Windows, but only
/ is on Linux. Environment variables (%var% on Windows or $var on
Linux) are expanded prior to the pattern being applied.
destination:
title: The destination for the output file(s).
$ref: '#/definitions/OutputFileDestination'
uploadOptions:
title: >-
Additional options for the upload operation, including under what
conditions to perform the upload.
$ref: '#/definitions/OutputFileUploadOptions'
required:
- filePattern
- destination
- uploadOptions
title: >-
A specification for uploading files from an Azure Batch Compute Node to
another location after the Batch service has finished executing the Task
process.
description: >-
On every file uploads, Batch service writes two log files to the compute
node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are
used to learn more about a specific failure.
OutputFileDestination:
type: object
properties:
container:
title: A location in Azure blob storage to which files are uploaded.
$ref: '#/definitions/OutputFileBlobContainerDestination'
title: The destination to which a file should be uploaded.
OutputFileBlobContainerDestination:
type: object
properties:
path:
type: string
title: >-
The destination blob or virtual directory within the Azure Storage
container.
description: >-
If filePattern refers to a specific file (i.e. contains no wildcards),
then path is the name of the blob to which to upload that file. If
filePattern contains one or more wildcards (and therefore may match
multiple files), then path is the name of the blob virtual directory
(which is prepended to each blob name) to which to upload the file(s).
If omitted, file(s) are uploaded to the root of the container with a
blob name matching their file name.
containerUrl:
type: string
title: >-
The URL of the container within Azure Blob Storage to which to upload
the file(s).
description: >-
If not using a managed identity, the URL must include a Shared Access
Signature (SAS) granting write permissions to the container.
identityReference:
title: >-
The reference to the user assigned identity to use to access Azure
Blob Storage specified by containerUrl
description: >-
The identity must have write access to the Azure Blob Storage
container
$ref: '#/definitions/ComputeNodeIdentityReference'
uploadHeaders:
type: array
items:
$ref: '#/definitions/HttpHeader'
title: >-
A list of name-value pairs for headers to be used in uploading output
files
description: >-
These headers will be specified when uploading files to Azure Storage.
Official document on allowed headers when uploading blobs:
https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types
required:
- containerUrl
title: >-
Specifies a file upload destination within an Azure blob storage
container.
OutputFileUploadOptions:
type: object
properties:
uploadCondition:
title: >-
The conditions under which the Task output file or set of files should
be uploaded.
description: The default is taskcompletion.
$ref: '#/definitions/OutputFileUploadCondition'
required:
- uploadCondition
title: >-
Details about an output file upload operation, including under what
conditions to perform the upload.
ErrorMessage:
type: object
properties:
lang:
type: string
title: The language code of the error message
value:
type: string
title: The text of the message.
title: An error message received in an Azure Batch error response.
BatchErrorDetail:
type: object
properties:
key:
type: string
title: An identifier specifying the meaning of the Value property.
value:
type: string
title: The additional information included with the error response.
title: >-
An item of additional information included in an Azure Batch error
response.
BatchError:
type: object
properties:
code:
type: string
title: >-
An identifier for the error. Codes are invariant and are intended to
be consumed programmatically.
message:
$ref: '#/definitions/ErrorMessage'
title: >-
A message describing the error, intended to be suitable for display in
a user interface.
values:
type: array
items:
$ref: '#/definitions/BatchErrorDetail'
title: >-
A collection of key-value pairs containing additional details about
the error.
title: An error response received from the Azure Batch service.
CertificateState:
type: string
title: The state of the Certificate.
enum:
- active
- deleting
- deletefailed
x-ms-enum:
name: CertificateState
modelAsString: false
values:
- value: active
description: The Certificate is available for use in Pools.
- value: deleting
description: >-
The user has requested that the Certificate be deleted, but the
delete operation has not yet completed. You may not reference the
Certificate when creating or updating Pools.
- value: deletefailed
description: >-
The user requested that the Certificate be deleted, but there are
Pools that still have references to the Certificate, or it is still
installed on one or more Nodes. (The latter can occur if the
Certificate has been removed from the Pool, but the Compute Node has
not yet restarted. Compute Nodes refresh their Certificates only
when they restart.) You may use the cancel Certificate delete
operation to cancel the delete, or the delete Certificate operation
to retry the delete.
name: deleteFailed
ElevationLevel:
type: string
title: The elevation level of the user.
enum:
- nonadmin
- admin
x-ms-enum:
name: ElevationLevel
modelAsString: false
values:
- value: nonadmin
description: The user is a standard user without elevated access.
name: nonAdmin
- value: admin
description: >-
The user is a user with elevated access and operates with full
Administrator permissions.
JobScheduleState:
type: string
title: The state of the Job Schedule.
enum:
- active
- completed
- disabled
- terminating
- deleting
x-ms-enum:
name: JobScheduleState
modelAsString: false
values:
- value: active
description: The Job Schedule is active and will create Jobs as per its schedule.
- value: completed
description: >-
The Job Schedule has terminated, either by reaching its end time or
by the user terminating it explicitly.
- value: disabled
description: >-
The user has disabled the Job Schedule. The scheduler will not
initiate any new Jobs will on this schedule, but any existing active
Job will continue to run.
- value: terminating
description: >-
The Job Schedule has no more work to do, or has been explicitly
terminated by the user, but the termination operation is still in
progress. The scheduler will not initiate any new Jobs for this Job
Schedule, nor is any existing Job active.
- value: deleting
description: >-
The user has requested that the Job Schedule be deleted, but the
delete operation is still in progress. The scheduler will not
initiate any new Jobs for this Job Schedule, and will delete any
existing Jobs and Tasks under the Job Schedule, including any active
Job. The Job Schedule will be deleted when all Jobs and Tasks under
the Job Schedule have been deleted.
JobState:
type: string
title: The state of the Job.
enum:
- active
- disabling
- disabled
- enabling
- terminating
- completed
- deleting
x-ms-enum:
name: JobState
modelAsString: false
values:
- value: active
description: The Job is available to have Tasks scheduled.
- value: disabling
description: >-
A user has requested that the Job be disabled, but the disable
operation is still in progress (for example, waiting for Tasks to
terminate).
- value: disabled
description: >-
A user has disabled the Job. No Tasks are running, and no new Tasks
will be scheduled.
- value: enabling
description: >-
A user has requested that the Job be enabled, but the enable
operation is still in progress.
- value: terminating
description: >-
The Job is about to complete, either because a Job Manager Task has
completed or because the user has terminated the Job, but the
terminate operation is still in progress (for example, because Job
Release Tasks are running).
- value: completed
description: >-
All Tasks have terminated, and the system will not accept any more
Tasks or any further changes to the Job.
- value: deleting
description: >-
A user has requested that the Job be deleted, but the delete
operation is still in progress (for example, because the system is
still terminating running Tasks).
OnAllTasksComplete:
type: string
title: >-
The action the Batch service should take when all Tasks in the Job are in
the completed state.
enum:
- noaction
- terminatejob
x-ms-enum:
name: OnAllTasksComplete
modelAsString: false
values:
- value: noaction
description: >-
Do nothing. The Job remains active unless terminated or disabled by
some other means.
name: noAction
- value: terminatejob
description: >-
Terminate the Job. The Job's terminateReason is set to
'AllTasksComplete'.
name: terminateJob
OnTaskFailure:
type: string
title: The action the Batch service should take when any Task in the Job fails.
description: >-
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.
enum:
- noaction
- performexitoptionsjobaction
x-ms-enum:
name: OnTaskFailure
modelAsString: false
values:
- value: noaction
description: >-
Do nothing. The Job remains active unless terminated or disabled by
some other means.
name: noAction
- value: performexitoptionsjobaction
description: >-
Take the action associated with the Task exit condition in the
Task's exitConditions collection. (This may still result in no
action being taken, if that is what the Task specifies.)
name: performExitOptionsJobAction
ErrorCategory:
type: string
title: The category of the error.
enum:
- usererror
- servererror
x-ms-enum:
name: ErrorCategory
modelAsString: false
values:
- value: usererror
description: The error is due to a user issue, such as misconfiguration.
name: userError
- value: servererror
description: The error is due to an internal server issue.
name: serverError
TaskState:
type: string
title: The state of the Task.
enum:
- active
- preparing
- running
- completed
x-ms-enum:
name: TaskState
modelAsString: false
values:
- value: active
description: >-
The Task is queued and able to run, but is not currently assigned to
a Compute Node. A Task enters this state when it is created, when it
is enabled after being disabled, or when it is awaiting a retry
after a failed run.
- value: preparing
description: >-
The Task has been assigned to a Compute Node, but is waiting for a
required Job Preparation Task to complete on the Compute Node. If
the Job Preparation Task succeeds, the Task will move to running. If
the Job Preparation Task fails, the Task will return to active and
will be eligible to be assigned to a different Compute Node.
- value: running
description: >-
The Task is running on a Compute Node. This includes task-level
preparation such as downloading resource files or deploying Packages
specified on the Task - it does not necessarily mean that the Task
command line has started executing.
- value: completed
description: >-
The Task is no longer eligible to run, usually because the Task has
finished successfully, or the Task has finished unsuccessfully and
has exhausted its retry limit. A Task is also marked as completed if
an error occurred launching the Task, or when the Task has been
terminated.
SubtaskState:
type: string
title: The state of the subtask.
enum:
- preparing
- running
- completed
x-ms-enum:
name: SubtaskState
modelAsString: false
values:
- value: preparing
description: >-
The Task has been assigned to a Compute Node, but is waiting for a
required Job Preparation Task to complete on the Compute Node. If
the Job Preparation Task succeeds, the Task will move to running. If
the Job Preparation Task fails, the Task will return to active and
will be eligible to be assigned to a different Compute Node.
- value: running
description: >-
The Task is running on a Compute Node. This includes task-level
preparation such as downloading resource files or deploying Packages
specified on the Task - it does not necessarily mean that the Task
command line has started executing.
- value: completed
description: >-
The Task is no longer eligible to run, usually because the Task has
finished successfully, or the Task has finished unsuccessfully and
has exhausted its retry limit. A Task is also marked as completed if
an error occurred launching the Task, or when the Task has been
terminated.
ComputeNodeDeallocationOption:
type: string
title: >-
Determines what to do with a Compute Node and its running task(s) after it
has been selected for deallocation.
description: The default value is requeue.
enum:
- requeue
- terminate
- taskcompletion
- retaineddata
x-ms-enum:
name: ComputeNodeDeallocationOption
modelAsString: false
values:
- value: requeue
description: >-
Terminate running Task processes and requeue the Tasks. The Tasks
will run again when a Compute Node is available. Remove Compute
Nodes as soon as Tasks have been terminated.
- value: terminate
description: >-
Terminate running Tasks. The Tasks will be completed with
failureInfo indicating that they were terminated, and will not run
again. Remove Compute Nodes as soon as Tasks have been terminated.
- value: taskcompletion
description: >-
Allow currently running Tasks to complete. Schedule no new Tasks
while waiting. Remove Compute Nodes when all Tasks have completed.
name: taskCompletion
- value: retaineddata
description: >-
Allow currently running Tasks to complete, then wait for all Task
data retention periods to expire. Schedule no new Tasks while
waiting. Remove Compute Nodes when all Task retention periods have
expired.
name: retainedData
OutputFileUploadCondition:
type: string
title: >-
The conditions under which a Task output file or set of files should be
uploaded.
enum:
- tasksuccess
- taskfailure
- taskcompletion
x-ms-enum:
name: OutputFileUploadCondition
modelAsString: false
values:
- value: tasksuccess
description: >-
Upload the file(s) only after the Task process exits with an exit
code of 0.
name: taskSuccess
- value: taskfailure
description: >-
Upload the file(s) only after the Task process exits with a nonzero
exit code.
name: taskFailure
- value: taskcompletion
description: >-
Upload the file(s) after the Task process exits, no matter what the
exit code was.
name: taskCompletion
TaskExecutionResult:
type: string
title: The result of Task execution.
enum:
- success
- failure
x-ms-enum:
name: TaskExecutionResult
modelAsString: false
values:
- value: success
description: The Task ran successfully.
name: success
- value: failure
description: >-
There was an error during processing of the Task. The failure may
have occurred before the Task process was launched, while the Task
process was executing, or after the Task process exited.
name: failure
InboundEndpointProtocol:
type: string
title: The protocol of the endpoint.
enum:
- tcp
- udp
x-ms-enum:
name: InboundEndpointProtocol
modelAsString: false
values:
- value: tcp
description: Use TCP for the endpoint.
name: tcp
- value: udp
description: Use UDP for the endpoint.
name: udp
UploadBatchServiceLogsConfiguration:
type: object
properties:
containerUrl:
type: string
title: >-
The URL of the container within Azure Blob Storage to which to upload
the Batch Service log file(s).
description: >-
If a user assigned managed identity is not being used, the URL must
include a Shared Access Signature (SAS) granting write permissions to
the container. The SAS duration must allow enough time for the upload
to finish. The start time for SAS is optional and recommended to not
be specified.
startTime:
type: string
format: date-time
title: >-
The start of the time range from which to upload Batch Service log
file(s).
description: >-
Any log file containing a log message in the time range will be
uploaded. This means that the operation might retrieve more logs than
have been requested since the entire log file is always uploaded, but
the operation should not retrieve fewer logs than have been requested.
endTime:
type: string
format: date-time
title: >-
The end of the time range from which to upload Batch Service log
file(s).
description: >-
Any log file containing a log message in the time range will be
uploaded. This means that the operation might retrieve more logs than
have been requested since the entire log file is always uploaded, but
the operation should not retrieve fewer logs than have been requested.
If omitted, the default is to upload all logs available after the
startTime.
identityReference:
title: >-
The reference to the user assigned identity to use to access Azure
Blob Storage specified by containerUrl.
description: >-
The identity must have write access to the Azure Blob Storage
container.
$ref: '#/definitions/ComputeNodeIdentityReference'
required:
- containerUrl
- startTime
title: The Azure Batch service log files upload configuration for a Compute Node.
UploadBatchServiceLogsResult:
type: object
properties:
virtualDirectoryName:
type: string
title: >-
The virtual directory within Azure Blob Storage container to which the
Batch Service log file(s) will be uploaded.
description: >-
The virtual directory name is part of the blob name for each log file
uploaded, and it is built based poolId, nodeId and a unique
identifier.
numberOfFilesUploaded:
type: integer
format: int32
title: The number of log files which will be uploaded.
required:
- virtualDirectoryName
- numberOfFilesUploaded
title: >-
The result of uploading Batch service log files from a specific Compute
Node.
PoolNodeCountsListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/PoolNodeCounts'
description: A list of Compute Node counts by Pool.
odata.nextLink:
type: string
title: The URL to get the next set of results.
title: The result of listing the Compute Node counts in the Account.
PoolNodeCounts:
type: object
properties:
poolId:
type: string
title: The ID of the Pool.
dedicated:
$ref: '#/definitions/NodeCounts'
title: The number of dedicated Compute Nodes in each state.
lowPriority:
$ref: '#/definitions/NodeCounts'
title: The number of Spot/Low-priority Compute Nodes in each state.
required:
- poolId
title: The number of Compute Nodes in each state for a Pool.
NodeCounts:
type: object
properties:
creating:
type: integer
format: int32
title: The number of Compute Nodes in the creating state.
idle:
type: integer
format: int32
title: The number of Compute Nodes in the idle state.
offline:
type: integer
format: int32
title: The number of Compute Nodes in the offline state.
preempted:
type: integer
format: int32
title: The number of Compute Nodes in the preempted state.
rebooting:
type: integer
format: int32
title: The count of Compute Nodes in the rebooting state.
reimaging:
type: integer
format: int32
title: The number of Compute Nodes in the reimaging state.
running:
type: integer
format: int32
title: The number of Compute Nodes in the running state.
starting:
type: integer
format: int32
title: The number of Compute Nodes in the starting state.
startTaskFailed:
type: integer
format: int32
title: The number of Compute Nodes in the startTaskFailed state.
leavingPool:
type: integer
format: int32
title: The number of Compute Nodes in the leavingPool state.
unknown:
type: integer
format: int32
title: The number of Compute Nodes in the unknown state.
unusable:
type: integer
format: int32
title: The number of Compute Nodes in the unusable state.
waitingForStartTask:
type: integer
format: int32
title: The number of Compute Nodes in the waitingForStartTask state.
upgradingOS:
type: integer
format: int32
title: The number of Compute Nodes in the upgradingOS state.
total:
type: integer
format: int32
title: The total number of Compute Nodes.
required:
- creating
- idle
- offline
- preempted
- rebooting
- reimaging
- running
- starting
- startTaskFailed
- leavingPool
- unknown
- unusable
- waitingForStartTask
- upgradingOS
- total
title: The number of Compute Nodes in each Compute Node state.
MountConfiguration:
type: object
properties:
azureBlobFileSystemConfiguration:
$ref: '#/definitions/AzureBlobFileSystemConfiguration'
title: The Azure Storage Container to mount using blob FUSE on each node.
description: This property is mutually exclusive with all other properties.
nfsMountConfiguration:
$ref: '#/definitions/NFSMountConfiguration'
title: The NFS file system to mount on each node.
description: This property is mutually exclusive with all other properties.
cifsMountConfiguration:
$ref: '#/definitions/CIFSMountConfiguration'
title: The CIFS/SMB file system to mount on each node.
description: This property is mutually exclusive with all other properties.
azureFileShareConfiguration:
$ref: '#/definitions/AzureFileShareConfiguration'
title: The Azure File Share to mount on each node.
description: This property is mutually exclusive with all other properties.
title: The file system to mount on each node.
AzureBlobFileSystemConfiguration:
type: object
properties:
accountName:
type: string
title: The Azure Storage Account name.
containerName:
type: string
title: The Azure Blob Storage Container name.
accountKey:
type: string
title: The Azure Storage Account key.
description: >-
This property is mutually exclusive with both sasKey and identity;
exactly one must be specified.
sasKey:
type: string
title: The Azure Storage SAS token.
description: >-
This property is mutually exclusive with both accountKey and identity;
exactly one must be specified.
blobfuseOptions:
type: string
title: Additional command line options to pass to the mount command.
description: These are 'net use' options in Windows and 'mount' options in Linux.
relativeMountPath:
type: string
title: >-
The relative path on the compute node where the file system will be
mounted
description: >-
All file systems are mounted relative to the Batch mounts directory,
accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
identityReference:
title: >-
The reference to the user assigned identity to use to access
containerName
description: >-
This property is mutually exclusive with both accountKey and sasKey;
exactly one must be specified.
$ref: '#/definitions/ComputeNodeIdentityReference'
required:
- accountName
- containerName
- relativeMountPath
title: Information used to connect to an Azure Storage Container using Blobfuse.
NFSMountConfiguration:
type: object
properties:
source:
type: string
title: The URI of the file system to mount.
relativeMountPath:
type: string
title: >-
The relative path on the compute node where the file system will be
mounted
description: >-
All file systems are mounted relative to the Batch mounts directory,
accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
mountOptions:
type: string
title: Additional command line options to pass to the mount command.
description: These are 'net use' options in Windows and 'mount' options in Linux.
required:
- source
- relativeMountPath
title: Information used to connect to an NFS file system.
CIFSMountConfiguration:
type: object
properties:
username:
type: string
title: The user to use for authentication against the CIFS file system.
source:
type: string
title: The URI of the file system to mount.
relativeMountPath:
type: string
title: >-
The relative path on the compute node where the file system will be
mounted
description: >-
All file systems are mounted relative to the Batch mounts directory,
accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
mountOptions:
type: string
title: Additional command line options to pass to the mount command.
description: These are 'net use' options in Windows and 'mount' options in Linux.
password:
type: string
title: The password to use for authentication against the CIFS file system.
required:
- username
- source
- password
- relativeMountPath
title: Information used to connect to a CIFS file system.
AzureFileShareConfiguration:
type: object
properties:
accountName:
type: string
title: The Azure Storage account name.
azureFileUrl:
type: string
title: The Azure Files URL.
description: This is of the form 'https://{account}.file.core.windows.net/'.
accountKey:
type: string
title: The Azure Storage account key.
relativeMountPath:
type: string
title: >-
The relative path on the compute node where the file system will be
mounted
description: >-
All file systems are mounted relative to the Batch mounts directory,
accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
mountOptions:
type: string
title: Additional command line options to pass to the mount command.
description: These are 'net use' options in Windows and 'mount' options in Linux.
required:
- accountName
- azureFileUrl
- accountKey
- relativeMountPath
title: Information used to connect to an Azure Fileshare.
BatchPoolIdentity:
type: object
title: The identity of the Batch pool, if configured.
properties:
type:
type: string
title: The identity of the Batch pool, if configured.
description: >-
The list of user identities associated with the Batch pool. The user
identity dictionary key references will be ARM resource ids in the
form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
enum:
- UserAssigned
- None
x-ms-enum:
name: PoolIdentityType
modelAsString: false
values:
- value: UserAssigned
description: Batch pool has user assigned identities with it.
- value: None
description: >-
Batch pool has no identity associated with it. Setting `None` in
update pool will remove existing identities.
userAssignedIdentities:
type: array
title: The list of user identities associated with the Batch account.
description: >-
The user identity dictionary key references will be ARM resource ids
in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
items:
$ref: '#/definitions/UserAssignedIdentity'
description: The identity of the Batch pool, if configured.
required:
- type
UserAssignedIdentity:
type: object
properties:
resourceId:
type: string
description: The ARM resource id of the user assigned identity
clientId:
readOnly: true
type: string
description: The client id of the user assigned identity.
principalId:
readOnly: true
type: string
description: The principal id of the user assigned identity.
description: The user assigned Identity
required:
- resourceId
ComputeNodeIdentityReference:
properties:
resourceId:
type: string
description: The ARM resource id of the user assigned identity.
description: >-
The reference to a user assigned identity associated with the Batch pool
which a compute node will use.
ManagedDisk:
type: object
properties:
storageAccountType:
$ref: '#/definitions/StorageAccountType'
title: The storage account type for managed disk.
SecurityProfile:
type: object
properties:
securityType:
type: string
title: >-
Specifies the SecurityType of the virtual machine. It has to be set to
any specified value to enable UefiSettings.
enum:
- trustedLaunch
x-ms-enum:
name: SecurityTypes
modelAsString: false
values:
- value: trustedLaunch
description: >-
Trusted launch protects against advanced and persistent attack
techniques.
encryptionAtHost:
type: boolean
description: >-
This property can be used by user in the request to enable or disable
the Host Encryption for the virtual machine or virtual machine scale
set. This will enable the encryption for all the disks including
Resource/Temp disk at host itself.
uefiSettings:
$ref: '#/definitions/UefiSettings'
title: >-
Specifies the security settings like secure boot and vTPM used while
creating the virtual machine.
description: >-
Specifies the security settings like secure boot and vTPM used while
creating the virtual machine.
description: >-
Specifies the security profile settings for the virtual machine or virtual
machine scale set.
UefiSettings:
type: object
properties:
secureBootEnabled:
type: boolean
description: >-
Specifies whether secure boot should be enabled on the virtual
machine.
vTpmEnabled:
type: boolean
description: Specifies whether vTPM should be enabled on the virtual machine.
description: >-
Specifies the security settings like secure boot and vTPM used while
creating the virtual machine.
UpgradePolicy:
type: object
properties:
mode:
type: string
title: >-
Specifies the mode of an upgrade to virtual machines in the scale
set.
Possible values are:
**Manual** - You control the application of updates to virtual machines in the scale
set. You do this by using the manualUpgrade action.
**Automatic** - All virtual machines in the scale set are
automatically updated at the same time.
**Rolling** -
Scale set performs updates in batches with an optional pause time in
between.
enum:
- automatic
- manual
- rolling
x-ms-enum:
name: UpgradeMode
modelAsString: false
values:
- value: automatic
description: >-
All virtual machines in the scale set are automatically updated
at the same time.
- value: manual
description: >-
You control the application of updates to virtual machines in
the scale set. You do this by using the manualUpgrade action.
- value: rolling
description: >-
The existing instances in a scale set are brought down in
batches to be upgraded. Once the upgraded batch is complete, the
instances will begin taking traffic again and the next batch
will begin. This continues until all instances brought
up-to-date.
automaticOSUpgradePolicy:
$ref: '#/definitions/AutomaticOSUpgradePolicy'
title: Configuration parameters used for performing automatic OS Upgrade.
description: The configuration parameters used for performing automatic OS upgrade.
rollingUpgradePolicy:
$ref: '#/definitions/RollingUpgradePolicy'
title: The configuration parameters used while performing a rolling upgrade.
description: >-
This property is only supported on Pools with the
virtualMachineConfiguration property.
required:
- mode
description: Describes an upgrade policy - automatic, manual, or rolling.
AutomaticOSUpgradePolicy:
type: object
properties:
disableAutomaticRollback:
type: boolean
description: Whether OS image rollback feature should be disabled.
enableAutomaticOSUpgrade:
type: boolean
description: >-
Indicates whether OS upgrades should automatically be applied to scale
set instances in a rolling fashion when a newer version of the OS
image becomes available.
If this is set to true for
Windows based pools,
[WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration)
cannot be set to true.
useRollingUpgradePolicy:
type: boolean
description: >-
Indicates whether rolling upgrade policy should be used during Auto OS
Upgrade. Auto OS Upgrade will fallback to the default policy if no
policy is defined on the VMSS.
osRollingUpgradeDeferral:
type: boolean
description: Defer OS upgrades on the TVMs if they are running tasks.
description: The configuration parameters used for performing automatic OS upgrade.
RollingUpgradePolicy:
type: object
properties:
enableCrossZoneUpgrade:
type: boolean
description: >-
Allow VMSS to ignore AZ boundaries when constructing upgrade batches.
Take into consideration the Update Domain and maxBatchInstancePercent
to determine the batch size. This field is able to be set to true or
false only when using NodePlacementConfiguration as Zonal.
maxBatchInstancePercent:
type: integer
format: int32
minimum: 5
maximum: 100
description: >-
The maximum percent of total virtual machine instances that will be
upgraded simultaneously by the rolling upgrade in one batch. As this
is a maximum, unhealthy instances in previous or future batches can
cause the percentage of instances in a batch to decrease to ensure
higher reliability. The value of this field should be between 5 and
100, inclusive. If both maxBatchInstancePercent and
maxUnhealthyInstancePercent are assigned with value, the value of
maxBatchInstancePercent should not be more than
maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent:
type: integer
format: int32
minimum: 5
maximum: 100
description: >-
The maximum percentage of the total virtual machine instances in the
scale set that can be simultaneously unhealthy, either as a result of
being upgraded, or by being found in an unhealthy state by the virtual
machine health checks before the rolling upgrade aborts. This
constraint will be checked prior to starting any batch. The value of
this field should be between 5 and 100, inclusive. If both
maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned
with value, the value of maxBatchInstancePercent should not be more
than maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent:
type: integer
format: int32
minimum: 0
maximum: 100
description: >-
The maximum percentage of upgraded virtual machine instances that can
be found to be in an unhealthy state. This check will happen after
each batch is upgraded. If this percentage is ever exceeded, the
rolling update aborts. The value of this field should be between 0 and
100, inclusive.
pauseTimeBetweenBatches:
type: string
format: duration
description: >-
The wait time between completing the update for all virtual machines
in one batch and starting the next batch. The time duration should be
specified in ISO 8601 format.
prioritizeUnhealthyInstances:
type: boolean
description: >-
Upgrade all unhealthy instances in a scale set before any healthy
instances.
rollbackFailedInstancesOnPolicyBreach:
type: boolean
description: >-
Rollback failed instances to previous model if the Rolling Upgrade
policy is violated.
description: The configuration parameters used while performing a rolling upgrade.
parameters:
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: Client API Version.
batchUrl:
name: batchUrl
x-ms-parameter-location: client
required: true
type: string
in: path
x-ms-skip-url-encoding: true
description: The base URL for all Azure Batch service requests.
tags:
- name: Accounts
- name: Applications
- name: Certificates
- name: ComputeNodes
- name: Files
- name: Jobs
- name: JobSchedules
- name: Pools
- name: Tasks