swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Pools API schemes: - https tags: - name: Pools paths: /pools: get: operationId: microsoftAzureBatchListpools summary: Microsoft Azure Lists All Of The Pools In The Specified Account description: Lists all of the Pools in the specified Account. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: $filter in: query 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.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchPoolListResult' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool list: $ref: ./examples/PoolList_Basic.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Pools post: operationId: microsoftAzureBatchCreatepool summary: Microsoft Azure Creates 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: pool in: body description: The Pool to be created. required: true schema: $ref: '#/definitions/BatchPoolCreateContent' responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Creates a CloudServiceConfiguration pool: $ref: ./examples/PoolCreate_CloudServiceConfiguration.json Creates a VirtualMachineConfiguration pool: $ref: ./examples/PoolCreate_VirtualMachineConfiguration.json Creates a VirtualMachineConfiguration pool with OS disk: $ref: ./examples/PoolCreate_OSDisk.json Creates a VirtualMachineConfiguration pool with ServiceArtifactReference: $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json Creates a VirtualMachineConfiguration pool with containers: $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithContainers.json Creates a VirtualMachineConfiguration pool with extensions: $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json Creates a pool with SecurityProfile: $ref: ./examples/PoolCreate_SecurityProfile.json Creates a pool with accelerated networking: $ref: ./examples/PoolCreate_AcceleratedNetworking.json Creates a pool with mount drive specified: $ref: ./examples/PoolCreate_MountConfiguration.json Creates a simple pool with resourceTags: $ref: ./examples/PoolCreate_ResourceTags.json tags: - Pools /pools/{poolId}: get: operationId: microsoftAzureBatchGetpool description: Gets information about the specified Pool. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchPool' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Add a VirtualMachineConfiguration pool with OS disk: $ref: ./examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json Get a VirtualMachineConfiguration pool with SecurityProfile: $ref: ./examples/PoolGet_SecurityProfile.json Get a VirtualMachineConfiguration pool with ServiceArtifactReference: $ref: ./examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json Get a VirtualMachineConfiguration pool with extensions: $ref: ./examples/PoolGet_VirtualMachineConfigurationWithExtensions.json Get a pool with AcceleratedNetworking: $ref: ./examples/PoolGet_AcceleratedNetworking.json Pool get: $ref: ./examples/PoolGet_Basic.json summary: Microsoft Azure Get Pools Poolid tags: - Pools patch: operationId: microsoftAzureBatchUpdatepool 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string - name: pool in: body description: The pool properties to update. required: true schema: $ref: '#/definitions/BatchPoolUpdateContent' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Patch the Pool: $ref: ./examples/PoolPatch.json tags: - Pools delete: operationId: microsoftAzureBatchDeletepool 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.' parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool delete: $ref: ./examples/PoolDelete.json tags: - Pools head: operationId: microsoftAzureBatchPoolexists description: Gets basic properties of a Pool. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string responses: '200': description: The request has succeeded. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. '404': description: The server cannot find the requested resource. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Check Pool Exists: $ref: ./examples/PoolExists.json summary: Microsoft Azure Head Pools Poolid tags: - Pools /pools/{poolId}/disableautoscale: post: operationId: microsoftAzureBatchDisablepoolautoscale summary: Microsoft Azure Disables Automatic Scaling For A Pool description: Disables automatic scaling for a Pool. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool on which to disable automatic scaling. required: true type: string responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Disable pool autoscale: $ref: ./examples/PoolDisableAutoScale.json tags: - Pools /pools/{poolId}/enableautoscale: post: operationId: microsoftAzureBatchEnablepoolautoscale 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string - name: content in: body description: The options to use for enabling automatic scaling. required: true schema: $ref: '#/definitions/BatchPoolEnableAutoScaleContent' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool enable autoscale: $ref: ./examples/PoolEnableAutoscale.json tags: - Pools /pools/{poolId}/evaluateautoscale: post: operationId: microsoftAzureBatchEvaluatepoolautoscale 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool on which to evaluate the automatic scaling formula. required: true type: string - name: content in: body description: The options to use for evaluating the automatic scaling formula. required: true schema: $ref: '#/definitions/BatchPoolEvaluateAutoScaleContent' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/AutoScaleRun' headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool evaluate autoscale: $ref: ./examples/PoolEvaluateAutoscale.json tags: - Pools /pools/{poolId}/nodes: get: operationId: microsoftAzureBatchListnodes summary: Microsoft Azure Lists The Compute Nodes In The Specified Pool description: Lists the Compute Nodes in the specified Pool. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: poolId in: path description: The ID of the Pool from which you want to list Compute Nodes. required: true type: string - name: $filter in: query 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.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeListResult' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node list: $ref: ./examples/NodeList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Pools /pools/{poolId}/nodes/{nodeId}: get: operationId: microsoftAzureBatchGetnode summary: Microsoft Azure Gets Information About The Specified Compute Node description: Gets information about the specified Compute Node. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node that you want to get information about. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNode' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node get: $ref: ./examples/NodeGet_Basic.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/disablescheduling: post: operationId: microsoftAzureBatchDisablenodescheduling 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node on which you want to disable Task scheduling. required: true type: string - name: parameters in: body description: The options to use for disabling scheduling on the Compute Node. required: false schema: $ref: '#/definitions/BatchNodeDisableSchedulingContent' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node disable scheduling: $ref: ./examples/NodeDisableScheduling.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/enablescheduling: post: operationId: microsoftAzureBatchEnablenodescheduling 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 parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node on which you want to enable Task scheduling. required: true type: string responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node enable scheduling: $ref: ./examples/NodeEnableScheduling.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/extensions: get: operationId: microsoftAzureBatchListnodeextensions summary: Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool description: Lists the Compute Nodes Extensions in the specified Pool. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: poolId in: path description: The ID of the Pool that contains Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node that you want to list extensions. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeVMExtensionListResult' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: List compute node extensions: $ref: ./examples/BatchNodeExtensionList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Pools /pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}: get: operationId: microsoftAzureBatchGetnodeextension summary: Microsoft Azure Gets Information About The Specified Compute Node Extension description: Gets information about the specified Compute Node Extension. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node that contains the extensions. required: true type: string - name: extensionName in: path description: The name of the Compute Node Extension that you want to get information about. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeVMExtension' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Get batch node extension: $ref: ./examples/BatchNodeExtensionGet.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/files: get: operationId: microsoftAzureBatchListnodefiles summary: Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node description: Lists all of the files in Task directories on the specified Compute Node. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node whose files you want to list. required: true type: string - name: $filter in: query 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.' required: false type: string - name: recursive in: query description: Whether to list children of a directory. required: false type: boolean responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeFileListResult' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File list from node: $ref: ./examples/FileListFromNode.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Pools /pools/{poolId}/nodes/{nodeId}/files/{filePath}: get: operationId: microsoftAzureBatchGetnodefile description: Returns the content of the specified Compute Node file. produces: - application/octet-stream - application/json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node. required: true type: string - name: filePath in: path description: The path to the file or directory. required: true type: string - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: ocp-range in: header description: 'The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.' required: false type: string responses: '200': description: The request has succeeded. schema: type: file headers: Content-Length: type: integer format: int64 description: The length of the file. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. ocp-batch-file-isdirectory: type: boolean description: Whether the object represents a directory. ocp-batch-file-mode: type: string description: The file mode attribute in octal format. ocp-batch-file-url: type: string description: The URL of the file. ocp-creation-time: type: string format: date-time-rfc7231 description: The file creation time. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Get File From Compute Node: $ref: ./examples/FileGetFromNode.json summary: Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath tags: - Pools delete: operationId: microsoftAzureBatchDeletenodefile summary: Microsoft Azure Deletes The Specified File From The Compute Node description: Deletes the specified file from the Compute Node. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node. required: true type: string - name: filePath in: path description: The path to the file or directory. required: true type: string - name: recursive in: query 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.' required: false type: boolean responses: '200': description: The request has succeeded. headers: client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File delete from node: $ref: ./examples/FileDeleteFromNode.json tags: - Pools head: operationId: microsoftAzureBatchGetnodefileproperties description: Gets the properties of the specified Compute Node file. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node. required: true type: string - name: filePath in: path description: The path to the file or directory. required: true type: string - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince responses: '200': description: The request has succeeded. headers: Content-Length: type: integer format: int64 description: The length of the file. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. ocp-batch-file-isdirectory: type: boolean description: Whether the object represents a directory. ocp-batch-file-mode: type: string description: The file mode attribute in octal format. ocp-batch-file-url: type: string description: The URL of the file. ocp-creation-time: type: string format: date-time-rfc7231 description: The file creation time. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File get properties from node: $ref: ./examples/FileGetPropertiesFromNode.json summary: Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath tags: - Pools /pools/{poolId}/nodes/{nodeId}/rdp: get: operationId: microsoftAzureBatchGetnoderemotedesktopfile 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. produces: - application/octet-stream - application/json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: 'The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.' required: true type: string responses: '200': description: The request has succeeded. schema: type: file headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Get RDP file of the compute node: $ref: ./examples/NodeGetRemoteDesktop.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/reboot: post: operationId: microsoftAzureBatchRebootnode 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true type: string - name: parameters in: body description: The options to use for rebooting the Compute Node. required: false schema: $ref: '#/definitions/BatchNodeRebootContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node reboot: $ref: ./examples/NodeReboot.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/reimage: post: operationId: microsoftAzureBatchReimagenode 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true type: string - name: parameters in: body description: The options to use for reimaging the Compute Node. required: false schema: $ref: '#/definitions/BatchNodeReimageContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node reimage: $ref: ./examples/NodeReimage.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/remoteloginsettings: get: operationId: microsoftAzureBatchGetnoderemoteloginsettings 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. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the Compute Node for which to obtain the remote login settings. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeRemoteLoginSettings' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node get remote login settings: $ref: ./examples/NodeGetRemoteLoginSettings.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs: post: operationId: microsoftAzureBatchUploadnodelogs 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: 'The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.' required: true type: string - name: content in: body description: The Azure Batch service log files upload options. required: true schema: $ref: '#/definitions/UploadBatchServiceLogsContent' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/UploadBatchServiceLogsResult' headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Upload BatchService Logs: $ref: ./examples/NodeUploadBatchServiceLogs.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/users: post: operationId: microsoftAzureBatchCreatenodeuser 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the machine on which you want to create a user Account. required: true type: string - name: user in: body description: The options to use for creating the user. required: true schema: $ref: '#/definitions/BatchNodeUserCreateContent' responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node create user: $ref: ./examples/NodeCreateUser.json tags: - Pools /pools/{poolId}/nodes/{nodeId}/users/{userName}: put: operationId: microsoftAzureBatchReplacenodeuser 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the machine on which you want to update a user Account. required: true type: string - name: userName in: path description: The name of the user Account to update. required: true type: string - name: content in: body description: The options to use for updating the user. required: true schema: $ref: '#/definitions/BatchNodeUserUpdateContent' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node update user: $ref: ./examples/NodeUpdateUser.json tags: - Pools delete: operationId: microsoftAzureBatchDeletenodeuser 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. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true type: string - name: nodeId in: path description: The ID of the machine on which you want to delete a user Account. required: true type: string - name: userName in: path description: The name of the user Account to delete. required: true type: string responses: '200': description: The request has succeeded. headers: client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Node delete user: $ref: ./examples/NodeDeleteUser.json tags: - Pools /pools/{poolId}/removenodes: post: operationId: microsoftAzureBatchRemovenodes 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string - name: content in: body description: The options to use for removing the node. required: true schema: $ref: '#/definitions/BatchNodeRemoveContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool remove nodes: $ref: ./examples/PoolRemoveNodes.json tags: - Pools /pools/{poolId}/resize: post: operationId: microsoftAzureBatchResizepool 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string - name: content in: body description: The options to use for resizing the pool. required: true schema: $ref: '#/definitions/BatchPoolResizeContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool resize: $ref: ./examples/PoolResize.json tags: - Pools /pools/{poolId}/stopresize: post: operationId: microsoftAzureBatchStoppoolresize 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.' parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header 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.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header 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.' required: false type: string x-ms-client-name: ifNoneMatch - name: poolId in: path description: The ID of the Pool to get. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool stop resize: $ref: ./examples/PoolStopResize.json tags: - Pools /pools/{poolId}/updateproperties: post: operationId: microsoftAzureBatchReplacepoolproperties 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. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query 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.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header 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.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header 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.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: poolId in: path description: The ID of the Pool to update. required: true type: string - name: pool in: body description: The options to use for replacing properties on the pool. required: true schema: $ref: '#/definitions/BatchPoolReplaceContent' responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string 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. request-id: type: string 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. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Pool update: $ref: ./examples/PoolUpdate.json tags: - Pools /subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools: get: operationId: microsoftAzurePoolsListbysubscription tags: - Pools description: List Pool resources by subscription ID parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PoolListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_ListBySubscription_AzureDisk: $ref: ./examples/Pools_ListBySubscription_AzureDisk.json Pools_ListBySubscription_ElasticSan: $ref: ./examples/Pools_ListBySubscription_ElasticSan.json Pools_ListBySubscription_Ephemeral: $ref: ./examples/Pools_ListBySubscription_Ephemeral.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Containerstorage Pools /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools: get: operationId: microsoftAzurePoolsListbyresourcegroup tags: - Pools description: List Pool resources by resource group parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PoolListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_ListByResourceGroup_AzureDisk: $ref: ./examples/Pools_ListByResourceGroup_AzureDisk.json Pools_ListByResourceGroup_ElasticSan: $ref: ./examples/Pools_ListByResourceGroup_ElasticSan.json Pools_ListByResourceGroup_Ephemeral: $ref: ./examples/Pools_ListByResourceGroup_Ephemeral.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}: get: operationId: microsoftAzurePoolsGet tags: - Pools description: Get a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Pool Object required: true type: string minLength: 3 maxLength: 253 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Pool' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Get_AzureDisk: $ref: ./examples/Pools_Get_AzureDisk.json Pools_Get_ElasticSan: $ref: ./examples/Pools_Get_ElasticSan.json Pools_Get_Ephemeral: $ref: ./examples/Pools_Get_Ephemeral.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname put: operationId: microsoftAzurePoolsCreateorupdate tags: - Pools description: Create a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Pool Object required: true type: string minLength: 3 maxLength: 253 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Pool' responses: '200': description: Resource 'Pool' update operation succeeded schema: $ref: '#/definitions/Pool' '201': description: Resource 'Pool' create operation succeeded schema: $ref: '#/definitions/Pool' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_CreateOrUpdate_AzureDisk: $ref: ./examples/Pools_CreateOrUpdate_AzureDisk.json Pools_CreateOrUpdate_ElasticSan: $ref: ./examples/Pools_CreateOrUpdate_ElasticSan.json Pools_CreateOrUpdate_Ephemeral: $ref: ./examples/Pools_CreateOrUpdate_Ephemeral.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname patch: operationId: microsoftAzurePoolsUpdate tags: - Pools description: Update a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Pool Object required: true type: string minLength: 3 maxLength: 253 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$ - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/PoolUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Pool' '202': description: Resource update request accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Update_AzureDisk: $ref: ./examples/Pools_Update_AzureDisk.json Pools_Update_ElasticSan: $ref: ./examples/Pools_Update_ElasticSan.json Pools_Update_Ephemeral: $ref: ./examples/Pools_Update_Ephemeral.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname delete: operationId: microsoftAzurePoolsDelete tags: - Pools description: Delete a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Pool Object required: true type: string minLength: 3 maxLength: 253 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$ responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Delete: $ref: ./examples/Pools_Delete.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname /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. 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_2' /lifetimepoolstats: get: tags: - Pools operationId: microsoftAzurePoolGetalllifetimestatistics x-ms-examples: Pool get lifetime statistics: $ref: ./examples/PoolGetLifetimeStatistics.json summary: Microsoft Azure Gets Lifetime Summary Statistics For All Of The Pools In The Specified Account description: Statistics are aggregated across all Pools that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. 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. 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 Pool statistics for the lifetime of the Batch Account. schema: $ref: '#/definitions/PoolStatistics' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools : parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: commonDefinitions.json#/parameters/SubscriptionIdParameter - $ref: commonDefinitions.json#/parameters/ResourceGroupNameParameter - $ref: commonDefinitions.json#/parameters/ProjectNameParameter - $ref: commonDefinitions.json#/parameters/TopParameter get: tags: - Pools description: Lists pools for a project operationId: microsoftAzurePoolsListbyproject responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/PoolListResult_2' default: description: Error response describing why the operation failed. schema: $ref: commonDefinitions.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink x-ms-examples: Pools_ListByProject: $ref: ./examples/Pools_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName} : parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: commonDefinitions.json#/parameters/SubscriptionIdParameter - $ref: commonDefinitions.json#/parameters/ResourceGroupNameParameter - $ref: commonDefinitions.json#/parameters/ProjectNameParameter - $ref: '#/parameters/PoolNameParameter' get: tags: - Pools description: Gets a machine pool operationId: microsoftAzurePoolsGet responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Pool_2' default: description: Error response describing why the operation failed. schema: $ref: commonDefinitions.json#/definitions/CloudError x-ms-examples: Pools_Get: $ref: ./examples/Pools_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname put: tags: - Pools description: Creates or updates a machine pool operationId: microsoftAzurePoolsCreateorupdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - in: body name: body description: Represents a machine pool required: true schema: $ref: '#/definitions/Pool_2' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Pool_2' '201': description: Created. Operation will complete asynchronously. schema: $ref: '#/definitions/Pool_2' default: description: Error response describing why the operation failed. schema: $ref: commonDefinitions.json#/definitions/CloudError x-ms-examples: Pools_CreateOrUpdate: $ref: ./examples/Pools_Put.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname patch: tags: - Pools description: Partially updates a machine pool operationId: microsoftAzurePoolsUpdate parameters: - in: body name: body description: Represents a machine pool required: true schema: $ref: '#/definitions/PoolUpdate_2' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Pool_2' '202': description: Accepted. Operation will complete asynchronously default: description: Error response describing why the operation failed. schema: $ref: commonDefinitions.json#/definitions/CloudError x-ms-examples: Pools_Update: $ref: ./examples/Pools_Patch.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname delete: tags: - Pools description: Deletes a machine pool operationId: microsoftAzurePoolsDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation responses: '200': description: OK. Resource has been deleted '202': description: Accepted. Operation will complete asynchronously. '204': description: Resource does not exist. default: description: Error response describing why the operation failed. schema: $ref: commonDefinitions.json#/definitions/CloudError x-ms-examples: Pools_Delete: $ref: ./examples/Pools_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/pools: get: operationId: microsoftAzurePoolsListbysubscription tags: - Pools description: List Pool resources by subscription ID parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PoolListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_ListBySubscription: $ref: ./examples/ListPoolsBySubscription.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Devopsinfrastructure Pools /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools: get: operationId: microsoftAzurePoolsListbyresourcegroup tags: - Pools description: List Pool resources by resource group parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PoolListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_ListByResourceGroup: $ref: ./examples/ListPoolsBySubscriptionAndResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName} : get: operationId: microsoftAzurePoolsGet tags: - Pools description: Get a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Name of the pool. It needs to be globally unique. required: true type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]*$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Pool_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Get: $ref: ./examples/GetPool.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname put: operationId: microsoftAzurePoolsCreateorupdate tags: - Pools description: Create a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Name of the pool. It needs to be globally unique. required: true type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]*$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Pool_3' responses: '200': description: Resource 'Pool' update operation succeeded schema: $ref: '#/definitions/Pool_3' '201': description: Resource 'Pool' create operation succeeded schema: $ref: '#/definitions/Pool_3' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_CreateOrUpdate: $ref: ./examples/CreateOrUpdatePool.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname patch: operationId: microsoftAzurePoolsUpdate tags: - Pools description: Update a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Name of the pool. It needs to be globally unique. required: true type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]*$ - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/PoolUpdate_3' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Pool_3' '202': description: Resource update request accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Update: $ref: ./examples/UpdatePool.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname delete: operationId: microsoftAzurePoolsDelete tags: - Pools description: Delete a Pool parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: poolName in: path description: Name of the pool. It needs to be globally unique. required: true type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]*$ responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Pools_Delete: $ref: ./examples/DeletePool.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname definitions: VirtualMachineInfo: type: object description: Info about the current state of the virtual machine. properties: imageReference: $ref: '#/definitions/ImageReference' description: The reference to the Azure Virtual Machine's Marketplace Image. scaleSetVmResourceId: type: string description: 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'. ResourcePredictions: type: object description: Defines pool buffer. UefiSettings: type: object description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. 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. BatchNodeRemoteLoginSettings: type: object description: The remote login settings for a Compute Node. properties: remoteLoginIPAddress: type: string description: The IP address used for remote login to the Compute Node. x-ms-client-name: remoteLoginIpAddress remoteLoginPort: type: integer format: int32 description: The port used for remote login to the Compute Node. required: - remoteLoginIPAddress - remoteLoginPort AllocationState: type: string description: AllocationState enums enum: - steady - resizing - stopping x-ms-enum: name: AllocationState modelAsString: true values: - name: Steady 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. - name: Resizing value: resizing description: The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool. - name: Stopping 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. BatchTaskSchedulingPolicy: type: object description: Specifies how Tasks should be distributed across Compute Nodes. properties: nodeFillType: $ref: '#/definitions/BatchNodeFillType' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. required: - nodeFillType ProvisioningState_2: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Represents a succeeded operation. - name: Failed value: Failed description: Represents a failed operation. - name: Canceled value: Canceled description: Represents a canceled operation. - name: Provisioning value: Provisioning description: Represents a pending operation. - name: Updating value: Updating description: Represents a pending operation. - name: Deleting value: Deleting description: Represents an operation under deletion. - name: Accepted value: Accepted description: Represents an accepted operation. BatchTaskContainerSettings: type: object description: The container settings for a Task. properties: containerRunOptions: type: string description: Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string description: The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. registry: $ref: '#/definitions/ContainerRegistry' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/definitions/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. required: - imageName SchedulingState: type: string description: SchedulingState enums enum: - enabled - disabled x-ms-enum: name: SchedulingState modelAsString: true values: - name: Enabled value: enabled description: Tasks can be scheduled on the Compute Node. - name: Disabled 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. PoolUpdate_2: description: The pool properties for partial update. Properties not provided in the update request will not be changed. type: object allOf: - $ref: commonDefinitions.json#/definitions/TrackedResourceUpdate properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PoolUpdateProperties_2' description: Properties of a pool to be updated. BatchNode: type: object description: A Compute Node in the Batch service. properties: id: type: string description: The ID of the Compute Node. 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 description: The URL of the Compute Node. state: $ref: '#/definitions/BatchNodeState' description: The current state of the Compute Node. 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. schedulingState: $ref: '#/definitions/SchedulingState' description: Whether the Compute Node is available for Task scheduling. stateTransitionTime: type: string format: date-time description: The time at which the Compute Node entered its current state. lastBootTime: type: string format: date-time description: The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable. allocationTime: type: string format: date-time description: The time at which this Compute Node was allocated to the Pool. 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 description: The IP address that other Nodes can use to communicate with this Compute Node. 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 description: An identifier which can be passed when adding a Task to request that the Task be scheduled on this 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. vmSize: type: string description: The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). totalTasksRun: type: integer format: int32 description: 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 description: 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 description: 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 description: 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 description: A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. items: $ref: '#/definitions/BatchTaskInfo' x-ms-identifiers: [] startTask: $ref: '#/definitions/BatchStartTask' description: The Task specified to run on the Compute Node as it joins the Pool. startTaskInfo: $ref: '#/definitions/BatchStartTaskInfo' description: Runtime information about the execution of the StartTask on the Compute Node. certificateReferences: type: array 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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] errors: type: array description: The list of errors that are currently being encountered by the Compute Node. items: $ref: '#/definitions/BatchNodeError' x-ms-identifiers: [] isDedicated: type: boolean description: Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node. endpointConfiguration: $ref: '#/definitions/BatchNodeEndpointConfiguration' description: The endpoint configuration for the Compute Node. nodeAgentInfo: $ref: '#/definitions/BatchNodeAgentInfo' description: Information about the Compute Node agent version and the time the Compute Node upgraded to a new version. virtualMachineInfo: $ref: '#/definitions/VirtualMachineInfo' description: Info about the current state of the virtual machine. AutoUserSpecification: type: object description: Specifies the options for the auto user that runs an Azure Batch Task. properties: scope: $ref: '#/definitions/AutoUserScope' description: The scope for the auto user. 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. elevationLevel: $ref: '#/definitions/ElevationLevel' description: The elevation level of the auto user. The default value is nonAdmin. PoolUpdateProperties_3: type: object description: The updatable properties of the Pool. properties: provisioningState: $ref: '#/definitions/ProvisioningState_2' description: The status of the current operation. maximumConcurrency: type: integer format: int32 description: Defines how many resources can there be created at any given time. minimum: 1 maximum: 10000 organizationProfile: $ref: '#/definitions/OrganizationProfile' description: Defines the organization in which the pool will be used. agentProfile: $ref: '#/definitions/AgentProfile' description: Defines how the machine will be handled once it executed a job. fabricProfile: $ref: '#/definitions/FabricProfile' description: Defines the type of fabric the agent will run on. devCenterProjectResourceId: type: string description: The resource id of the DevCenter Project the pool belongs to. ServiceArtifactReference: type: object 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.' properties: id: type: string description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} required: - id BatchNodeReimageOption: type: string description: BatchNodeReimageOption enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeReimageOption modelAsString: true values: - name: Requeue 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. - name: Terminate 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. - name: TaskCompletion 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: RetainedData 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. ContainerRegistry: type: object description: A private container registry. properties: username: type: string description: The user name to log into the registry server. password: type: string description: The password to log into the registry server. registryServer: type: string description: The registry URL. If omitted, the default is "docker.io". identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. Pool: type: object description: Pool resource properties: properties: $ref: '#/definitions/PoolProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource Requests: type: object description: Requests for capacity for the pool. properties: storage: type: integer format: int64 description: Requested capacity of the pool in GiB. default: 1024 minimum: 1024 maximum: 65536 UploadBatchServiceLogsResult: type: object description: The result of uploading Batch service log files from a specific Compute Node. properties: virtualDirectoryName: type: string description: The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier. numberOfFilesUploaded: type: integer format: int32 description: The number of log files which will be uploaded. required: - virtualDirectoryName - numberOfFilesUploaded DynamicVNetAssignmentScope: type: string description: DynamicVNetAssignmentScope enums enum: - none - job x-ms-enum: name: DynamicVNetAssignmentScope modelAsString: true values: - name: None value: none description: No dynamic VNet assignment is enabled. - name: Job value: job description: Dynamic VNet assignment is done per-job. BatchNodePlacementPolicyType: type: string description: BatchNodePlacementPolicyType enums enum: - regional - zonal x-ms-enum: name: BatchNodePlacementPolicyType modelAsString: true values: - name: Regional value: regional description: All nodes in the pool will be allocated in the same region. - name: Zonal value: zonal description: Nodes in the pool will be spread across different availability zones with best effort balancing. CloudServiceConfiguration: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.' properties: osFamily: type: string 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 description: The Azure Guest OS version to be installed on the virtual machines in the Pool. The default value is * which specifies the latest operating system version for the specified OS family. required: - osFamily BatchPoolEnableAutoScaleContent: type: object description: Parameters for enabling automatic scaling on an Azure Batch Pool. properties: autoScaleFormula: type: string description: The formula for the desired number of Compute Nodes in the Pool. The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). autoScaleEvaluationInterval: type: string format: duration description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued. ResourceOperationalStatus: type: object description: Status of the resource properties: state: $ref: '#/definitions/ResourceOperationStatusState' description: state of the resource message: type: string description: Reason for state. required: - state SecurityTypes: type: string description: 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: true values: - name: trustedLaunch value: trustedLaunch description: Trusted launch protects against advanced and persistent attack techniques. NetworkConfiguration: type: object description: The network configuration for a Pool. properties: subnetId: type: string description: 'The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of 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.' dynamicVNetAssignmentScope: $ref: '#/definitions/DynamicVNetAssignmentScope' description: The scope of dynamic vnet assignment. endpointConfiguration: $ref: '#/definitions/BatchPoolEndpointConfiguration' description: The configuration for endpoints on Compute Nodes in the Batch Pool. Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property. publicIPAddressConfiguration: $ref: '#/definitions/PublicIpAddressConfiguration' description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property. x-ms-client-name: publicIpAddressConfiguration enableAcceleratedNetworking: type: boolean description: 'Whether this pool should enable accelerated networking. 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.' BatchTaskContainerSettingsUpdate: type: object description: The container settings for a Task. properties: containerRunOptions: type: string description: Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string description: The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. registry: $ref: '#/definitions/ContainerRegistry' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/definitions/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ContainerType: type: string description: ContainerType enums enum: - dockerCompatible - criCompatible x-ms-enum: name: ContainerType modelAsString: true values: - name: DockerCompatible value: dockerCompatible description: A Docker compatible container technology will be used to launch the containers. - name: CriCompatible value: criCompatible description: A CRI based technology will be used to launch the containers. BatchPoolEvaluateAutoScaleContent: type: object description: Parameters for evaluating an automatic scaling formula on an Azure Batch Pool. properties: autoScaleFormula: type: string description: The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). required: - autoScaleFormula SecurityProfile: type: object description: Specifies the security profile settings for the virtual machine or virtual machine scale set. properties: 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. securityType: $ref: '#/definitions/SecurityTypes' description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. uefiSettings: $ref: '#/definitions/UefiSettings' description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. required: - encryptionAtHost - securityType - uefiSettings ReclaimPolicy: type: string description: Reclaim policy enum: - Delete - Retain x-ms-enum: name: ReclaimPolicy modelAsString: true values: - name: Delete value: Delete description: Delete resource - name: Retain value: Retain description: Retain resource BatchNodeVMExtensionListResult: type: object description: The result of listing the Compute Node extensions in a Node. properties: value: type: array description: The list of Compute Node extensions. items: $ref: '#/definitions/BatchNodeVMExtension' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. NetworkSecurityGroupRule: type: object description: A network security group rule to apply to an inbound endpoint. properties: priority: type: integer format: int32 description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. access: $ref: '#/definitions/NetworkSecurityGroupRuleAccess' description: The action that should be taken for a specified IP address, subnet range or tag. sourceAddressPrefix: type: string description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. sourcePortRanges: type: array description: The source port ranges to match for the rule. 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 '*'. items: type: string required: - priority - access - sourceAddressPrefix VirtualMachineConfiguration: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.' properties: imageReference: $ref: '#/definitions/ImageReference' description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. nodeAgentSKUId: type: string description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. 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. x-ms-client-name: nodeAgentSkuId windowsConfiguration: $ref: '#/definitions/WindowsConfiguration' description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. dataDisks: type: array description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each 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. items: $ref: '#/definitions/DataDisk' x-ms-identifiers: [] licenseType: type: string description: "This only applies to Images that contain the Windows operating system, and\nshould only be used when you hold valid on-premises licenses for the Compute\nNodes which will be deployed. If omitted, no on-premises licensing discount is\napplied. Values are:\n\n Windows_Server - The on-premises license is for Windows\nServer.\n Windows_Client - The on-premises license is for Windows Client.\n" containerConfiguration: $ref: '#/definitions/ContainerConfiguration' description: The container configuration for the Pool. 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' description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. nodePlacementConfiguration: $ref: '#/definitions/BatchNodePlacementConfiguration' description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. extensions: type: array description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. items: $ref: '#/definitions/VMExtension' x-ms-identifiers: [] osDisk: $ref: '#/definitions/OSDisk' description: Settings for the operating system disk of the Virtual Machine. securityProfile: $ref: '#/definitions/SecurityProfile' description: Specifies the security profile settings for the virtual machine or virtual machine scale set. serviceArtifactReference: $ref: '#/definitions/ServiceArtifactReference' 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. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} required: - imageReference - nodeAgentSKUId BatchNodeReimageContent: type: object description: Parameters for reimaging an Azure Batch Compute Node. properties: nodeReimageOption: $ref: '#/definitions/BatchNodeReimageOption' description: When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue. BatchPoolIdentity: type: object description: The identity of the Batch pool, if configured. properties: type: $ref: '#/definitions/BatchPoolIdentityType' description: 'The identity of the Batch pool, if configured. 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}''.' userAssignedIdentities: type: array description: 'The list of user identities associated with the Batch account. 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' x-ms-identifiers: [] required: - type ErrorMessage: 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. BatchPoolReplaceContent: type: object description: Parameters for replacing properties on an Azure Batch Pool. properties: startTask: $ref: '#/definitions/BatchStartTask' description: 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. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool. certificateReferences: type: array 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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] applicationPackageReferences: type: array description: The list of Application Packages to be installed on each Compute Node in the Pool. The list replaces any existing Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. This setting replaces any existing targetNodeCommunication setting on the Pool. If omitted, the existing setting is default. required: - certificateReferences - applicationPackageReferences - metadata AssignmentStatusState: type: string description: Status of the assignment resource enum: - Assigning - Assigned - Unassigning - Failed x-ms-enum: name: AssignmentStatusState modelAsString: true values: - name: Assigning value: Assigning description: The assignment of the pool to the resource is in progress - name: Assigned value: Assigned description: The assignment to the pool was successful. - name: Unassigning value: Unassigning description: The pool is being unassigned. - name: Failed value: Failed description: The operation of assigning or unassigning the pool failed. DiskEncryptionTarget: type: string description: DiskEncryptionTarget enums enum: - osdisk - temporarydisk x-ms-enum: name: DiskEncryptionTarget modelAsString: true values: - name: OsDisk value: osdisk description: The OS Disk on the compute node is encrypted. - name: TemporaryDisk 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. UpgradePolicy: type: object description: Describes an upgrade policy - automatic, manual, or rolling. properties: mode: $ref: '#/definitions/UpgradeMode' description: 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. automaticOsUpgradePolicy: $ref: '#/definitions/AutomaticOsUpgradePolicy' description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. x-ms-client-name: automaticOSUpgradePolicy rollingUpgradePolicy: $ref: '#/definitions/RollingUpgradePolicy' description: The configuration parameters used while performing a rolling upgrade. This property is only supported on Pools with the virtualMachineConfiguration property. required: - mode BatchTaskExecutionInfo: type: object description: Information about the execution of a Task. properties: startTime: type: string format: date-time description: The time at which the Task started running. '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 description: The time at which the Task completed. This property is set only if the Task is in the Completed state. exitCode: type: integer format: int32 description: The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: 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. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. requeueCount: type: integer format: int32 description: The number of times the Task has been requeued by the Batch service as the result of a user request. 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 description: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - retryCount - requeueCount BatchError_2: 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_2' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. BatchError: type: object description: An error response received from the Azure Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/BatchErrorMessage' description: A message describing the error, intended to be suitable for display in a user interface. values: type: array description: A collection of key-value pairs containing additional details about the error. items: $ref: '#/definitions/BatchErrorDetail' x-ms-identifiers: [] required: - code BatchNodeVMExtension: type: object description: The configuration for virtual machine extension instance view. properties: provisioningState: type: string description: The provisioning state of the virtual machine extension. vmExtension: $ref: '#/definitions/VMExtension' description: The virtual machine extension. instanceView: $ref: '#/definitions/VMExtensionInstanceView' description: The vm extension instance view. InboundEndpoint: type: object description: An inbound endpoint on a Compute Node. properties: name: type: string description: The name of the endpoint. protocol: $ref: '#/definitions/InboundEndpointProtocol' description: The protocol of the endpoint. publicIPAddress: type: string description: The public IP address of the Compute Node. x-ms-client-name: publicIpAddress publicFQDN: type: string description: The public fully qualified domain name for the Compute Node. frontendPort: type: integer format: int32 description: The public port number of the endpoint. backendPort: type: integer format: int32 description: The backend port number of the endpoint. required: - name - protocol - publicIPAddress - publicFQDN - frontendPort - backendPort BatchTaskExecutionResult: type: string description: BatchTaskExecutionResult enums enum: - success - failure x-ms-enum: name: BatchTaskExecutionResult modelAsString: true values: - name: Success value: success description: The Task ran successfully. - name: Failure 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. BatchNodeError: type: object description: An error encountered by a Compute Node. properties: code: type: string description: An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Compute Node error, intended to be suitable for display in a user interface. errorDetails: type: array description: The list of additional error details related to the Compute Node error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] BatchPoolResizeContent: type: object description: Parameters for changing the size of an Azure Batch Pool. properties: targetDedicatedNodes: type: integer format: int32 description: The desired number of dedicated Compute Nodes in the Pool. targetLowPriorityNodes: type: integer format: int32 description: The desired number of Spot/Low-priority Compute Nodes in the Pool. resizeTimeout: type: string format: duration description: The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). nodeDeallocationOption: $ref: '#/definitions/BatchNodeDeallocationOption' description: Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing. The default value is requeue. BatchPoolIdentityType: type: string description: BatchPoolIdentityType enums enum: - UserAssigned - None x-ms-enum: name: BatchPoolIdentityType modelAsString: true values: - name: UserAssigned value: UserAssigned description: Batch pool has user assigned identities with it. - name: None value: None description: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. Encryption: type: object description: Encryption key properties for the pool. properties: keyName: type: string description: The name of the key vault key. keyVaultUri: type: string description: The URI of the key vault. identity: $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed service identities assigned to this resource. required: - keyName - keyVaultUri BatchNodeFillType: type: string description: BatchNodeFillType enums enum: - spread - pack x-ms-enum: name: BatchNodeFillType modelAsString: true values: - name: Spread value: spread description: Tasks should be assigned evenly across all Compute Nodes in the Pool. - name: Pack 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. BatchPoolEndpointConfiguration: type: object description: The endpoint configuration for a Pool. properties: inboundNATPools: type: array description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. items: $ref: '#/definitions/InboundNATPool' x-ms-client-name: inboundNatPools x-ms-identifiers: [] required: - inboundNATPools PublicIpAddressConfiguration: type: object description: The public IP Address configuration of the networking configuration of a Pool. properties: provision: $ref: '#/definitions/IpAddressProvisioningType' description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. x-ms-client-name: IpAddressProvisioningType ipAddressIds: type: array description: 'The list of public IPs which the Batch service will use when provisioning Compute Nodes. 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}.' items: type: string PoolType: type: object description: 'Type of the Pool: ephemeralDisk, azureDisk, or elasticsan' properties: azureDisk: $ref: '#/definitions/AzureDisk' description: Disk Pool Properties elasticSan: $ref: '#/definitions/ElasticSan' description: Elastic San Pool Properties ephemeralDisk: $ref: '#/definitions/EphemeralDisk' description: Ephemeral Pool Properties BatchPoolCreateContent: type: object description: Parameters for creating an Azure Batch Pool. properties: id: type: string description: A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case). displayName: type: string description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. vmSize: type: string description: The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines for Cloud Services Pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). cloudServiceConfiguration: $ref: '#/definitions/CloudServiceConfiguration' description: The cloud service configuration for the Pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. virtualMachineConfiguration: $ref: '#/definitions/VirtualMachineConfiguration' description: The virtual machine configuration for the Pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. resizeTimeout: type: string format: duration description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). resourceTags: type: object description: The user-specified tags associated with the pool. 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'. additionalProperties: type: string targetDedicatedNodes: type: integer format: int32 description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. targetLowPriorityNodes: type: integer format: int32 description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. enableAutoScale: type: boolean description: Whether the Pool size should automatically adjust over time. 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 description: A formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). autoScaleEvaluationInterval: type: string format: duration description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). enableInterNodeCommunication: type: boolean description: Whether the Pool permits direct communication between Compute Nodes. 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' description: The network configuration for the Pool. startTask: $ref: '#/definitions/BatchStartTask' description: A Task specified 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 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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] applicationPackageReferences: type: array description: The list of Packages to be installed on each Compute Node in the Pool. 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. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] applicationLicenses: type: array description: The list of application licenses the Batch service will make available on each Compute Node in the Pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. items: type: string taskSlotsPerNode: type: integer format: int32 description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. taskSchedulingPolicy: $ref: '#/definitions/BatchTaskSchedulingPolicy' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/definitions/UserAccount' x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] mountConfiguration: type: array description: Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system. items: $ref: '#/definitions/MountConfiguration' x-ms-identifiers: [] targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. If omitted, the default value is Default. upgradePolicy: $ref: '#/definitions/UpgradePolicy' description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. required: - id - vmSize PoolListResult: type: object description: The response of a Pool list operation. properties: value: type: array description: The Pool items on this page items: $ref: '#/definitions/Pool' nextLink: type: string format: uri description: The link to the next page of items required: - value BatchCertificateVisibility: type: string description: BatchCertificateVisibility enums enum: - starttask - task - remoteuser x-ms-enum: name: BatchCertificateVisibility modelAsString: true values: - name: StartTask 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: Task value: task description: The Certificate should be visible to the user accounts under which Job Tasks are run. - name: RemoteUser value: remoteuser description: The Certificate should be visible to the user accounts under which users remotely access the Compute Node. BatchPoolUpdateContent: type: object description: Parameters for updating an Azure Batch Pool. properties: startTask: $ref: '#/definitions/BatchStartTaskUpdate' description: 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. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged. certificateReferences: type: array 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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] applicationPackageReferences: type: array description: A list of Packages to be installed on each Compute Node in the Pool. 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. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged. Disk: type: object description: Model for disk for that pool is using properties: id: type: string description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 reference: type: string description: Reference is the location of the disk in an external system. required: - id - reference PoolUpdateProperties_2: description: Properties of a Pool. These properties can be updated after the resource has been created. type: object properties: devBoxDefinitionName: description: Name of a Dev Box definition in parent Project of this Pool type: string networkConnectionName: description: Name of a Network Connection in parent Project of this Pool type: string licenseType: description: Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. $ref: '#/definitions/LicenseType' localAdministrator: description: Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. $ref: '#/definitions/LocalAdminStatus' DiffDiskPlacement: type: string description: AccessDiffDiskPlacementScope enums enum: - cachedisk x-ms-enum: name: DiffDiskPlacement modelAsString: true values: - name: CacheDisk value: cachedisk description: The Ephemeral OS Disk is stored on the VM cache. BatchNodeRebootContent: type: object description: Parameters for rebooting an Azure Batch Compute Node. properties: nodeRebootOption: $ref: '#/definitions/BatchNodeRebootOption' description: When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue. UserAccount: type: object description: 'Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.' properties: name: type: string description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. password: type: string description: The password for the user Account. elevationLevel: $ref: '#/definitions/ElevationLevel' description: The elevation level of the user Account. The default value is nonAdmin. linuxUserConfiguration: $ref: '#/definitions/LinuxUserConfiguration' description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. windowsUserConfiguration: $ref: '#/definitions/WindowsUserConfiguration' description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. required: - name - password VMExtension: type: object description: The configuration for virtual machine extensions. properties: name: type: string description: The name of the virtual machine extension. publisher: type: string description: The name of the extension handler publisher. type: type: string description: The type of the extension. typeHandlerVersion: type: string description: 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 description: JSON formatted public settings for the extension. additionalProperties: type: string protectedSettings: type: object description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. additionalProperties: type: string provisionAfterExtensions: type: array description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. items: type: string required: - name - publisher - type PoolUsageMetrics: 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. BatchNodeDisableSchedulingContent: type: object description: Parameters for disabling scheduling on an Azure Batch Compute Node. properties: nodeDisableSchedulingOption: $ref: '#/definitions/BatchNodeDisableSchedulingOption' description: What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue. FabricProfile: type: object description: Defines the type of fabric the agent will run on. properties: kind: type: string description: Discriminator property for FabricProfile. discriminator: kind required: - kind BatchPool: type: object description: A Pool in the Azure Batch service. properties: id: type: string description: A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). readOnly: true displayName: type: string description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. readOnly: true url: type: string description: The URL of the Pool. readOnly: true eTag: type: string description: The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime. readOnly: true lastModified: type: string format: date-time description: The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state. readOnly: true creationTime: type: string format: date-time description: The creation time of the Pool. readOnly: true state: $ref: '#/definitions/BatchPoolState' description: The current state of the Pool. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Pool entered its current state. readOnly: true allocationState: $ref: '#/definitions/AllocationState' description: Whether the Pool is resizing. readOnly: true allocationStateTransitionTime: type: string format: date-time description: The time at which the Pool entered its current allocation state. readOnly: true vmSize: type: string description: The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). readOnly: true cloudServiceConfiguration: $ref: '#/definitions/CloudServiceConfiguration' description: The cloud service configuration for the Pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. readOnly: true virtualMachineConfiguration: $ref: '#/definitions/VirtualMachineConfiguration' description: The virtual machine configuration for the Pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. readOnly: true resizeTimeout: type: string format: duration description: The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes. readOnly: true resizeErrors: type: array description: A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady. items: $ref: '#/definitions/ResizeError' readOnly: true x-ms-identifiers: [] resourceTags: type: object description: The user-specified tags associated with the pool. 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'. additionalProperties: type: string readOnly: true currentDedicatedNodes: type: integer format: int32 description: The number of dedicated Compute Nodes currently in the Pool. readOnly: true currentLowPriorityNodes: type: integer format: int32 description: The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count. readOnly: true targetDedicatedNodes: type: integer format: int32 description: The desired number of dedicated Compute Nodes in the Pool. readOnly: true targetLowPriorityNodes: type: integer format: int32 description: The desired number of Spot/Low-priority Compute Nodes in the Pool. readOnly: true enableAutoScale: type: boolean description: Whether the Pool size should automatically adjust over time. 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. readOnly: true autoScaleFormula: type: string description: A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. readOnly: true autoScaleEvaluationInterval: type: string format: duration description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. readOnly: true autoScaleRun: $ref: '#/definitions/AutoScaleRun' description: The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. readOnly: true enableInterNodeCommunication: type: boolean description: Whether the Pool permits direct communication between Compute Nodes. 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. readOnly: true networkConfiguration: $ref: '#/definitions/NetworkConfiguration' description: The network configuration for the Pool. readOnly: true startTask: $ref: '#/definitions/BatchStartTask' description: A Task specified to run on each Compute Node as it joins the Pool. certificateReferences: type: array 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.' items: $ref: '#/definitions/BatchCertificateReference' readOnly: true x-ms-identifiers: [] applicationPackageReferences: type: array description: The list of Packages to be installed on each Compute Node in the Pool. 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. items: $ref: '#/definitions/BatchApplicationPackageReference' readOnly: true x-ms-identifiers: [] applicationLicenses: type: array description: The list of application licenses the Batch service will make available on each Compute Node in the Pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. items: type: string readOnly: true taskSlotsPerNode: type: integer format: int32 description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. readOnly: true taskSchedulingPolicy: $ref: '#/definitions/BatchTaskSchedulingPolicy' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. readOnly: true userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/definitions/UserAccount' readOnly: true x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. items: $ref: '#/definitions/MetadataItem' readOnly: true x-ms-identifiers: [] stats: $ref: '#/definitions/BatchPoolStatistics' description: Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. readOnly: true mountConfiguration: type: array description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. items: $ref: '#/definitions/MountConfiguration' readOnly: true x-ms-identifiers: [] identity: $ref: '#/definitions/BatchPoolIdentity' description: 'The identity of the Batch pool, if configured. 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}''.' readOnly: true targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. If omitted, the default value is Default. currentNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The current state of the pool communication mode. readOnly: true upgradePolicy: $ref: '#/definitions/UpgradePolicy' description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. BatchCertificateStoreLocation: type: string description: BatchCertificateStoreLocation enums enum: - currentuser - localmachine x-ms-enum: name: BatchCertificateStoreLocation modelAsString: true values: - name: CurrentUser value: currentuser description: Certificates should be installed to the CurrentUser Certificate store. - name: LocalMachine value: localmachine description: Certificates should be installed to the LocalMachine Certificate store. LocalAdminStatus: type: string enum: - Disabled - Enabled x-ms-enum: name: LocalAdminStatus modelAsString: true BatchNodeUserCreateContent: type: object description: Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node. properties: name: type: string description: The user name of the Account. isAdmin: type: boolean description: Whether the Account should be an administrator on the Compute Node. The default value is false. expiryTime: type: string format: date-time description: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. password: type: string description: The password of the Account. 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 description: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux 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 RollingUpgradePolicy: type: object description: The configuration parameters used while performing a rolling upgrade. 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 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 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 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. ElasticSan: type: object description: Elastic San Pool Properties properties: resourceGroup: type: string description: Managed resource group for the pool. readOnly: true skuName: $ref: '#/definitions/ElasticSanSkuName' description: Sku name x-ms-mutability: - read - create encryption: $ref: '#/definitions/Encryption' description: Encryption specifies the encryption configuration for the Azure Disk pool x-ms-mutability: - read - create BatchStartTask: type: object 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.' properties: commandLine: type: string description: The command line of the StartTask. 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/BatchTaskContainerSettings' description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. 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 description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). waitForSuccess: type: boolean description: 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. 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 BatchNodeListResult: type: object description: The result of listing the Compute Nodes in a Pool. properties: value: type: array description: The list of Compute Nodes. items: $ref: '#/definitions/BatchNode' odata.nextLink: type: string description: The URL to get the next set of results. OrganizationProfile: type: object description: Defines the organization in which the pool will be used. properties: kind: type: string description: Discriminator property for OrganizationProfile. discriminator: kind required: - kind PoolProperties_2: type: object description: Properties of a Pool allOf: - $ref: '#/definitions/PoolUpdateProperties_2' properties: provisioningState: description: The provisioning state of the resource. $ref: commonDefinitions.json#/definitions/ProvisioningState readOnly: true required: - devBoxDefinitionName - networkConnectionName - licenseType - localAdministrator BatchPoolState: type: string description: BatchPoolState enums enum: - active - deleting x-ms-enum: name: BatchPoolState modelAsString: true values: - name: Active value: active description: The Pool is available to run Tasks subject to the availability of Compute Nodes. - name: Deleting value: deleting description: The user has requested that the Pool be deleted, but the delete operation has not yet completed. UserIdentity: type: object description: The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both. properties: username: type: string description: The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/definitions/AutoUserSpecification' description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. PoolListUsageMetricsResult: 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. LinuxUserConfiguration: type: object description: Properties used to create a user Account on a Linux Compute Node. properties: uid: type: integer format: int32 description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. gid: type: integer format: int32 description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. sshPrivateKey: type: string description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between 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). BatchErrorDetail_2: 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. BatchStartTaskState: type: string description: BatchStartTaskState enums enum: - running - completed x-ms-enum: name: BatchStartTaskState modelAsString: true values: - name: Running value: running description: The StartTask is currently running. - name: Completed 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). ResizeError: type: object description: An error that occurred when resizing a Pool. properties: code: type: string description: An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Pool resize error, intended to be suitable for display in a user interface. values: type: array description: A list of additional error details related to the Pool resize error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] BatchNodePlacementConfiguration: type: object 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/BatchNodePlacementPolicyType' description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. DiffDiskSettings: type: object description: 'Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).' properties: placement: $ref: '#/definitions/DiffDiskPlacement' description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. 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. DiskEncryptionConfiguration: type: object 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.' properties: targets: type: array description: The list of disk targets Batch Service will encrypt on the compute node. 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. items: $ref: '#/definitions/DiskEncryptionTarget' BatchStartTaskUpdate: type: object 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.' properties: commandLine: type: string description: The command line of the StartTask. 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/BatchTaskContainerSettingsUpdate' description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. 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 description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). waitForSuccess: type: boolean description: 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. 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. LicenseType: description: License Types enum: - Windows_Client type: string x-ms-enum: name: LicenseType modelAsString: true AutoUserScope: type: string description: AutoUserScope enums enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: true values: - name: Task value: task description: Specifies that the service should create a new user for the Task. - name: Pool value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. Pool_3: type: object description: Concrete tracked resource types can be created by aliasing this type using a specific property type. properties: properties: $ref: '#/definitions/PoolProperties_3' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create identity: $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed service identities assigned to this resource. allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource BatchPoolStatistics: type: object description: Contains utilization and resource usage statistics for the lifetime of a Pool. properties: url: type: string description: The URL for the statistics. startTime: type: string format: date-time description: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. usageStats: $ref: '#/definitions/BatchPoolUsageStatistics' description: Statistics related to Pool usage, such as the amount of core-time used. resourceStats: $ref: '#/definitions/BatchPoolResourceStatistics' description: Statistics related to resource consumption by Compute Nodes in the Pool. required: - url - startTime - lastUpdateTime MetadataItem: type: object description: 'The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.' properties: name: type: string description: The name of the metadata item. value: type: string description: The value of the metadata item. required: - name - value ElasticSanUpdate: type: object description: Elastic San Pool Properties IpAddressProvisioningType: type: string description: IPAddressProvisioningType enums enum: - batchmanaged - usermanaged - nopublicipaddresses x-ms-enum: name: IpAddressProvisioningType modelAsString: true values: - name: BatchManaged 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: UserManaged value: usermanaged description: Public IPs are provided by the user and will be used to provision the Compute Nodes. - name: NoPublicIpAddresses value: nopublicipaddresses description: No public IP Address will be created. BatchTaskInfo: type: object description: Information about a Task running on a Compute Node. properties: taskUrl: type: string description: The URL of the Task. jobId: type: string description: The ID of the Job to which the Task belongs. taskId: type: string description: The ID of the Task. subtaskId: type: integer format: int32 description: The ID of the subtask if the Task is a multi-instance Task. taskState: $ref: '#/definitions/BatchTaskState' description: The current state of the Task. executionInfo: $ref: '#/definitions/BatchTaskExecutionInfo' description: Information about the execution of the Task. required: - taskState BatchNodeRemoveContent: type: object description: Parameters for removing nodes from an Azure Batch Pool. properties: nodeList: type: array description: A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request. items: type: string resizeTimeout: type: string format: duration description: The timeout for removal of Compute Nodes to the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). nodeDeallocationOption: $ref: '#/definitions/BatchNodeDeallocationOption' description: Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue. required: - nodeList NetworkSecurityGroupRuleAccess: type: string description: NetworkSecurityGroupRuleAccess enums enum: - allow - deny x-ms-enum: name: NetworkSecurityGroupRuleAccess modelAsString: true values: - name: Allow value: allow description: Allow access. - name: Deny value: deny description: Deny access. BatchTaskContainerExecutionInfo: type: object description: Contains information about the container which a Task is executing. properties: containerId: type: string description: The ID of the container. state: type: string description: The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect". error: type: string description: Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect". ImageReference: type: object description: '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.' properties: publisher: type: string description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. offer: type: string description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. sku: type: string description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. version: type: string description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string description: 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. 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 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'. readOnly: true DataDisk: type: object description: '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.' properties: lun: type: integer format: int32 description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. x-ms-client-name: logicalUnitNumber caching: $ref: '#/definitions/CachingType' description: 'The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.' diskSizeGB: type: integer format: int32 description: The initial disk size in gigabytes. x-ms-client-name: diskSizeGb storageAccountType: $ref: '#/definitions/StorageAccountType' description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". required: - lun - diskSizeGB EnvironmentSetting: type: object description: An environment variable to be set on a Task process. properties: name: type: string description: The name of the environment variable. value: type: string description: The value of the environment variable. required: - name BatchErrorMessage: type: object description: An error message received in an Azure Batch error response. properties: lang: type: string description: The language code of the error message. value: type: string description: The text of the message. BatchCertificateReference: type: object description: 'A reference to a Certificate to be installed on Compute Nodes in a Pool. 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.' properties: thumbprint: type: string description: The thumbprint of the Certificate. thumbprintAlgorithm: type: string description: The algorithm with which the thumbprint is associated. This must be sha1. storeLocation: $ref: '#/definitions/BatchCertificateStoreLocation' description: The location of the Certificate store on the Compute Node into which to install the Certificate. The default value is currentuser. This property is applicable only for Pools configured with Windows 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. storeName: type: string description: 'The name of the Certificate store on the Compute Node into which to install the Certificate. This property is applicable only for Pools configured with Windows 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 description: Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more than one visibility in this collection. The default is all Accounts. items: $ref: '#/definitions/BatchCertificateVisibility' required: - thumbprint - thumbprintAlgorithm AzureBlobFileSystemConfiguration: type: object description: Information used to connect to an Azure Storage Container using Blobfuse. properties: accountName: type: string description: The Azure Storage Account name. containerName: type: string description: The Azure Blob Storage Container name. accountKey: type: string description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. sasKey: type: string description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. blobfuseOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. required: - accountName - containerName - relativeMountPath BatchNodeCommunicationMode: type: string description: BatchNodeCommunicationMode enums enum: - default - classic - simplified x-ms-enum: name: BatchNodeCommunicationMode modelAsString: true values: - name: Default value: default description: The node communication mode is automatically set by the Batch service. - name: Classic 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. - name: Simplified 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. BatchNodeAgentInfo: type: object 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.' properties: version: type: string description: The version of the Batch Compute Node agent running on the Compute Node. 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 description: The time when the Compute Node agent was updated on the Compute Node. This is the most recent time that the Compute Node agent was updated to a new version. required: - version - lastUpdateTime WindowsConfiguration: type: object description: Windows operating system settings to apply to the virtual machine. properties: enableAutomaticUpdates: type: boolean description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. Zone: type: string description: Availability Zones enum: - '1' - '2' - '3' x-ms-enum: name: Zone modelAsString: true values: - name: Zone1 value: '1' description: First availability zone. - name: Zone2 value: '2' description: Second availability zone. - name: Zone3 value: '3' description: Third availability zone. CachingType: type: string description: CachingType enums enum: - none - readonly - readwrite x-ms-enum: name: CachingType modelAsString: true values: - name: None value: none description: The caching mode for the disk is not enabled. - name: ReadOnly value: readonly description: The caching mode for the disk is read only. - name: ReadWrite value: readwrite description: The caching mode for the disk is read and write. BatchNodeUserUpdateContent: type: object description: Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node. properties: password: type: string description: The password of the Account. 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 description: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. sshPublicKey: type: string description: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux 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. BatchTaskFailureInfo: type: object description: Information about a Task failure. properties: category: $ref: '#/definitions/ErrorCategory' description: The category of the Task error. code: type: string description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Task error, intended to be suitable for display in a user interface. details: type: array description: A list of additional details related to the error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] required: - category FileProperties: type: object description: The properties of a file on a Compute Node. properties: creationTime: type: string format: date-time description: The file creation time. The creation time is not returned for files on Linux Compute Nodes. lastModified: type: string format: date-time description: The time at which the file was last modified. contentLength: type: integer format: int32 description: The length of the file. contentType: type: string description: The content type of the file. fileMode: type: string description: The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes. required: - lastModified - contentLength BatchNodeDeallocationOption: type: string description: BatchNodeDeallocationOption enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeDeallocationOption modelAsString: true values: - name: Requeue 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. - name: Terminate 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. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed. - name: RetainedData 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. LoginMode: type: string description: LoginMode enums enum: - batch - interactive x-ms-enum: name: LoginMode modelAsString: true values: - name: Batch value: batch description: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. - name: Interactive 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. PoolProperties: type: object description: Pool Properties properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true status: $ref: '#/definitions/ResourceOperationalStatus' description: The operational status of the resource readOnly: true zones: type: array description: List of availability zones that resources can be created in. maxItems: 3 items: $ref: '#/definitions/Zone' x-ms-mutability: - read - create resources: $ref: '#/definitions/Resources' description: Resources represent the resources the pool should have. poolType: $ref: '#/definitions/PoolType' description: 'Type of the Pool: ephemeralDisk, azureDisk, or elasticsan.' reclaimPolicy: $ref: '#/definitions/ReclaimPolicy' description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted x-ms-mutability: - read - create assignments: type: array description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. items: $ref: '#/definitions/Assignment' required: - poolType AzureDiskSkuName: type: string description: SKU of the underlying managed disk enum: - Premium_LRS - Standard_LRS - StandardSSD_LRS - UltraSSD_LRS - Premium_ZRS - PremiumV2_LRS - StandardSSD_ZRS x-ms-enum: name: AzureDiskSkuName modelAsString: true values: - name: Premium_LRS value: Premium_LRS description: Premium_LRS SKU - name: Standard_LRS value: Standard_LRS description: Standard_LRS SKU - name: StandardSSD_LRS value: StandardSSD_LRS description: StandardSSD_LRS SKU - name: UltraSSD_LRS value: UltraSSD_LRS description: UltraSSD_LRS SKU - name: Premium_ZRS value: Premium_ZRS description: Premium_ZRS SKU - name: PremiumV2_LRS value: PremiumV2_LRS description: PremiumV2_LRS SKU - name: StandardSSD_ZRS value: StandardSSD_ZRS description: StandardSSD_ZRS SKU BatchStartTaskInfo: type: object description: Information about a StartTask running on a Compute Node. properties: state: $ref: '#/definitions/BatchStartTaskState' description: The state of the StartTask on the Compute Node. startTime: type: string format: date-time description: The time at which the StartTask started running. This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running). endTime: type: string format: date-time description: The time at which the StartTask stopped running. 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 description: The exit code of the program specified on the StartTask command line. 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/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: 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. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - state - startTime - retryCount EphemeralDisk: type: object description: Ephemeral Disk Pool Properties properties: replicas: type: integer format: int64 description: The number of data copies. Default 3. default: 3 minimum: 1 maximum: 3 disks: type: array description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). items: $ref: '#/definitions/Disk' ResourceStatistics: 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. NameValuePair: type: object description: Represents a name-value pair. properties: name: type: string description: The name in the name-value pair. value: type: string description: The value in the name-value pair. BatchNodeDisableSchedulingOption: type: string description: BatchNodeDisableSchedulingOption enums enum: - requeue - terminate - taskcompletion x-ms-enum: name: BatchNodeDisableSchedulingOption modelAsString: true values: - name: Requeue 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. - name: Terminate 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. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed. BatchPoolListResult: type: object description: The result of listing the Pools in an Account. properties: value: type: array description: The list of Pools. items: $ref: '#/definitions/BatchPool' odata.nextLink: type: string description: The URL to get the next set of results. VMExtensionInstanceView: type: object description: The vm extension instance view. properties: name: type: string description: The name of the vm extension instance view. statuses: type: array description: The resource status information. items: $ref: '#/definitions/InstanceViewStatus' x-ms-identifiers: [] subStatuses: type: array description: The resource status information. items: $ref: '#/definitions/InstanceViewStatus' x-ms-identifiers: [] UpgradeMode: type: string description: UpgradeMode enums enum: - automatic - manual - rolling x-ms-enum: name: UpgradeMode modelAsString: true values: - name: Automatic value: automatic description: TAll virtual machines in the scale set are automatically updated at the same time. - name: Manual value: manual description: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. - name: Rolling 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. ElasticSanSkuName: type: string description: ElasticSAN SKUs enum: - Premium_LRS - Premium_ZRS x-ms-enum: name: ElasticSanSkuName modelAsString: true values: - name: Premium_LRS value: Premium_LRS description: Premium_LRS SKU - name: Premium_ZRS value: Premium_ZRS description: Premium_ZRS SKU AzureFileShareConfiguration: type: object description: Information used to connect to an Azure Fileshare. properties: accountName: type: string description: The Azure Storage account name. azureFileUrl: type: string description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. accountKey: type: string description: The Azure Storage account key. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. required: - accountName - azureFileUrl - accountKey - relativeMountPath NfsMountConfiguration: type: object description: Information used to connect to an NFS file system. properties: source: type: string description: The URI of the file system to mount. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. required: - source - relativeMountPath Resources: type: object description: Resource Requests for the pool. properties: requests: $ref: '#/definitions/Requests' description: Requests for capacity for the pool. AutoScaleRun: type: object description: The results and errors from an execution of a Pool autoscale formula. properties: timestamp: type: string format: date-time description: The time at which the autoscale formula was last evaluated. results: type: string description: The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons. error: $ref: '#/definitions/AutoScaleRunError' description: Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful. required: - timestamp BatchTaskState: type: string description: BatchTaskState enums enum: - active - preparing - running - completed x-ms-enum: name: BatchTaskState modelAsString: true values: - name: Active 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. - name: Preparing 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. - name: Running 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. - name: Completed 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. AssignmentId: type: string format: arm-id description: A type definition that refers the id to an Azure Resource Manager resource. x-ms-arm-id-details: allowedResources: - type: Microsoft.ContainerService/managedClusters PoolUpdate: type: object description: The type used for update operations of the Pool. properties: tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/PoolUpdateProperties' x-ms-client-flatten: true BatchNodeFileListResult: type: object description: 'The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.' properties: value: type: array description: The list of files. items: $ref: '#/definitions/BatchNodeFile' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. AutoScaleRunError: type: object description: An error that occurred when executing or evaluating a Pool autoscale formula. properties: code: type: string description: An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the autoscale error, intended to be suitable for display in a user interface. values: type: array description: A list of additional error details related to the autoscale error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] BatchNodeRebootOption: type: string description: BatchNodeRebootOption enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeRebootOption modelAsString: true values: - name: Requeue 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. - name: Terminate 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. - name: TaskCompletion 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: RetainedData 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. UploadBatchServiceLogsContent: type: object description: The Azure Batch service log files upload parameters for a Compute Node. properties: containerUrl: type: string description: The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). 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 description: The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. endTime: type: string format: date-time description: The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime. identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container. required: - containerUrl - startTime ContainerConfiguration: type: object description: The configuration for container-enabled Pools. properties: type: $ref: '#/definitions/ContainerType' description: The container technology to be used. containerImageNames: type: array description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. items: type: string containerRegistries: type: array description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. items: $ref: '#/definitions/ContainerRegistry' x-ms-identifiers: [] required: - type OSDisk: type: object description: Settings for the operating system disk of the compute node (VM). properties: ephemeralOSDiskSettings: $ref: '#/definitions/DiffDiskSettings' description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). caching: $ref: '#/definitions/CachingType' description: 'Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.' diskSizeGB: type: integer format: int32 description: The initial disk size in GB when creating new OS disk. managedDisk: $ref: '#/definitions/ManagedDisk' description: The managed disk parameters. writeAcceleratorEnabled: type: boolean description: Specifies whether writeAccelerator should be enabled or disabled on the disk. Pool_2: description: A pool of Virtual Machines. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: description: Pool properties x-ms-client-flatten: true $ref: '#/definitions/PoolProperties_2' AssignmentStatus: type: object description: Status of the assignment resource properties: state: $ref: '#/definitions/AssignmentStatusState' description: State of the assignment resource message: type: string description: Reason for the status required: - state ManagedDisk: type: object description: The managed disk parameters. properties: storageAccountType: $ref: '#/definitions/StorageAccountType' description: The storage account type for managed disk. required: - storageAccountType MountConfiguration: type: object description: The file system to mount on each node. properties: azureBlobFileSystemConfiguration: $ref: '#/definitions/AzureBlobFileSystemConfiguration' description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. nfsMountConfiguration: $ref: '#/definitions/NfsMountConfiguration' description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. cifsMountConfiguration: $ref: '#/definitions/CifsMountConfiguration' description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. azureFileShareConfiguration: $ref: '#/definitions/AzureFileShareConfiguration' description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. UsageStatistics: 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. CifsMountConfiguration: type: object description: Information used to connect to a CIFS file system. properties: username: type: string description: The user to use for authentication against the CIFS file system. source: type: string description: The URI of the file system to mount. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. password: type: string description: The password to use for authentication against the CIFS file system. required: - username - source - relativeMountPath - password BatchNodeState: type: string description: BatchNodeState enums enum: - idle - rebooting - reimaging - running - unusable - creating - starting - waitingforstarttask - starttaskfailed - unknown - leavingpool - offline - preempted - upgradingos x-ms-enum: name: BatchNodeState modelAsString: true values: - name: Idle value: idle description: The Compute Node is not currently running a Task. - name: Rebooting value: rebooting description: The Compute Node is rebooting. - name: Reimaging value: reimaging description: The Compute Node is reimaging. - name: Running value: running description: The Compute Node is running one or more Tasks (other than a StartTask). - name: Unusable value: unusable description: The Compute Node cannot be used for Task execution due to errors. - name: Creating 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. - name: Starting value: starting description: The Batch service is starting on the underlying virtual machine. - name: WaitingForStartTask value: waitingforstarttask description: The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed. - name: StartTaskFailed 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: Unknown value: unknown description: The Batch service has lost contact with the Compute Node, and does not know its true state. - name: LeavingPool 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: Offline value: offline description: The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled. - name: Preempted 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. - name: UpgradingOS value: upgradingos description: The Compute Node is undergoing an OS upgrade operation. AgentProfile: type: object description: The agent profile of the machines in the pool. properties: kind: type: string description: Discriminator property for AgentProfile. resourcePredictions: $ref: '#/definitions/ResourcePredictions' description: Defines pool buffer. discriminator: kind required: - kind InboundNATPool: type: object description: 'A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.' properties: name: type: string description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. protocol: $ref: '#/definitions/InboundEndpointProtocol' description: The protocol of the endpoint. backendPort: type: integer format: int32 description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. frontendPortRangeStart: type: integer format: int32 description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. frontendPortRangeEnd: type: integer format: int32 description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. networkSecurityGroupRules: type: array description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. items: $ref: '#/definitions/NetworkSecurityGroupRule' x-ms-identifiers: [] required: - name - protocol - backendPort - frontendPortRangeStart - frontendPortRangeEnd ContainerWorkingDirectory: type: string description: ContainerWorkingDirectory enums enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: true values: - name: TaskWorkingDirectory value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - name: ContainerImageDefault 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. InstanceViewStatus: type: object description: The instance view status. properties: code: type: string description: The status code. displayStatus: type: string description: The localized label for the status. level: $ref: '#/definitions/StatusLevelTypes' description: Level code. message: type: string description: The detailed status message. time: type: string format: date-time description: The time of the status. ResourceOperationStatusState: type: string description: State of the resource. enum: - Pending - Available - Unavailable x-ms-enum: name: ResourceOperationStatusState modelAsString: true values: - name: Pending value: Pending description: The resource is pending. - name: Available value: Available description: The resource is available. - name: Unavailable value: Unavailable description: The resource is unavailable. BatchPoolUsageStatistics: type: object description: Statistics related to Pool usage information. properties: startTime: type: string format: date-time description: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time description: 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 description: The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool. required: - startTime - lastUpdateTime - dedicatedCoreTime BatchPoolResourceStatistics: type: object description: Statistics related to resource consumption by Compute Nodes in a Pool. properties: startTime: type: string format: date-time description: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. avgCPUPercentage: type: number format: float description: The average CPU usage across all Compute Nodes in the Pool (percentage per node). x-ms-client-name: avgCpuPercentage avgMemoryGiB: type: number format: float description: The average memory usage in GiB across all Compute Nodes in the Pool. peakMemoryGiB: type: number format: float description: The peak memory usage in GiB across all Compute Nodes in the Pool. avgDiskGiB: type: number format: float description: The average used disk space in GiB across all Compute Nodes in the Pool. peakDiskGiB: type: number format: float description: The peak used disk space in GiB across all Compute Nodes in the Pool. diskReadIOps: type: integer format: int32 description: The total number of disk read operations across all Compute Nodes in the Pool. diskWriteIOps: type: integer format: int32 description: The total number of disk write operations across all Compute Nodes in the Pool. diskReadGiB: type: number format: float description: The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. diskWriteGiB: type: number format: float description: The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. networkReadGiB: type: number format: float description: The total amount of data in GiB of network reads across all Compute Nodes in the Pool. networkWriteGiB: type: number format: float description: 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 PoolListResult_2: description: Results of the machine pool list operation. type: object properties: value: description: Current page of results. type: array items: $ref: '#/definitions/Pool_2' readOnly: true nextLink: description: URL to get the next set of results if there are any. type: string readOnly: true PoolProperties_3: type: object description: Pool properties properties: provisioningState: $ref: '#/definitions/ProvisioningState_2' description: The status of the current operation. maximumConcurrency: type: integer format: int32 description: Defines how many resources can there be created at any given time. minimum: 1 maximum: 10000 organizationProfile: $ref: '#/definitions/OrganizationProfile' description: Defines the organization in which the pool will be used. agentProfile: $ref: '#/definitions/AgentProfile' description: Defines how the machine will be handled once it executed a job. fabricProfile: $ref: '#/definitions/FabricProfile' description: Defines the type of fabric the agent will run on. devCenterProjectResourceId: type: string description: The resource id of the DevCenter Project the pool belongs to. required: - maximumConcurrency - organizationProfile - agentProfile - fabricProfile - devCenterProjectResourceId BatchNodeFile: type: object description: Information about a file or directory on a Compute Node. properties: name: type: string description: The file path. url: type: string description: The URL of the file. isDirectory: type: boolean description: Whether the object represents a directory. properties: $ref: '#/definitions/FileProperties' description: The file properties. ElevationLevel: type: string description: ElevationLevel enums enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: true values: - name: NonAdmin value: nonadmin description: The user is a standard user without elevated access. - name: Admin value: admin description: The user is a user with elevated access and operates with full Administrator permissions. StatusLevelTypes: type: string description: Level code. enum: - Error - Info - Warning x-ms-enum: name: StatusLevelTypes modelAsString: true values: - name: Error value: Error description: Error - name: Info value: Info description: Info - name: Warning value: Warning description: Warning PoolUpdate_3: type: object description: The type used for update operations of the Pool. properties: identity: $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed service identities assigned to this resource. tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/PoolUpdateProperties_3' x-ms-client-flatten: true UserAssignedIdentity: type: object description: The user assigned Identity properties: resourceId: type: string description: The ARM resource id of the user assigned identity. clientId: type: string description: The client id of the user assigned identity. readOnly: true principalId: type: string description: The principal id of the user assigned identity. readOnly: true required: - resourceId WindowsUserConfiguration: type: object description: Properties used to create a user Account on a Windows Compute Node. properties: loginMode: $ref: '#/definitions/LoginMode' description: The login mode for the user. The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'. StorageAccountType: type: string description: StorageAccountType enums enum: - standard_lrs - premium_lrs - standardssd_lrs x-ms-enum: name: StorageAccountType modelAsString: true values: - name: StandardLRS value: standard_lrs description: The data disk should use standard locally redundant storage. - name: PremiumLRS value: premium_lrs description: The data disk should use premium locally redundant storage. - name: StandardSSDLRS value: standardssd_lrs description: The data disk / OS disk should use standard SSD locally redundant storage. BatchApplicationPackageReference: type: object description: A reference to an Package to be deployed to Compute Nodes. properties: applicationId: type: string description: The ID of the application to deploy. 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 description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. required: - applicationId PoolTypeUpdate: type: object description: 'Type of the Pool: ephemeralDisk, azureDisk, or elasticsan' properties: azureDisk: $ref: '#/definitions/AzureDiskUpdate' description: Disk Pool Properties elasticSan: $ref: '#/definitions/ElasticSanUpdate' description: Elastic San Pool Properties ephemeralDisk: $ref: '#/definitions/EphemeralDisk' description: Ephemeral Pool Properties PoolStatistics: 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. AzureDisk: type: object description: Azure Disk Pool Properties properties: resourceGroup: type: string description: Managed resource group for the pool. readOnly: true skuName: $ref: '#/definitions/AzureDiskSkuName' description: Sku name x-ms-mutability: - read - create encryption: $ref: '#/definitions/Encryption' description: Encryption specifies the encryption configuration for the Azure Disk pool x-ms-mutability: - read - create disks: type: array description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). items: $ref: '#/definitions/Disk' ResourceFile: type: object description: A single file or multiple files to be downloaded to a Compute Node. properties: autoStorageContainerName: type: string description: The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string description: 'The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 description: 'The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable 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 description: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string description: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string description: The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows 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: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. AutomaticOsUpgradePolicy: type: object description: The configuration parameters used for performing automatic OS upgrade. 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. x-ms-client-name: enableAutomaticOSUpgrade 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. BatchNodeIdentityReference: type: object description: 'The reference to a user assigned identity associated with the Batch pool which a compute node will use.' properties: resourceId: type: string description: The ARM resource id of the user assigned identity. ErrorCategory: type: string description: ErrorCategory enums enum: - usererror - servererror x-ms-enum: name: ErrorCategory modelAsString: true values: - name: UserError value: usererror description: The error is due to a user issue, such as misconfiguration. - name: ServerError value: servererror description: The error is due to an internal server issue. Assignment: type: object description: Assignment Properties properties: status: $ref: '#/definitions/AssignmentStatus' description: Indicates if the assignment is in a usable state readOnly: true id: $ref: '#/definitions/AssignmentId' description: Resource id for the assigned resource x-ms-mutability: - read - create required: - id InboundEndpointProtocol: type: string description: InboundEndpointProtocol enums enum: - tcp - udp x-ms-enum: name: InboundEndpointProtocol modelAsString: true values: - name: Tcp value: tcp description: Use TCP for the endpoint. - name: Udp value: udp description: Use UDP for the endpoint. ProvisioningState: type: string description: Provisioning state of the resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: The resource is being provisioned - name: Updating value: Updating description: The resource is updating - name: Deleting value: Deleting description: The resource is being deleted - name: Accepted value: Accepted description: The resource create request has been accepted PoolUpdateProperties: type: object description: The updatable properties of the Pool. properties: resources: $ref: '#/definitions/Resources' description: Resources represent the resources the pool should have. poolType: $ref: '#/definitions/PoolTypeUpdate' description: 'Type of the Pool: ephemeralDisk, azureDisk, or elasticsan.' assignments: type: array description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. items: $ref: '#/definitions/Assignment' AzureDiskUpdate: type: object description: Azure Disk Pool Properties properties: disks: type: array description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). items: $ref: '#/definitions/Disk' BatchNodeEndpointConfiguration: type: object description: The endpoint configuration for the Compute Node. properties: inboundEndpoints: type: array description: The list of inbound endpoints that are accessible on the Compute Node. items: $ref: '#/definitions/InboundEndpoint' x-ms-identifiers: [] required: - inboundEndpoints BatchErrorDetail: type: object description: An item of additional information included in an Azure Batch error response. properties: key: type: string description: An identifier specifying the meaning of the Value property. value: type: string description: The additional information included with the error response. parameters: Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. PoolNameParameter: name: poolName in: path required: true type: string description: Name of the pool. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'