{ "swagger": "2.0", "info": { "title": "BatchService", "version": "2015-12-01.2.2", "description": "A client for issuing REST requests to the Azure Batch service.", "x-ms-code-generation-settings": { "name": "BatchServiceClient" } }, "host": "batch.core.windows.net", "schemes": [ "https" ], "consumes": [ "application/json; odata=minimalmetadata" ], "produces": [ "application/json" ], "paths": { "/applications": { "get": { "tags": [ "Applications" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Application_List", "description": "Lists all of the applications available in the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/ApplicationListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/applications/{applicationId}": { "get": { "tags": [ "Applications" ], "operationId": "Application_Get", "description": "Gets information about the specified application.", "x-ms-request-id": "request-id", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The id of the application." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/ApplicationSummary" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/poolusagemetrics": { "get": { "tags": [ "Pools" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Pool_ListPoolUsageMetrics", "description": "Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.", "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.", "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.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/PoolListPoolUsageMetricsResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/lifetimepoolstats": { "get": { "tags": [ "Pools" ], "operationId": "Pool_GetAllPoolsLifetimeStatistics", "description": "Gets lifetime summary statistics for all of the pools in the specified account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.", "x-ms-request-id": "request-id", "parameters": [ { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/PoolStatistics" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/lifetimejobstats": { "get": { "tags": [ "Jobs" ], "operationId": "Job_GetAllJobsLifetimeStatistics", "description": "Gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.", "x-ms-request-id": "request-id", "parameters": [ { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/JobStatistics" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/certificates": { "post": { "tags": [ "Certificates" ], "operationId": "Certificate_Add", "description": "Adds a certificate to the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "Certificate", "in": "body", "description": "Specifies the certificate to be added.", "required": true, "schema": { "$ref": "#/definitions/CertificateAddParameter" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "Initial response" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Certificates" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Certificate_List", "description": "Lists all of the certificates that have been added to the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "Gets the list of certificates.", "schema": { "$ref": "#/definitions/CertificateListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete": { "post": { "tags": [ "Certificates" ], "operationId": "Certificate_CancelDeletion", "description": "Cancels a failed deletion of a certificate from the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "thumbprintAlgorithm", "in": "path", "required": true, "type": "string", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "in": "path", "required": true, "type": "string", "description": "The thumbprint of the certificate being deleted." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "204": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})": { "delete": { "tags": [ "Certificates" ], "operationId": "Certificate_Delete", "description": "Deletes a certificate from the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "thumbprintAlgorithm", "in": "path", "required": true, "type": "string", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "in": "path", "required": true, "type": "string", "description": "The thumbprint of the certificate to be deleted." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Certificates" ], "operationId": "Certificate_Get", "description": "Gets information about the specified certificate.", "x-ms-request-id": "request-id", "parameters": [ { "name": "thumbprintAlgorithm", "in": "path", "required": true, "type": "string", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "in": "path", "required": true, "type": "string", "description": "The thumbprint of the certificate to get." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/Certificate" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks/{taskId}/files/{fileName}": { "delete": { "tags": [ "Files" ], "operationId": "File_DeleteFromTask", "description": "Deletes the specified task file from the compute node where the task ran.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job that contains the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task whose file you want to delete." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the task file that you want to delete." }, { "name": "recursive", "in": "query", "required": false, "type": "boolean", "description": "Sets whether to delete children of a directory. If the fileName parameter represents a directory instead of a file, you can set Recursive to true to delete the directory and all of the files and subdirectories in it. If Recursive is false then the directory must be empty or deletion will fail." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Files" ], "operationId": "File_GetFromTask", "description": "Gets the content of the specified task file.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job that contains the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task whose file you want to retrieve." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the task file that you want to get the content of." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "ocp-range", "in": "header", "required": false, "type": "string", "description": "Specifies the byte range to be retrieved. The default is to retrieve the entire file. The format is startRange-endRange.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "ocp-creation-time": { "description": "Gets the file creation time.", "type": "string", "format": "date-time-rfc1123" }, "ocp-batch-file-isdirectory": { "description": "Gets whether the object represents a directory.", "type": "boolean" }, "ocp-batch-file-url": { "description": "Gets the URL of the file.", "type": "string" }, "Content-Type": { "description": "Gets the content type of the file.", "type": "string" }, "Content-Length": { "description": "Gets the length of the file.", "type": "integer", "format": "int64" } }, "description": "", "schema": { "type": "file" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "head": { "tags": [ "Files" ], "operationId": "File_GetNodeFilePropertiesFromTask", "description": "Gets the properties of the specified task file.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job that contains the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task whose file you want to get the properties of." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the task file that you want to get the properties of." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "ocp-creation-time": { "description": "Gets the file creation time.", "type": "string", "format": "date-time-rfc1123" }, "ocp-batch-file-isdirectory": { "description": "Gets whether the object represents a directory.", "type": "boolean" }, "ocp-batch-file-url": { "description": "Gets the URL of the file.", "type": "string" }, "Content-Type": { "description": "Gets the content type of the file.", "type": "string" }, "Content-Length": { "description": "Gets the length of the file.", "type": "integer", "format": "int64" } }, "description": "Found the file" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/files/{fileName}": { "delete": { "tags": [ "Files" ], "operationId": "File_DeleteFromComputeNode", "description": "Deletes the specified task file from the compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node from which you want to delete the file." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the file that you want to delete." }, { "name": "recursive", "in": "query", "required": false, "type": "boolean", "description": "Sets whether to delete children of a directory. If the fileName parameter represents a directory instead of a file, you can set Recursive to true to delete the directory and all of the files and subdirectories in it. If Recursive is false then the directory must be empty or deletion will fail." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Files" ], "operationId": "File_GetFromComputeNode", "description": "Gets the content of the specified task file.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that contains the file." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the task file that you want to get the content of." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "ocp-range", "in": "header", "required": false, "type": "string", "description": "Specifies the byte range to be retrieved. The default is to retrieve the entire file. The format is startRange-endRange.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "ocp-creation-time": { "description": "Gets the file creation time.", "type": "string", "format": "date-time-rfc1123" }, "ocp-batch-file-isdirectory": { "description": "Gets whether the object represents a directory.", "type": "boolean" }, "ocp-batch-file-url": { "description": "Gets the URL of the file.", "type": "string" }, "Content-Type": { "description": "Gets the content type of the file.", "type": "string" }, "Content-Length": { "description": "Gets the length of the file.", "type": "integer", "format": "int64" } }, "description": "", "schema": { "type": "file" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "head": { "tags": [ "Files" ], "operationId": "File_GetNodeFilePropertiesFromComputeNode", "description": "Gets the properties of the specified compute node file.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that contains the file." }, { "name": "fileName", "in": "path", "required": true, "type": "string", "description": "The path to the compute node file that you want to get the properties of." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "ocp-creation-time": { "description": "Gets the file creation time.", "type": "string", "format": "date-time-rfc1123" }, "ocp-batch-file-isdirectory": { "description": "Gets whether the object represents a directory.", "type": "boolean" }, "ocp-batch-file-url": { "description": "Gets the URL of the file.", "type": "string" }, "Content-Type": { "description": "Gets the content type of the file.", "type": "string" }, "Content-Length": { "description": "Gets the length of the file.", "type": "integer", "format": "int64" } }, "description": "Found the file" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks/{taskId}/files": { "get": { "tags": [ "Files" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "File_ListFromTask", "description": "Lists the files in a task's directory on its compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job that contains the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task whose files you want to list." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "recursive", "in": "query", "required": false, "type": "boolean", "description": "Sets whether to list children of a directory." }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/NodeFileListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/files": { "get": { "tags": [ "Files" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "File_ListFromComputeNode", "description": "Lists all of the files in task directories on the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node whose files you want to list." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "recursive", "in": "query", "required": false, "type": "boolean", "description": "Sets whether to list children of a directory." }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/NodeFileListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules/{jobScheduleId}": { "head": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Exists", "description": "Checks the specified job schedule exists.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule which you want to check." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "Found the jobschedule." }, "404": { "description": "JobSchedules not found" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "delete": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Delete", "description": "Deletes a job schedule from the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to delete." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Get", "description": "Gets information about the specified job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to get." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJobSchedule" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "patch": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Patch", "description": "Updates the properties of the specified job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to update." }, { "name": "jobSchedulePatchParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JobSchedulePatchParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "put": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Update", "description": "Updates the properties of the specified job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to update." }, { "name": "jobScheduleUpdateParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JobScheduleUpdateParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules/{jobScheduleId}/disable": { "post": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Disable", "description": "Disables a job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to disable." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "204": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules/{jobScheduleId}/enable": { "post": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Enable", "description": "Enables a job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to enable." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "204": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules/{jobScheduleId}/terminate": { "post": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Terminate", "description": "Terminates a job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule to terminates." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules": { "post": { "tags": [ "JobSchedules" ], "operationId": "JobSchedule_Add", "description": "Adds a job schedule to the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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": "CloudJobSchedule", "in": "body", "description": "Specifies the job schedule to be added.", "required": true, "schema": { "$ref": "#/definitions/JobScheduleAddParameter" } }, { "name": "client-request-id", "in": "header", "required": false, "type": "string", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "JobSchedules" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "JobSchedule_List", "description": "Lists all of the job schedules in the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJobScheduleListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}": { "delete": { "tags": [ "Jobs" ], "operationId": "Job_Delete", "description": "Deletes a job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job to delete." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Jobs" ], "operationId": "Job_Get", "description": "Gets information about the specified job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJob" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "patch": { "tags": [ "Jobs" ], "operationId": "Job_Patch", "description": "Updates the properties of a job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job whose properties you want to update." }, { "name": "jobPatchParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JobPatchParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "put": { "tags": [ "Jobs" ], "operationId": "Job_Update", "description": "Updates the properties of a job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job whose properties you want to update." }, { "name": "jobUpdateParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JobUpdateParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/disable": { "post": { "tags": [ "Jobs" ], "operationId": "Job_Disable", "description": "Disables the specified job, preventing new tasks from running.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job to disable." }, { "name": "jobDisableParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JobDisableParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/enable": { "post": { "tags": [ "Jobs" ], "operationId": "Job_Enable", "description": "Enables the specified job, allowing new tasks to run.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job to enable." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/terminate": { "post": { "tags": [ "Jobs" ], "operationId": "Job_Terminate", "description": "Terminates the specified job, marking it as completed.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job to terminate." }, { "name": "jobTerminateParameter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/JobTerminateParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs": { "post": { "tags": [ "Jobs" ], "operationId": "Job_Add", "description": "Adds a job to the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "Job", "in": "body", "description": "Specifies the job to be added.", "required": true, "schema": { "$ref": "#/definitions/JobAddParameter" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Jobs" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Job_List", "description": "Lists all of the jobs in the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJobListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobschedules/{jobScheduleId}/jobs": { "get": { "tags": [ "Jobs" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Job_ListFromJobSchedule", "description": "Lists the jobs that have been created under the specified job schedule.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobScheduleId", "in": "path", "required": true, "type": "string", "description": "The id of the job schedule from which you want to get a list of jobs." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJobListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { "get": { "tags": [ "Jobs" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Job_ListPreparationAndReleaseTaskStatus", "description": "Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudJobListPreparationAndReleaseTaskStatusResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools": { "post": { "tags": [ "Pools" ], "operationId": "Pool_Add", "description": "Adds a pool to the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "Pool", "in": "body", "description": "Specifies the pool to be added.", "required": true, "schema": { "$ref": "#/definitions/PoolAddParameter" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Pools" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Pool_List", "description": "Lists all of the pools in the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudPoolListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}": { "delete": { "tags": [ "Pools" ], "operationId": "Pool_Delete", "description": "Deletes a pool from the specified account.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to delete." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "head": { "tags": [ "Pools" ], "operationId": "Pool_Exists", "description": "Gets basic properties of a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to get." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "" }, "404": { "description": "Pool not found" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Pools" ], "operationId": "Pool_Get", "description": "Gets information about the specified pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to get." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudPool" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "patch": { "tags": [ "Pools" ], "operationId": "Pool_Patch", "description": "Updates the properties of a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to update." }, { "name": "poolPatchParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolPatchParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/disableautoscale": { "post": { "tags": [ "Pools" ], "operationId": "Pool_DisableAutoScale", "description": "Disables automatic scaling for a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool on which to disable automatic scaling." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/enableautoscale": { "post": { "tags": [ "Pools" ], "operationId": "Pool_EnableAutoScale", "description": "Enables automatic scaling for a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool on which to enable automatic scaling." }, { "name": "poolEnableAutoScaleParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolEnableAutoScaleParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/evaluateautoscale": { "post": { "tags": [ "Pools" ], "operationId": "Pool_EvaluateAutoScale", "description": "Gets the result of evaluating an automatic scaling formula on the pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool on which to evaluate the automatic scaling formula." }, { "name": "poolEvaluateAutoScaleParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolEvaluateAutoScaleParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "", "schema": { "$ref": "#/definitions/AutoScaleRun" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/resize": { "post": { "tags": [ "Pools" ], "operationId": "Pool_Resize", "description": "Changes the number of compute nodes that are assigned to a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to resize." }, { "name": "poolResizeParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolResizeParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/stopresize": { "post": { "tags": [ "Pools" ], "operationId": "Pool_StopResize", "description": "Stops an ongoing resize operation on the pool. 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.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool whose resizing you want to stop." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/updateproperties": { "post": { "tags": [ "Pools" ], "operationId": "Pool_UpdateProperties", "description": "Updates the properties of a pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to update." }, { "name": "poolUpdatePropertiesParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolUpdatePropertiesParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "204": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/upgradeos": { "post": { "tags": [ "Pools" ], "operationId": "Pool_UpgradeOS", "description": "Upgrades the operating system of the specified pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool to upgrade." }, { "name": "poolUpgradeOSParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PoolUpgradeOSParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/removenodes": { "post": { "tags": [ "ComputeNodes" ], "operationId": "Pool_RemoveNodes", "description": "Removes compute nodes from the specified pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool from which you want to remove nodes." }, { "name": "nodeRemoveParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NodeRemoveParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks": { "post": { "tags": [ "Tasks" ], "operationId": "Task_Add", "description": "Adds a task to the specified job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job to which the task is to be added." }, { "name": "task", "in": "body", "description": "Specifies the task to be added.", "required": true, "schema": { "$ref": "#/definitions/TaskAddParameter" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Tasks" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "Task_List", "description": "Lists all of the tasks that are associated with the specified job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudTaskListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks/{taskId}": { "delete": { "tags": [ "Tasks" ], "operationId": "Task_Delete", "description": "Deletes a task from the specified job.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job from which to delete the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task to delete." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "get": { "tags": [ "Tasks" ], "operationId": "Task_Get", "description": "Gets information about the specified task.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job that contains the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task to get information about." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Sets an OData $expand clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "", "schema": { "$ref": "#/definitions/CloudTask" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "put": { "tags": [ "Tasks" ], "operationId": "Task_Update", "description": "Updates the properties of the specified task.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job containing the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task to update." }, { "name": "taskUpdateParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskUpdateParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { "get": { "tags": [ "Tasks" ], "operationId": "Task_ListSubtasks", "description": "Lists all of the subtasks that are associated with the specified multi-instance task.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/CloudTaskListSubtasksResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/jobs/{jobId}/tasks/{taskId}/terminate": { "post": { "tags": [ "Tasks" ], "operationId": "Task_Terminate", "description": "Terminates the specified task.", "x-ms-request-id": "request-id", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The id of the job containing the task." }, { "name": "taskId", "in": "path", "required": true, "type": "string", "description": "The id of the task to terminate." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Modified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "If-Unmodified-Since", "in": "header", "required": false, "type": "string", "format": "date-time-rfc1123", "description": "Specify this header to perform the operation only if the resource has not been modified since the specified date/time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "204": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/users": { "post": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_AddUser", "description": "Adds a user account to the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the machine on which you want to create a user account." }, { "name": "User", "in": "body", "description": "Specifies the user account to be created.", "required": true, "schema": { "$ref": "#/definitions/ComputeNodeUser" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "201": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { "delete": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_DeleteUser", "description": "Deletes a user account from the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the machine on which you want to delete a user account." }, { "name": "userName", "in": "path", "required": true, "type": "string", "description": "The name of the user account to delete." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } }, "put": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_UpdateUser", "description": "Updates the password or expiration time of a user account on the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the machine on which you want to update a user account." }, { "name": "userName", "in": "path", "required": true, "type": "string", "description": "The name of the user account to update." }, { "name": "nodeUpdateUserParameter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NodeUpdateUserParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}": { "get": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_Get", "description": "Gets information about the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that you want to get information about." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/ComputeNode" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/reboot": { "post": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_Reboot", "description": "Restarts the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that you want to restart." }, { "name": "nodeRebootParameter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/NodeRebootParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/reimage": { "post": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_Reimage", "description": "Reinstalls the operating system on the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that you want to restart." }, { "name": "nodeReimageParameter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/NodeReimageParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "202": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { "post": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_DisableScheduling", "description": "Disable task scheduling of the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that you want to disable task scheduling." }, { "name": "nodeDisableSchedulingParameter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/NodeDisableSchedulingParameter" }, "description": "The parameters for the request." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { "post": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_EnableScheduling", "description": "Enable task scheduling of the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node that you want to enable task scheduling." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" }, "DataServiceId": { "description": "Gets the OData id of the resource to which the request applied.", "type": "string" } }, "description": "" }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes/{nodeId}/rdp": { "get": { "tags": [ "ComputeNodes" ], "operationId": "ComputeNode_GetRemoteDesktop", "description": "Gets the Remote Desktop Protocol file for the specified compute node.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool that contains the compute node." }, { "name": "nodeId", "in": "path", "required": true, "type": "string", "description": "The id of the compute node for which you want to get the Remote Desktop Protocol file." }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "type": "file" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } }, "/pools/{poolId}/nodes": { "get": { "tags": [ "ComputeNodes" ], "x-ms-pageable": { "nextLinkName": "odata.nextLink" }, "operationId": "ComputeNode_List", "description": "Lists the compute nodes in the specified pool.", "x-ms-request-id": "request-id", "parameters": [ { "name": "poolId", "in": "path", "required": true, "type": "string", "description": "The id of the pool from which you want to list nodes." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "Sets an OData $filter clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "Sets an OData $select clause.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "maxresults", "x-ms-client-name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Sets the maximum number of items to return in the response.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30, "description": "Sets 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", "description": "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", "in": "header", "required": false, "type": "boolean", "description": "Specifies if the server should return the client-request-id identifier 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. If not specified, this header will be automatically populated with the current system clock time.", "x-ms-parameter-grouping": { "postfix": "Options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "headers": { "client-request-id": { "description": "Gets the ClientRequestId provided by the client during the request, if present and requested to be returned.", "type": "string" }, "request-id": { "description": "Gets the value that uniquely identifies a request.", "type": "string" }, "ETag": { "description": "Gets the content of the ETag HTTP response header.", "type": "string" }, "Last-Modified": { "description": "Gets the content of the Last-Modified HTTP response header.", "type": "string", "format": "date-time-rfc1123" } }, "description": "", "schema": { "$ref": "#/definitions/ComputeNodeListResult" } }, "default": { "description": "Error from the Batch service", "schema": { "$ref": "#/definitions/BatchError" } } } } } }, "definitions": { "PoolUsageMetrics": { "properties": { "poolId": { "type": "string", "description": "Gets or sets the id of the pool whose metrics are being aggregated." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the aggregation interval." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the aggregation interval." }, "vmSize": { "type": "string", "description": "Gets or sets the size of virtual machines in the pool. All VMs in a pool are the same size." }, "totalCoreHours": { "type": "number", "format": "double", "description": "Gets or sets the total core hours used in the pool during this aggregation interval." }, "dataIngressGiB": { "type": "number", "format": "double", "description": "Gets or sets the cross data center network ingress in GiB to the pool during this interval." }, "dataEgressGiB": { "type": "number", "format": "double", "description": "Gets or sets the cross data center network egress in GiB from the pool during this interval." } }, "required": [ "poolId", "startTime", "endTime", "vmSize", "totalCoreHours", "dataIngressGiB", "dataEgressGiB" ], "description": "Usage metrics for a pool across an aggregation interval." }, "PoolListPoolUsageMetricsResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PoolUsageMetrics" }, "description": "Gets or sets the pool usage metrics data." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to an AccountOperations.ListPoolUsageMetrics request." }, "UsageStatistics": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets 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": "Gets or sets the aggregated wall-clock time of the dedicated compute node cores being part of the pool." } }, "required": [ "startTime", "lastUpdateTime", "dedicatedCoreTime" ], "description": "Statistics related to pool usage information." }, "ResourceStatistics": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets 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", "description": "Gets or sets the average CPU usage across all nodes in the pool (percentage per node)." }, "avgMemoryGiB": { "type": "number", "format": "double", "description": "Gets or sets the average memory usage in GiB across all nodes in the pool." }, "peakMemoryGiB": { "type": "number", "format": "double", "description": "Gets or sets the peak memory usage in GiB across all nodes in the pool." }, "avgDiskGiB": { "type": "number", "format": "double", "description": "Gets or sets the average used disk space in GiB across all nodes in the pool." }, "peakDiskGiB": { "type": "number", "format": "double", "description": "Gets or sets the peak used disk space in GiB across all nodes in the pool." }, "diskReadIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of disk read operations across all nodes in the pool." }, "diskWriteIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of disk write operations across all nodes in the pool." }, "diskReadGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of disk reads across all nodes in the pool." }, "diskWriteGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of disk writes across all nodes in the pool." }, "networkReadGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of network reads across all nodes in the pool." }, "networkWriteGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of network writes across all nodes in the pool." } }, "required": [ "startTime", "lastUpdateTime", "avgCPUPercentage", "avgMemoryGiB", "peakMemoryGiB", "avgDiskGiB", "peakDiskGiB", "diskReadIOps", "diskWriteIOps", "diskReadGiB", "diskWriteGiB", "networkReadGiB", "networkWriteGiB" ], "description": "Statistics related to resource consumption by compute nodes in a pool." }, "PoolStatistics": { "properties": { "url": { "type": "string", "description": "Gets or sets the URL for the statistics." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." }, "usageStats": { "$ref": "#/definitions/UsageStatistics", "description": "Gets or sets statistics related to pool usage information, such as the amount of core-time used." }, "resourceStats": { "$ref": "#/definitions/ResourceStatistics", "description": "Gets or sets statistics related to resource consumption by compute nodes in the pool." } }, "required": [ "url", "startTime", "lastUpdateTime" ], "description": "Contains utilization and resource usage statistics for the lifetime of a pool." }, "JobStatistics": { "properties": { "url": { "type": "string", "description": "Gets or sets the URL for the statistics." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the statistics were last updated. All statistics are limited to the range between StartTime and LastUpdateTime." }, "userCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total user mode CPU time (summed across all cores and all compute nodes) consumed by all the tasks in the job." }, "kernelCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all the tasks in the job." }, "wallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the total wall clock time of all the tasks in the job." }, "readIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O read operations performed by all the tasks in the job." }, "writeIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O write operations performed by all the tasks in the job." }, "readIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O read by all the tasks in the job." }, "writeIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O written by all the tasks in the job." }, "numSucceededTasks": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of tasks successfully completed in the job during the given time range." }, "numFailedTasks": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of tasks in the job that failed during the given time range." }, "numTaskRetries": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of retries on all the tasks in the job during the given time range." }, "waitTime": { "type": "string", "format": "duration", "description": "Gets or sets the total wait time of all the tasks in the job. The wait time for a task is defined as the elapsed time between the creation of the task creation and the start of task execution. This value is reported only in the account lifetime statistics; it is not included in individual job statistics." } }, "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "numSucceededTasks", "numFailedTasks", "numTaskRetries", "waitTime" ], "description": "Resource usage statistics for a job." }, "NameValuePair": { "properties": { "name": { "type": "string", "description": "Gets or sets the name in the name-value pair." }, "value": { "type": "string", "description": "Gets or sets the value in the name-value pair." } }, "description": "Represents a name-value pair." }, "DeleteCertificateError": { "properties": { "code": { "type": "string", "description": "Gets or sets an identifier for the certificate deletion error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the certificate deletion error, intended to be suitable for display in a user interface." }, "values": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets a list of additional error details related to the certificate deletion error." } }, "description": "An error encountered by the Batch service when deleting a certificate." }, "Certificate": { "properties": { "thumbprint": { "type": "string", "description": "Get or sets the X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed)." }, "thumbprintAlgorithm": { "type": "string", "description": "Gets or sets the algorithm used to derive the thumbprint. This must be sha1." }, "url": { "type": "string", "description": "Gets or sets the URL of the certificate." }, "state": { "type": "string", "description": "Gets or sets the current state of the certificate.", "enum": [ "active", "deleting", "deletefailed" ], "x-ms-enum": { "name": "CertificateState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the certificate entered its current state." }, "previousState": { "type": "string", "description": "Gets or sets the previous state of the certificate. This property is not set if the certificate is in its initial Active state.", "enum": [ "active", "deleting", "deletefailed" ], "x-ms-enum": { "name": "CertificateState", "modelAsString": false } }, "previousStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the certificate entered its previous state. This property is not set if the certificate is in its initial Active state." }, "publicData": { "type": "string", "description": "Gets or sets the public part of the certificate as a base-64 encoded .cer file." }, "deleteCertificateError": { "$ref": "#/definitions/DeleteCertificateError", "description": "Gets or sets the error that occurred on the last attempt to delete this certificate. This property is set only if the certificate is in the deletefailed state." } }, "description": "A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine." }, "ApplicationPackageReference": { "properties": { "applicationId": { "type": "string", "description": "Gets or sets the application package id." }, "version": { "type": "string", "description": "Gets or sets the application package version. If not specified, the default is used." } }, "required": [ "applicationId" ], "description": "A reference to an application package to be installed on compute nodes in a pool." }, "ApplicationSummary": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the application within the account." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the application." }, "versions": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "displayName", "versions" ], "description": "Contains information about an application in an Azure Batch account." }, "CertificateAddParameter": { "properties": { "thumbprint": { "type": "string", "description": "Get or sets the X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed)." }, "thumbprintAlgorithm": { "type": "string", "description": "Gets or sets the algorithm used to derive the thumbprint. This must be sha1." }, "data": { "type": "string", "description": "Gets or sets the base64-encoded contents of the .pfx file containing the certificate. The maximum size is 10KB. This property is not populated by the Get Certificate operation." }, "certificateFormat": { "type": "string", "description": "Gets or sets the format of the certificate data. This must be pfx.", "enum": [ "pfx", "cer", "unmapped" ], "x-ms-enum": { "name": "CertificateFormat", "modelAsString": false } }, "password": { "type": "string", "description": "Gets or sets the password to access the certificate's private key. This property is not populated by the Get Certificate operation." } }, "required": [ "thumbprint", "thumbprintAlgorithm", "data" ], "description": "A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine." }, "CertificateListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Certificate" }, "description": "Gets or sets the list of certificates." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CertificateOperations.List request." }, "FileProperties": { "properties": { "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the file creation time." }, "lastModified": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the file was last modified." }, "contentLength": { "type": "integer", "format": "int64", "description": "Gets or sets the length of the file." }, "contentType": { "type": "string", "description": "Gets or sets the content type of the file." } }, "required": [ "lastModified", "contentLength" ], "description": "The properties of a file on a compute node." }, "NodeFile": { "properties": { "name": { "type": "string", "description": "Gets or sets the file path." }, "url": { "type": "string", "description": "Gets or sets the URL of the file." }, "isDirectory": { "type": "boolean", "description": "Gets or sets whether the object represents a directory." }, "properties": { "$ref": "#/definitions/FileProperties", "description": "Gets or sets the file properties." } }, "description": "Information about a file or directory on a compute node." }, "NodeFileListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NodeFile" }, "description": "Gets or sets the list of files." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a NodeFileOperations.ListFromComputeNode or NodeFileOperations.ListFromTask request." }, "Schedule": { "properties": { "doNotRunUntil": { "type": "string", "format": "date-time", "description": "Gets or sets the earliest time at which any job may be created under this job schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately." }, "doNotRunAfter": { "type": "string", "format": "date-time", "description": "Gets or sets a time after which no job will be created under this job schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active job under this job schedule." }, "startWindow": { "type": "string", "format": "duration", "description": "Gets or sets the time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created. If a job is not created within the startWindow interval, then the 'opportunity' is lost; no job will be created until the next recurrence of the schedule." }, "recurrenceInterval": { "type": "string", "format": "duration", "description": "Gets or sets the time interval between the start times of two successive jobs under the job schedule. A job schedule can have at most one active job under it at any given time." } }, "description": "The schedule according to which jobs will be created" }, "JobConstraints": { "properties": { "maxWallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the maximum elapsed time that the job may run, measured from the time the job starts. If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running." }, "maxTaskRetryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero." } }, "description": "Specifies the execution constraints for jobs created on a schedule." }, "ResourceFile": { "properties": { "blobSource": { "type": "string", "description": "Gets or sets the URL of a blob in Azure storage. The Batch service downloads the blob to the specified file path. The URL must be readable using anonymous access." }, "filePath": { "type": "string", "description": "Gets or sets the location on the compute node to which the file should be downloaded." } }, "description": "A file to be downloaded from Azure blob storage to a compute node." }, "EnvironmentSetting": { "properties": { "name": { "type": "string", "description": "Gets or sets the name of the environment variable." }, "value": { "type": "string", "description": "Gets or sets the value of the environment variable." } }, "description": "An environment variable to be set on a task process." }, "TaskConstraints": { "properties": { "maxWallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it." }, "retentionTime": { "type": "string", "format": "duration", "description": "Gets or sets the minimum time to retain the working directory for the task on the compute node where it ran. After this time, the Batch service may delete the working directory and all its contents. The default is infinite." }, "maxTaskRetryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero." } }, "description": "Constraints to apply to the Job Manager task." }, "JobManagerTask": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the Job Manager task. A GUID is recommended." }, "displayName": { "type": "string", "description": "Gets or sets the display name of the Job Manager task." }, "commandLine": { "type": "string", "description": "Gets or sets the command line of the Job Manager task." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the Job Manager task." }, "constraints": { "$ref": "#/definitions/TaskConstraints", "description": "Gets or sets constraints that apply to the Job Manager task." }, "killJobOnCompletion": { "type": "boolean", "description": "Gets or sets whether completion of the Job Manager task signifies completion of the entire job." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the Job Manager task in elevated mode. The default value is false." }, "runExclusive": { "type": "boolean", "description": "Gets or sets whether the Job Manager task requires exclusive use of the compute node where it runs." } }, "description": "Specifies details of a Job Manager task." }, "JobPreparationTask": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the job preparation task within the job. The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." }, "commandLine": { "type": "string", "description": "Gets or sets the command line of the Job Preparation task." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the Job Preparation task." }, "constraints": { "$ref": "#/definitions/TaskConstraints", "description": "Gets or sets constraints that apply to the Job Preparation task.." }, "waitForSuccess": { "type": "boolean", "description": "Gets or sets whether the Batch Service should wait for the Job Preparation task to complete successfully before scheduling any other tasks of the job on the compute node." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the Job Preparation task in elevated mode. The default value is false." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", "description": "Gets or sets whether the Batch service should rerun the Job Preparation task after a compute node reboots. The default value is true." } }, "description": "A Job Preparation task to run before any tasks of the job on any given compute node." }, "JobReleaseTask": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the Job Release task within the job. The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." }, "commandLine": { "type": "string", "description": "Gets or sets the command line of the Job Release task." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the Job Release task." }, "maxWallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the maximum elapsed time that the Job Release task may run on a given compute node, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes." }, "retentionTime": { "type": "string", "format": "duration", "description": "Gets or sets the minimum time to retain the working directory for the Job Release task on the compute node. After this time, the Batch service may delete the working directory and all its contents. The default is infinite." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the Job Release task in elevated mode. The default value is false." } }, "description": "A Job Release task to run on job completion on any compute node where the job has run." }, "TaskSchedulingPolicy": { "properties": { "nodeFillType": { "type": "string", "description": "Gets or sets how tasks should be distributed across compute nodes", "enum": [ "spread", "pack", "unmapped" ], "x-ms-enum": { "name": "ComputeNodeFillType", "modelAsString": false } } }, "required": [ "nodeFillType" ], "description": "Specifies how tasks should be distributed across compute nodes." }, "StartTask": { "properties": { "commandLine": { "type": "string", "description": "Gets or sets the command line of the start task." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the start task." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the start task in elevated mode. The default value is false." }, "maxTaskRetryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of times the task may be retried." }, "waitForSuccess": { "type": "boolean", "description": "Gets or sets whether the Batch Service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node." } }, "description": "A task defined on a pool and run by compute nodes when they join the pool." }, "CertificateReference": { "properties": { "thumbprint": { "type": "string", "description": "Gets or sets the thumbprint of the certificate." }, "thumbprintAlgorithm": { "type": "string", "description": "Gets or sets the algorithm with which the thumbprint is associated. This must be sha1." }, "storeLocation": { "type": "string", "description": "Gets or sets the location of the certificate store on the compute node into which to install the certificate. The default value is CurrentUser.", "enum": [ "currentuser", "localmachine", "unmapped" ], "x-ms-enum": { "name": "CertificateStoreLocation", "modelAsString": false } }, "storeName": { "type": "string", "description": "Gets or sets the name of the certificate store on the compute node into which to install the certificate. The default value is My." }, "visibility": { "type": "string", "description": "Gets or sets which user accounts on the compute node should have access to the private data of the certificate. This may be any subset of the values 'starttask', 'task' and 'rdp', separated by commas. The default is all accounts, corresponding to the string 'starttask,task,rdp'." } }, "required": [ "thumbprint", "thumbprintAlgorithm" ], "description": "A reference to a certificate to be installed on compute nodes in a pool." }, "MetadataItem": { "properties": { "name": { "type": "string", "description": "Gets or sets the name of the metadata item." }, "value": { "type": "string", "description": "Gets or sets the value of the metadata item." } }, "description": "A metadata item associated with an Azure Batch resource. The Batch service does not assign any meaning to metadata; it is solely for the use of user code." }, "PoolSpecification": { "properties": { "displayName": { "type": "string", "description": "Gets or sets the display name for the pool." }, "vmSize": { "type": "string", "description": "Gets or sets the size of the virtual machines in the pool. All VMs in a pool are the same size." }, "osFamily": { "type": "string", "description": "Gets or sets the Azure Guest OS family to be installed on the virtual machines in the pool." }, "targetOSVersion": { "type": "string", "description": "Gets or sets the Azure Guest OS version to be installed on the virtual machines in the pool." }, "maxTasksPerNode": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of tasks that can run concurrently on a single compute node in the pool." }, "taskSchedulingPolicy": { "$ref": "#/definitions/TaskSchedulingPolicy", "description": "Gets or sets how tasks are distributed among compute nodes in the pool." }, "resizeTimeout": { "type": "string", "format": "duration", "description": "Gets or sets the timeout for allocation of compute nodes to the pool." }, "targetDedicated": { "type": "integer", "format": "int32", "description": "Gets or sets the desired number of compute nodes in the pool." }, "enableAutoScale": { "type": "boolean", "description": "Gets or sets whether the pool size should automatically adjust over time." }, "autoScaleFormula": { "type": "string", "description": "Gets or sets the formula for the desired number of compute nodes in the pool." }, "autoScaleEvaluationInterval": { "type": "string", "format": "duration", "description": "Gets or sets a time interval for the desired AutoScale evaluation period in the pool." }, "enableInterNodeCommunication": { "type": "boolean", "description": "Gets or sets whether the pool permits direct communication between nodes." }, "startTask": { "$ref": "#/definitions/StartTask", "description": "Gets or sets a task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Gets or sets a list of certificates to be installed on each compute node in the pool." }, "applicationPackageReferences": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackageReference" }, "description": "Gets or sets the list of application packages to be installed on each compute node in the pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the pool as metadata." } }, "description": "Specification for creating a new pool." }, "AutoPoolSpecification": { "properties": { "autoPoolIdPrefix": { "type": "string", "description": "Gets or sets a prefix to be added to the unique identifier when a pool is automatically created. The prefix can be up to 20 characters long." }, "poolLifetimeOption": { "type": "string", "description": "Gets or sets the minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools.", "enum": [ "jobschedule", "job", "unmapped" ], "x-ms-enum": { "name": "PoolLifetimeOption", "modelAsString": false } }, "keepAlive": { "type": "boolean", "description": "Gets or sets whether to keep an auto pool alive after its lifetime expires." }, "pool": { "$ref": "#/definitions/PoolSpecification", "description": "Gets or sets the pool specification for the auto pool." } }, "required": [ "poolLifetimeOption" ], "description": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool, run all the tasks for the job on it, and will delete the pool once the job has completed." }, "PoolInformation": { "properties": { "poolId": { "type": "string", "description": "Gets or sets the id of an existing pool. All the tasks of the job will run on the specified pool. You must specify either PoolId or AutoPoolSpecification, but not both." }, "autoPoolSpecification": { "$ref": "#/definitions/AutoPoolSpecification", "description": "Gets or sets characteristics for a temporary 'auto pool.' The Batch service will create this auto pool and run all the tasks of the job on it, and will delete the pool once the job has completed. You must specify either PoolId or AutoPoolSpecification, but not both." } }, "description": "Specifies how a job should be assigned to a pool." }, "JobSpecification": { "properties": { "priority": { "type": "integer", "format": "int32", "description": "Gets or sets the priority of jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." }, "displayName": { "type": "string", "description": "Gets or sets the display name for jobs created under this schedule. It need not be unique and can contain any Unicode characters up to a maximum length of 1024." }, "usesTaskDependencies": { "type": "boolean", "description": "Gets or sets the flag that determines if this job will use tasks with dependencies." }, "constraints": { "$ref": "#/definitions/JobConstraints", "description": "Gets or sets the execution constraints for jobs created under this schedule." }, "jobManagerTask": { "$ref": "#/definitions/JobManagerTask", "description": "Gets or sets the details of a Job Manager task to be launched when a job is started under this schedule." }, "jobPreparationTask": { "$ref": "#/definitions/JobPreparationTask", "description": "Gets or sets the Job Preparation task for jobs created under this schedule." }, "jobReleaseTask": { "$ref": "#/definitions/JobReleaseTask", "description": "Gets or sets the Job Release task for jobs created under this schedule." }, "commonEnvironmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of common environment variable settings. These environment variables are set for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job Release tasks)." }, "poolInfo": { "$ref": "#/definitions/PoolInformation", "description": "Gets or sets the pool on which the Batch service runs the tasks of jobs created under this schedule." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with each job created under this schedule as metadata." } }, "description": "Specifies details of the jobs to be created on a schedule." }, "RecentJob": { "properties": { "id": { "type": "string", "description": "Gets or sets the id of the job." }, "url": { "type": "string", "description": "Gets or sets the URL of the job." } }, "description": "Information about the most recent job to run under the job schedule." }, "JobScheduleExecutionInformation": { "properties": { "nextRunTime": { "type": "string", "format": "date-time", "description": "Gets or sets the next time at which a job will be created under this schedule." }, "recentJob": { "$ref": "#/definitions/RecentJob", "description": "Gets or sets information about the most recent job under the job schedule." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the schedule ended. This property is set only if the job schedule is in the completed state." } }, "description": "Specifies how tasks should be run in a job associated with a job schedule." }, "JobScheduleStatistics": { "properties": { "url": { "type": "string", "description": "Gets or sets the URL for the statistics." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." }, "userCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total user mode CPU time (summed across all cores and all compute nodes) consumed by all the tasks in all the jobs created under the schedule." }, "kernelCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all the tasks in all the jobs created under the schedule." }, "wallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the total wall clock time of all the tasks in all the jobs created under the schedule." }, "readIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O read operations performed by all the tasks in all the jobs created under the schedule." }, "writeIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O write operations performed by all the tasks in all the jobs created under the schedule." }, "readIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O read by all the tasks in all the jobs created under the schedule." }, "writeIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O written by all the tasks in all the jobs created under the schedule." }, "numSucceededTasks": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of tasks successfully completed during the given time range in jobs created under the schedule. A task completes successfully if it returns exit code 0." }, "numFailedTasks": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of tasks that failed during the given time range in jobs created under the schedule. A task fails if it exhausts its maximum retry count without returning exit code 0." }, "numTaskRetries": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of retries during the given time range on all the tasks in jobs created under the schedule." }, "waitTime": { "type": "string", "format": "duration", "description": "Gets or sets the total wait time of all the tasks in jobs created under the schedule." } }, "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "numSucceededTasks", "numFailedTasks", "numTaskRetries", "waitTime" ], "description": "The lifetime resource usage statistics for a job schedule." }, "CloudJobSchedule": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the schedule within the account. A GUID is recommended." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the schedule." }, "url": { "type": "string", "description": "Gets or sets the URL of the job schedule." }, "eTag": { "type": "string", "description": "Gets or sets the ETag of the job schedule." }, "lastModified": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the job schedule." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the job schedule." }, "state": { "type": "string", "description": "Gets or sets the current state of the job schedule.", "enum": [ "active", "completed", "disabled", "terminating", "deleting" ], "x-ms-enum": { "name": "JobScheduleState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the job schedule entered the current state." }, "previousState": { "type": "string", "description": "Gets or sets the previous state of the job schedule.", "enum": [ "active", "completed", "disabled", "terminating", "deleting" ], "x-ms-enum": { "name": "JobScheduleState", "modelAsString": false } }, "previousStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the job schedule entered its previous state." }, "schedule": { "$ref": "#/definitions/Schedule", "description": "Gets or sets the schedule according to which jobs will be created." }, "jobSpecification": { "$ref": "#/definitions/JobSpecification", "description": "Gets or sets the details of the jobs to be created on this schedule." }, "executionInfo": { "$ref": "#/definitions/JobScheduleExecutionInformation", "description": "Gets or sets information about jobs that have been and will be run under this schedule." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the schedule as metadata." }, "stats": { "$ref": "#/definitions/JobScheduleStatistics", "description": "Gets or sets the lifetime resource usage statistics for the job schedule." } }, "description": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job." }, "JobScheduleAddParameter": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the schedule within the account. A GUID is recommended." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the schedule." }, "schedule": { "$ref": "#/definitions/Schedule", "description": "Gets or sets the schedule according to which jobs will be created." }, "jobSpecification": { "$ref": "#/definitions/JobSpecification", "description": "Gets or sets the details of the jobs to be created on this schedule." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the schedule as metadata." } }, "required": [ "id", "schedule", "jobSpecification" ], "description": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job." }, "CloudJobScheduleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CloudJobSchedule" }, "description": "Gets or sets the list of job schedules." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CloudJobScheduleOperations.List request." }, "JobSchedulingError": { "properties": { "category": { "type": "string", "description": "Gets or sets the category of the job scheduling error.", "enum": [ "usererror", "servererror", "unmapped" ], "x-ms-enum": { "name": "SchedulingErrorCategory", "modelAsString": false } }, "code": { "type": "string", "description": "Gets or sets an identifier for the job scheduling error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the job scheduling error, intended to be suitable for display in a user interface." }, "details": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets a list of additional error details related to the scheduling error." } }, "required": [ "category" ], "description": "An error encountered by the Batch service when scheduling a job." }, "JobExecutionInformation": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the job." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the completion time of the job. This property is set only if the job is in the completed state." }, "poolId": { "type": "string", "description": "Gets or sets the id of the pool to which this job is assigned." }, "schedulingError": { "$ref": "#/definitions/JobSchedulingError", "description": "Gets or sets details of any error encountered by the service in starting the job." }, "terminateReason": { "type": "string", "description": "Gets or sets a string describing the reason the job ended." } }, "required": [ "startTime" ], "description": "Contains information about the execution of a job in the Azure Batch service." }, "CloudJob": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the job within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the job." }, "usesTaskDependencies": { "type": "boolean", "description": "Gets or sets the flag that determines if this job will use tasks with dependencies." }, "url": { "type": "string", "description": "Gets or sets the URL of the job." }, "eTag": { "type": "string", "description": "Gets or sets the ETag of the job." }, "lastModified": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the job." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the job." }, "state": { "type": "string", "description": "Gets or sets the current state of the job.", "enum": [ "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting" ], "x-ms-enum": { "name": "JobState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the job entered its current state." }, "previousState": { "type": "string", "description": "Gets or sets the previous state of the job. This property is not set if the job is in its initial Active state.", "enum": [ "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting" ], "x-ms-enum": { "name": "JobState", "modelAsString": false } }, "previousStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the job entered its previous state. This property is not set if the job is in its initial Active state." }, "priority": { "type": "integer", "format": "int32", "description": "Gets or sets the priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." }, "constraints": { "$ref": "#/definitions/JobConstraints", "description": "Gets or sets the execution constraints for the job." }, "jobManagerTask": { "$ref": "#/definitions/JobManagerTask", "description": "Gets or sets details of a Job Manager task to be launched when the job is started." }, "jobPreparationTask": { "$ref": "#/definitions/JobPreparationTask", "description": "Gets or sets the Job Preparation task." }, "jobReleaseTask": { "$ref": "#/definitions/JobReleaseTask", "description": "Gets or sets the Job Release task." }, "commonEnvironmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets the list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks)." }, "poolInfo": { "$ref": "#/definitions/PoolInformation", "description": "Gets or sets the pool on which the Batch service runs the job’s tasks." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the job as metadata." }, "executionInfo": { "$ref": "#/definitions/JobExecutionInformation", "description": "Gets or sets the execution information for the job." }, "stats": { "$ref": "#/definitions/JobStatistics", "description": "Gets or sets resource usage statistics for the entire lifetime of the job." } }, "description": "An Azure Batch job." }, "JobAddParameter": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the job within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the job." }, "priority": { "type": "integer", "format": "int32", "description": "Gets or sets the priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." }, "constraints": { "$ref": "#/definitions/JobConstraints", "description": "Gets or sets the execution constraints for the job." }, "jobManagerTask": { "$ref": "#/definitions/JobManagerTask", "description": "Gets or sets details of a Job Manager task to be launched when the job is started." }, "jobPreparationTask": { "$ref": "#/definitions/JobPreparationTask", "description": "Gets or sets the Job Preparation task." }, "jobReleaseTask": { "$ref": "#/definitions/JobReleaseTask", "description": "Gets or sets the Job Release task." }, "commonEnvironmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets the list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks)." }, "poolInfo": { "$ref": "#/definitions/PoolInformation", "description": "Gets or sets the pool on which the Batch service runs the job’s tasks." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the job as metadata." }, "usesTaskDependencies": { "type": "boolean", "description": "Gets or sets the flag that determines if this job will use tasks with dependencies." } }, "required": [ "id", "poolInfo" ], "description": "An Azure Batch job to add." }, "CloudJobListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CloudJob" }, "description": "Gets or sets the list of jobs." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CloudJobOperations.List or ListFromJobSchedule request." }, "TaskSchedulingError": { "properties": { "category": { "type": "string", "description": "Gets or sets the category of the task scheduling error.", "enum": [ "usererror", "servererror", "unmapped" ], "x-ms-enum": { "name": "SchedulingErrorCategory", "modelAsString": false } }, "code": { "type": "string", "description": "Gets or sets an identifier for the task scheduling error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the task scheduling error, intended to be suitable for display in a user interface." }, "details": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets the list of additional error details related to the scheduling error." } }, "required": [ "category" ], "description": "Information about an error when scheduling a task." }, "JobPreparationTaskExecutionInformation": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the Job Preparation task started running." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the Job Preparation task completed. This property is set only if the task is in the Completed state." }, "state": { "type": "string", "description": "Gets or sets the current running state of the Job Preparation task on the compute node.", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobPreparationTaskState", "modelAsString": false } }, "taskRootDirectory": { "type": "string", "description": "Gets or sets the root directory of the Job Preparation task on the compute node." }, "taskRootDirectoryUrl": { "type": "string", "description": "Gets or sets the URL to the root directory of the Job Preparation task on the compute node." }, "exitCode": { "type": "integer", "format": "int32", "description": "Gets or sets the exit code of the Job Preparation task. This property is set only if the task is in the Completed state." }, "schedulingError": { "$ref": "#/definitions/TaskSchedulingError", "description": "Gets or sets any error starting the Job Preparation task." }, "retryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the number of times the Job Preparation task has been retried by the Batch service." }, "lastRetryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the most recent time at which a retry of the Job Preparation task started running. This property is set only if the task was retried (i.e. retryCount is nonzero)." } }, "required": [ "startTime", "retryCount", "state" ], "description": "Contains information about the execution of a Job Preparation task on a compute node." }, "JobReleaseTaskExecutionInformation": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the Job Release task started running." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the Job Release task completed. This property is set only if the task is in the Completed state." }, "state": { "type": "string", "description": "Gets or sets the current running state of the Job Release task on the compute node.", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobReleaseTaskState", "modelAsString": false } }, "taskRootDirectory": { "type": "string", "description": "Gets or sets the root directory of the Job Release task on the compute node." }, "taskRootDirectoryUrl": { "type": "string", "description": "Gets or sets the URL to the root directory of the Job Release task on the compute node." }, "exitCode": { "type": "integer", "format": "int32", "description": "Gets or sets the exit code of the Job Release task. This property is set only if the task is in the Completed state." }, "schedulingError": { "$ref": "#/definitions/TaskSchedulingError", "description": "Gets or sets any error starting the Job Release task." } }, "required": [ "startTime", "state" ], "description": "Contains information about the execution of a Job Release task on a compute node." }, "JobPreparationAndReleaseTaskExecutionInformation": { "properties": { "poolId": { "type": "string", "description": "Gets or sets the id of the pool containing the compute node to which this entry refers." }, "nodeId": { "type": "string", "description": "Gets or sets the id of the compute node to which this entry refers." }, "nodeUrl": { "type": "string", "description": "Gets or sets the URL of the compute node to which this entry refers." }, "jobPreparationTaskExecutionInfo": { "$ref": "#/definitions/JobPreparationTaskExecutionInformation", "description": "Gets or sets information about the execution status of the Job Preparation task on this compute node." }, "jobReleaseTaskExecutionInfo": { "$ref": "#/definitions/JobReleaseTaskExecutionInformation", "description": "Gets or sets information about the execution status of the Job Release task on this compute node. This property is set only if the Job Release task has run on the node." } }, "description": "The status of the Job Preparation and Job Release tasks on a particular compute node." }, "CloudJobListPreparationAndReleaseTaskStatusResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/JobPreparationAndReleaseTaskExecutionInformation" }, "description": "Gets or sets a list of Job Preparation and Job Release task execution information." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CloudJobOperations.ListPreparationAndReleaseTaskStatus request." }, "AutoScaleRunError": { "properties": { "code": { "type": "string", "description": "Gets or sets an identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the autoscale error, intended to be suitable for display in a user interface." }, "values": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets a list of additional error details related to the autoscale error." } }, "description": "An error that occurred when executing or evaluating a pool autoscale formula." }, "AutoScaleRun": { "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the autoscale formula was last evaluated." }, "results": { "type": "string", "description": "Gets or sets 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": "Gets or sets details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful." } }, "required": [ "timestamp" ], "description": "The results and errors from an execution of a pool autoscale formula." }, "ResizeError": { "properties": { "code": { "type": "string", "description": "Gets or sets an identifier for the pool resize error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the pool resize error, intended to be suitable for display in a user interface." }, "values": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets a list of additional error details related to the pool resize error." } }, "description": "An error that occurred when resizing a pool." }, "CloudPool": { "properties": { "id": { "type": "string", "description": "Gets or sets 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." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the pool." }, "url": { "type": "string", "description": "Gets or sets the URL of the pool." }, "eTag": { "type": "string", "description": "Gets or sets the ETag of the pool." }, "lastModified": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the pool." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the pool." }, "state": { "type": "string", "description": "Gets or sets the current state of the pool.", "enum": [ "active", "deleting", "upgrading" ], "x-ms-enum": { "name": "PoolState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the pool entered its current state." }, "allocationState": { "type": "string", "description": "Gets or sets whether the pool is resizing.", "enum": [ "steady", "resizing", "stopping" ], "x-ms-enum": { "name": "AllocationState", "modelAsString": false } }, "allocationStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the pool entered its current allocation state." }, "vmSize": { "type": "string", "description": "Gets or sets the size of virtual machines in the pool. All VMs in a pool are the same size." }, "osFamily": { "type": "string", "description": "Gets or sets the Azure Guest OS family to be installed on the virtual machines in the pool." }, "targetOSVersion": { "type": "string", "description": "Gets or sets 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 family." }, "currentOSVersion": { "type": "string", "description": "Gets or sets the Azure Guest OS Version currently installed on the virtual machines in the pool. This may differ from TargetOSVersion if the pool state is Upgrading." }, "resizeTimeout": { "type": "string", "format": "duration", "description": "Gets or sets the timeout for allocation of compute nodes to the pool. In a Get Pool operation, this is the timeout for the most recent resize operation. The default value is 10 minutes." }, "resizeError": { "$ref": "#/definitions/ResizeError", "description": "Gets or sets details of any error encountered while performing the last resize on the pool. This property is set only if an error occurred during the last pool resize, and only when the pool AllocationState is Steady." }, "currentDedicated": { "type": "integer", "format": "int32", "description": "Gets or sets the number of compute nodes currently in the pool." }, "targetDedicated": { "type": "integer", "format": "int32", "description": "Gets or sets the desired number of compute nodes in the pool. This property must have the default value if EnableAutoScale is true. It is required if EnableAutoScale is false." }, "enableAutoScale": { "type": "boolean", "description": "Gets or sets whether the pool size should automatically adjust over time. If true, the AutoScaleFormula property must be set. If false, the TargetDedicated property must be set." }, "autoScaleFormula": { "type": "string", "description": "Gets or sets a formula for the desired number of compute nodes in the pool." }, "autoScaleEvaluationInterval": { "type": "string", "format": "duration", "description": "Gets or sets a time interval for the desired AutoScale evaluation period in the pool." }, "autoScaleRun": { "$ref": "#/definitions/AutoScaleRun", "description": "Gets or sets the results and errors from the last execution of the autoscale formula." }, "enableInterNodeCommunication": { "type": "boolean", "description": "Gets or sets whether the pool permits direct communication between nodes." }, "startTask": { "$ref": "#/definitions/StartTask", "description": "Gets or sets a task specified to run on each compute node as it joins the pool." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Gets or sets the list of certificates to be installed on each compute node in the pool." }, "applicationPackageReferences": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackageReference" }, "description": "Gets or sets the list of application packages to be installed on each compute node in the pool." }, "maxTasksPerNode": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of tasks that can run concurrently on a single compute node in the pool." }, "taskSchedulingPolicy": { "$ref": "#/definitions/TaskSchedulingPolicy", "description": "Gets or sets how the Batch service distributes tasks between compute nodes in the pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the pool as metadata." }, "stats": { "$ref": "#/definitions/PoolStatistics", "description": "Gets or sets utilization and resource usage statistics for the entire lifetime of the pool." } }, "description": "A pool in the Azure Batch service." }, "PoolAddParameter": { "properties": { "id": { "type": "string", "description": "Gets or sets 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." }, "displayName": { "type": "string", "description": "Gets or sets the display name for the pool." }, "vmSize": { "type": "string", "description": "Gets or sets the size of virtual machines in the pool. All VMs in a pool are the same size." }, "osFamily": { "type": "string", "description": "Gets or sets the Azure Guest OS family to be installed on the virtual machines in the pool." }, "targetOSVersion": { "type": "string", "description": "Gets or sets 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 family." }, "resizeTimeout": { "type": "string", "format": "duration", "description": "Gets or sets the timeout for allocation of compute nodes to the pool. In a Get Pool operation, this is the timeout for the most recent resize operation. The default value is 10 minutes." }, "targetDedicated": { "type": "integer", "format": "int32", "description": "Gets or sets the desired number of compute nodes in the pool. This property must have the default value if EnableAutoScale is true. It is required if EnableAutoScale is false." }, "enableAutoScale": { "type": "boolean", "description": "Gets or sets whether the pool size should automatically adjust over time. If true, the AutoScaleFormula property must be set. If false, the TargetDedicated property must be set." }, "autoScaleFormula": { "type": "string", "description": "Gets or sets a formula for the desired number of compute nodes in the pool." }, "autoScaleEvaluationInterval": { "type": "string", "format": "duration", "description": "Gets or sets a time interval for the desired autoscale evaluation period in the pool." }, "enableInterNodeCommunication": { "type": "boolean", "description": "Gets or sets whether the pool permits direct communication between nodes." }, "startTask": { "$ref": "#/definitions/StartTask", "description": "Gets or sets a task specified to run on each compute node as it joins the pool." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Gets or sets the list of certificates to be installed on each compute node in the pool." }, "applicationPackageReferences": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackageReference" }, "description": "Gets or sets the list of application packages to be installed on each compute node in the pool." }, "maxTasksPerNode": { "type": "integer", "format": "int32", "description": "Gets or sets the maximum number of tasks that can run concurrently on a single compute node in the pool." }, "taskSchedulingPolicy": { "$ref": "#/definitions/TaskSchedulingPolicy", "description": "Gets or sets how the Batch service distributes tasks between compute nodes in the pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Gets or sets a list of name-value pairs associated with the pool as metadata." } }, "required": [ "id", "vmSize", "osFamily" ], "description": "A pool in the Azure Batch service to add." }, "ApplicationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApplicationSummary" }, "description": "Gets or sets the list of applications available in the account." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a ApplicationOperations.List request." }, "CloudPoolListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CloudPool" }, "description": "Gets or sets the list of pools." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CloudPoolOperations.List request." }, "AffinityInformation": { "properties": { "affinityId": { "type": "string", "description": "Gets or sets an opaque string representing the location of a compute node or a task that has run previously. You can pass the AffinityId of a compute node or task to indicate that this task needs to be placed close to the node or task." } }, "description": "A locality hint that can be used by the Batch service to select a compute node on which to start a task." }, "TaskExecutionInformation": { "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the task started running. If the task has been restarted or retried, this is the most recent time at which the task started running." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets 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": "Gets or sets the exit code of the task. This property is set only if the task is in completed state." }, "schedulingError": { "$ref": "#/definitions/TaskSchedulingError", "description": "Gets or sets details of any error encountered scheduling the task." }, "retryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the number of times the task has been retried by the Batch service." }, "lastRetryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the most recent time at which a retry of the task started running." }, "requeueCount": { "type": "integer", "format": "int32", "description": "Gets or sets the number of times the task has been requeued by the Batch service as the result of a user request." }, "lastRequeueTime": { "type": "string", "format": "date-time", "description": "Gets or sets the most recent time at which the task has been requeued by the Batch service as the result of a user request." } }, "required": [ "requeueCount", "retryCount" ], "description": "Information about the execution of a task." }, "ComputeNodeInformation": { "properties": { "affinityId": { "type": "string", "description": "Gets or sets an identifier for the compute node on which the task ran, which can be passed when adding a task to request that the task be scheduled close to this compute node." }, "nodeUrl": { "type": "string", "description": "Gets or sets the URL of the node on which the task ran. " }, "poolId": { "type": "string", "description": "Gets or sets the id of the pool on which the task ran." }, "nodeId": { "type": "string", "description": "Gets or sets the id of the node on which the task ran." }, "taskRootDirectory": { "type": "string", "description": "Gets or sets the root directory of the task on the compute node." }, "taskRootDirectoryUrl": { "type": "string", "description": "Gets or sets the URL to the root directory of the task on the compute node." } }, "description": "Information about the compute node on which a task ran." }, "MultiInstanceSettings": { "properties": { "numberOfInstances": { "type": "integer", "format": "int32", "description": "Gets or sets the number of compute node instances used for multi-instance task." }, "coordinationCommandLine": { "type": "string", "description": "Gets or sets the command to be run on the compute node instances to setup coordination among the subtasks." }, "commonResourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download on all subtasks." } }, "required": [ "numberOfInstances" ], "description": "Information about the settings required for multi-instance task." }, "TaskStatistics": { "properties": { "url": { "type": "string", "description": "Gets or sets the URL for the statistics." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the time range covered by the statistics." }, "lastUpdateTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." }, "userCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total user mode CPU time (summed across all cores and all compute nodes) consumed by the task." }, "kernelCPUTime": { "type": "string", "format": "duration", "description": "Gets or sets the total kernel mode CPU time (summed across all cores and all compute nodes) consumed by the task." }, "wallClockTime": { "type": "string", "format": "duration", "description": "Gets or sets the total wall clock time of the task." }, "readIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O read operations performed by the task." }, "writeIOps": { "type": "integer", "format": "int64", "description": "Gets or sets the total number of I/O write operations performed by the task." }, "readIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O read by the task." }, "writeIOGiB": { "type": "number", "format": "double", "description": "Gets or sets the total amount of data in GiB of I/O written by the task." }, "waitTime": { "type": "string", "format": "duration", "description": "Gets or sets the elapsed time between the creation of the task and the start of task execution." } }, "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "waitTime" ], "description": "Resource usage statistics for a task." }, "TaskDependencies": { "properties": { "taskIds": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets the list of task ids that must complete before this task can be scheduled." }, "taskIdRanges": { "type": "array", "items": { "$ref": "#/definitions/TaskIdRange" }, "description": "Gets or sets the list of task ranges that must complete before this task can be scheduled." } }, "description": "Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled." }, "TaskIdRange": { "properties": { "start": { "type": "integer", "format": "int32", "description": "Gets or sets the first task id in the range." }, "end": { "type": "integer", "format": "int32", "description": "Gets or sets the last task id in the range." } }, "required": [ "start", "end" ] }, "CloudTask": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the task within the job. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters." }, "displayName": { "type": "string", "description": "Gets or sets a display name for the task." }, "url": { "type": "string", "description": "Gets or sets the URL of the task." }, "eTag": { "type": "string", "description": "Gets or sets the ETag of the task." }, "lastModified": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the task." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the task." }, "state": { "type": "string", "description": "Gets or sets the current state of the task.", "enum": [ "active", "preparing", "running", "completed" ], "x-ms-enum": { "name": "TaskState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the task entered its current state." }, "previousState": { "type": "string", "description": "Gets or sets the previous state of the task. This property is not set if the task is in its initial Active state.", "enum": [ "active", "preparing", "running", "completed" ], "x-ms-enum": { "name": "TaskState", "modelAsString": false } }, "previousStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the task entered its previous state. This property is not set if the task is in its initial Active state." }, "commandLine": { "type": "string", "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary subtask is executed." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the task." }, "affinityInfo": { "$ref": "#/definitions/AffinityInformation", "description": "Gets or sets a locality hint that can be used by the Batch service to select a compute node on which to start the new task." }, "constraints": { "$ref": "#/definitions/TaskConstraints", "description": "Gets or sets the execution constraints that apply to this task." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the task in elevated mode." }, "executionInfo": { "$ref": "#/definitions/TaskExecutionInformation", "description": "Gets or sets information about the execution of the task." }, "nodeInfo": { "$ref": "#/definitions/ComputeNodeInformation", "description": "Gets or sets information about the compute node on which the task ran." }, "multiInstanceSettings": { "$ref": "#/definitions/MultiInstanceSettings", "description": "Gets or sets information about how to run the multi-instance task." }, "stats": { "$ref": "#/definitions/TaskStatistics", "description": "Gets or sets resource usage statistics for the task." }, "dependsOn": { "$ref": "#/definitions/TaskDependencies", "description": "Gets or sets any dependencies this task has." } }, "description": "An Azure Batch task." }, "TaskAddParameter": { "properties": { "id": { "type": "string", "description": "Gets or sets a string that uniquely identifies the task within the job. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters." }, "displayName": { "type": "string", "description": "Gets or sets a display name for the task." }, "commandLine": { "type": "string", "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", "items": { "$ref": "#/definitions/ResourceFile" }, "description": "Gets or sets a list of files that Batch will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary subtask is executed." }, "environmentSettings": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentSetting" }, "description": "Gets or sets a list of environment variable settings for the task." }, "affinityInfo": { "$ref": "#/definitions/AffinityInformation", "description": "Gets or sets a locality hint that can be used by the Batch service to select a compute node on which to start the new task." }, "constraints": { "$ref": "#/definitions/TaskConstraints", "description": "Gets or sets the execution constraints that apply to this task." }, "runElevated": { "type": "boolean", "description": "Gets or sets whether to run the task in elevated mode." }, "multiInstanceSettings": { "$ref": "#/definitions/MultiInstanceSettings", "description": "Gets or sets information about how to run the multi-instance task." }, "dependsOn": { "$ref": "#/definitions/TaskDependencies", "description": "Gets or sets any dependencies this task has." } }, "required": [ "id", "commandLine" ], "description": "An Azure Batch task to add." }, "SubtaskInformation": { "properties": { "id": { "type": "integer", "format": "int32", "description": "Gets or sets the id of the subtask." }, "nodeInfo": { "$ref": "#/definitions/ComputeNodeInformation", "description": "Gets or sets information about the compute node on which the subtask ran." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the subtask completed. This property is set only if the subtask is in the Completed state." }, "exitCode": { "type": "integer", "format": "int32", "description": "Gets or sets the exit code of the subtask. This property is set only if the subtask is in the Completed state." }, "schedulingError": { "$ref": "#/definitions/TaskSchedulingError", "description": "Gets or sets details of any error encountered scheduling the subtask." }, "state": { "type": "string", "description": "Gets or sets the current state of the subtask.", "enum": [ "active", "preparing", "running", "completed" ], "x-ms-enum": { "name": "TaskState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the subtask entered its current state." }, "previousState": { "type": "string", "description": "Gets or sets the previous state of the subtask. This property is not set if the subtask is in its initial Active state.", "enum": [ "active", "preparing", "running", "completed" ], "x-ms-enum": { "name": "TaskState", "modelAsString": false } }, "previousStateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the subtask entered its previous state. This property is not set if the subtask is in its initial Active state." } }, "description": "Information about an Azure Batch subtask." }, "CloudTaskListSubtasksResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/SubtaskInformation" }, "description": "Gets or sets the list of information of subtasks." } }, "description": "Response to a CloudTaskOperations.ListSubtasks request." }, "CloudTaskListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CloudTask" }, "description": "Gets or sets the list of tasks." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a CloudTaskOperations.List request." }, "TaskInformation": { "properties": { "taskUrl": { "type": "string", "description": "Gets or sets the URL of the task." }, "jobId": { "type": "string", "description": "Gets or sets the id of the job to which the task belongs." }, "taskId": { "type": "string", "description": "Gets or sets the id of the task." }, "subtaskId": { "type": "integer", "format": "int32", "description": "Gets or sets the id of the subtask if the task is a multi-instance task." }, "taskState": { "type": "string", "description": "Gets or sets the current state of the task.", "enum": [ "active", "preparing", "running", "completed" ], "x-ms-enum": { "name": "TaskState", "modelAsString": false } }, "executionInfo": { "$ref": "#/definitions/TaskExecutionInformation", "description": "Gets or sets information about the execution of the task." } }, "required": [ "taskState" ], "description": "Information about a task running on a compute node." }, "StartTaskInformation": { "properties": { "state": { "type": "string", "description": "Gets or sets the state of the start task on the compute node.", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "StartTaskState", "modelAsString": false } }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the start task started running." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the start task stopped running." }, "exitCode": { "type": "integer", "format": "int32", "description": "Gets or sets the exit code of the start task." }, "schedulingError": { "$ref": "#/definitions/TaskSchedulingError", "description": "Gets or sets any error encountered scheduling the start task." }, "retryCount": { "type": "integer", "format": "int32", "description": "Gets or sets the number of times the task has been retried by the Batch service." }, "lastRetryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the most recent time at which a retry of the task started running." } }, "required": [ "state", "startTime", "retryCount" ], "description": "Information about a start task running on a compute node." }, "ComputeNodeError": { "properties": { "code": { "type": "string", "description": "Gets or sets an identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "Gets or sets a message describing the compute node error, intended to be suitable for display in a user interface." }, "errorDetails": { "type": "array", "items": { "$ref": "#/definitions/NameValuePair" }, "description": "Gets or sets the list of additional error details related to the compute node error." } }, "description": "An error encountered by a compute node." }, "ComputeNode": { "properties": { "id": { "type": "string", "description": "Gets or sets the id of the compute node." }, "url": { "type": "string", "description": "Gets or sets the URL of the compute node." }, "state": { "type": "string", "description": "Gets or sets the current state of the compute node.", "enum": [ "idle", "rebooting", "reimaging", "running", "unusable", "creating", "starting", "waitingforstarttask", "starttaskfailed", "unknown", "leavingpool", "offline" ], "x-ms-enum": { "name": "ComputeNodeState", "modelAsString": false } }, "schedulingState": { "type": "string", "description": "Gets or sets whether the compute node should be available for task scheduling.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "SchedulingState", "modelAsString": false } }, "stateTransitionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the compute node entered its current state." }, "lastBootTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the compute node was started." }, "allocationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which this compute node was allocated to the pool." }, "ipAddress": { "type": "string", "description": "Gets or sets the IP address that other compute nodes can use to communicate with this compute node." }, "affinityId": { "type": "string", "description": "Gets or sets an identifier which can be passed in the Add Task API to request that the task be scheduled close to this compute node." }, "vmSize": { "type": "string", "description": "Gets or sets the size of the virtual machine hosting the compute node." }, "totalTasksRun": { "type": "integer", "format": "int32", "description": "Gets or sets the total number of job tasks completed on the compute node. This includes Job Preparation, Job Release and Job Manager tasks, but not the pool start task." }, "recentTasks": { "type": "array", "items": { "$ref": "#/definitions/TaskInformation" }, "description": "Gets or sets the list of tasks that are currently running on the compute node." }, "startTask": { "$ref": "#/definitions/StartTask", "description": "Gets or sets the task specified to run on the compute node as it joins the pool." }, "startTaskInfo": { "$ref": "#/definitions/StartTaskInformation", "description": "Gets or sets runtime information about the execution of the start task on the compute node." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Gets or sets the list of certificates installed on the compute node." }, "errors": { "type": "array", "items": { "$ref": "#/definitions/ComputeNodeError" }, "description": "Gets or sets the list of errors that are currently being encountered by the compute node." } }, "description": "A compute node in the Batch service." }, "ComputeNodeListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ComputeNode" }, "description": "Gets or sets the list of compute nodes." }, "odata.nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "Response to a ComputeNodeOperations.List request." }, "ComputeNodeUser": { "properties": { "name": { "type": "string", "description": "Gets or sets the user name of the account." }, "isAdmin": { "type": "boolean", "description": "Gets or sets whether the account should be an administrator on the compute node." }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the time at which the account should expire. If omitted, the default is 1 day from the current time." }, "password": { "type": "string", "description": "Gets or sets the password of the account." } }, "required": [ "name", "password" ], "description": "An user account on a compute node." }, "JobSchedulePatchParameter": { "properties": { "schedule": { "$ref": "#/definitions/Schedule", "description": "Sets the schedule according to which jobs will be created. If you do not specify this element, the existing schedule is not modified." }, "jobSpecification": { "$ref": "#/definitions/JobSpecification", "description": "Sets the details of the jobs to be created on this schedule." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the job schedule as metadata." } }, "description": "Parameters for a CloudJobScheduleOperations.Patch request." }, "JobScheduleUpdateParameter": { "properties": { "schedule": { "$ref": "#/definitions/Schedule", "description": "Sets the schedule according to which jobs will be created. If you do not specify this element, it is equivalent to passing the default schedule: that is, a single job scheduled to run immediately." }, "jobSpecification": { "$ref": "#/definitions/JobSpecification", "description": "Sets details of the jobs to be created on this schedule." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the job schedule as metadata. If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted." } }, "required": [ "schedule", "jobSpecification" ], "description": "Parameters for a CloudJobScheduleOperations.Update request." }, "JobDisableParameter": { "properties": { "disableTasks": { "type": "string", "description": "Sets what to do with active tasks associated with the job.", "enum": [ "requeue", "terminate", "wait" ], "x-ms-enum": { "name": "DisableJobOption", "modelAsString": false } } }, "required": [ "disableTasks" ], "description": "Parameters for a CloudJobOperations.Disable request." }, "JobTerminateParameter": { "properties": { "terminateReason": { "type": "string", "description": "Sets the text you want to appear as the job's TerminateReason. The default is 'UserTerminate'." } }, "description": "Parameters for a CloudJobOperations.Terminate request." }, "JobPatchParameter": { "properties": { "priority": { "type": "integer", "format": "int32", "description": "Sets the priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged." }, "constraints": { "$ref": "#/definitions/JobConstraints", "description": "Sets the execution constraints for the job. If omitted, the existing execution constraints are left unchanged." }, "poolInfo": { "$ref": "#/definitions/PoolInformation", "description": "Sets the pool on which the Batch service runs the job's tasks. If omitted, the job continues to run on its current pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged." } }, "description": "Parameters for a CloudJobOperations.Patch request." }, "JobUpdateParameter": { "properties": { "priority": { "type": "integer", "format": "int32", "description": "Sets the priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged." }, "constraints": { "$ref": "#/definitions/JobConstraints", "description": "Sets the execution constraints for the job. If omitted, the existing execution constraints are left unchanged." }, "poolInfo": { "$ref": "#/definitions/PoolInformation", "description": "Sets the pool on which the Batch service runs the job's tasks. If omitted, the job continues to run on its current pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged." } }, "required": [ "poolInfo" ], "description": "Parameters for a CloudJobOperations.Update request." }, "PoolEnableAutoScaleParameter": { "properties": { "autoScaleFormula": { "type": "string", "description": "Sets the formula for the desired number of compute nodes in the pool." }, "autoScaleEvaluationInterval": { "type": "string", "format": "duration", "description": "Gets or sets a time interval for the desired autoscale evaluation period in the pool." } }, "description": "Parameters for a CloudPoolOperations.EnableAutoScale request." }, "PoolEvaluateAutoScaleParameter": { "properties": { "autoScaleFormula": { "type": "string", "description": "Sets a formula for the desired number of compute nodes in the pool." } }, "required": [ "autoScaleFormula" ], "description": "Parameters for a CloudJobOperations.EvaluateAutoScale request." }, "PoolResizeParameter": { "properties": { "targetDedicated": { "type": "integer", "format": "int32", "description": "Sets the desired number of compute nodes in the pool." }, "resizeTimeout": { "type": "string", "format": "duration", "description": "Sets the timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 10 minutes." }, "nodeDeallocationOption": { "type": "string", "description": "Sets when nodes may be removed from the pool, if the pool size is decreasing.", "enum": [ "requeue", "terminate", "taskcompletion", "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeDeallocationOption", "modelAsString": false } } }, "required": [ "targetDedicated" ], "description": "Parameters for a CloudPoolOperations.Resize request." }, "PoolUpdatePropertiesParameter": { "properties": { "startTask": { "$ref": "#/definitions/StartTask", "description": "Sets a task to run on each compute node as it joins the pool. If omitted, any existing start task is removed from the pool." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Sets a list of certificates to be installed on each compute node in the pool. If you specify an empty collection, any existing certificate references are removed from the pool." }, "applicationPackageReferences": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackageReference" }, "description": "Sets a list of application packages to be installed on each compute node in the pool. If you specify an empty collection, any existing application packages references are removed from the pool." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the pool as metadata. If you specify an empty collection, any existing metadata is removed from the pool." } }, "required": [ "certificateReferences", "metadata", "applicationPackageReferences" ], "description": "Parameters for a CloudPoolOperations.UpdateProperties request." }, "PoolUpgradeOSParameter": { "properties": { "targetOSVersion": { "type": "string", "description": "Sets the Azure Guest OS version to be installed on the virtual machines in the pool." } }, "required": [ "targetOSVersion" ], "description": "Parameters for a CloudPoolOperations.UpgradeOS request." }, "PoolPatchParameter": { "properties": { "startTask": { "$ref": "#/definitions/StartTask", "description": "Sets a task to run on each compute node as it joins the pool. If omitted, any existing start task is left unchanged." }, "certificateReferences": { "type": "array", "items": { "$ref": "#/definitions/CertificateReference" }, "description": "Sets a list of certificates to be installed on each compute node in the pool. If omitted, any existing certificate references are left unchanged." }, "applicationPackageReferences": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackageReference" }, "description": "Sets a list of application packages to be installed on each compute node in the pool. If omitted, any existing application package references are left unchanged." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataItem" }, "description": "Sets a list of name-value pairs associated with the pool as metadata. If omitted, any existing metadata is left unchanged." } }, "description": "Parameters for a CloudPoolOperations.Patch request." }, "TaskUpdateParameter": { "properties": { "constraints": { "$ref": "#/definitions/TaskConstraints", "description": "Sets constraints that apply to this task. If omitted, the task is given the default constraints." } }, "description": "Parameters for a CloudTaskOperations.Update request." }, "NodeUpdateUserParameter": { "properties": { "password": { "type": "string", "description": "Sets the password of the account." }, "expiryTime": { "type": "string", "format": "date-time", "description": "Sets the time at which the account should expire. If omitted, the default is 1 day from the current time." } }, "required": [ "password" ], "description": "Parameters for a ComputeNodeOperations.UpdateUser request." }, "NodeRebootParameter": { "properties": { "nodeRebootOption": { "type": "string", "description": "Sets when to reboot the compute node and what to do with currently running tasks. The default value is requeue.", "enum": [ "requeue", "terminate", "taskcompletion", "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeRebootOption", "modelAsString": false } } }, "description": "Parameters for a ComputeNodeOperations.Reboot request." }, "NodeReimageParameter": { "properties": { "nodeReimageOption": { "type": "string", "description": "Sets when to reimage the compute node and what to do with currently running tasks. The default value is requeue.", "enum": [ "requeue", "terminate", "taskcompletion", "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeReimageOption", "modelAsString": false } } }, "description": "Parameters for a ComputeNodeOperations.Reimage request." }, "NodeDisableSchedulingParameter": { "properties": { "nodeDisableSchedulingOption": { "type": "string", "description": "Gets or sets what to do with currently running tasks when disable task scheduling on the compute node. The default value is requeue.", "enum": [ "requeue", "terminate", "taskcompletion" ], "x-ms-enum": { "name": "DisableComputeNodeSchedulingOption", "modelAsString": false } } }, "description": "Parameters for a ComputeNodeOperations.DisableScheduling request." }, "NodeRemoveParameter": { "properties": { "nodeList": { "type": "array", "items": { "type": "string" }, "description": "Sets a list containing the id of the compute nodes to be removed from the specified pool." }, "resizeTimeout": { "type": "string", "format": "duration", "description": "Sets the timeout for removal of compute nodes to the pool. The default value is 10 minutes." }, "nodeDeallocationOption": { "type": "string", "description": "Sets when compute nodes may be removed from the pool.", "enum": [ "requeue", "terminate", "taskcompletion", "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeDeallocationOption", "modelAsString": false } } }, "required": [ "nodeList" ], "description": "Parameters for a ComputeNodeOperations.Remove request." }, "ErrorMessage": { "properties": { "lang": { "type": "string", "description": "Gets or sets the language code of the error message" }, "value": { "type": "string", "description": "Gets or sets the text of the message." } }, "description": "An error message received in an Azure Batch error response." }, "BatchErrorDetail": { "properties": { "key": { "type": "string", "description": "Gets or sets an identifier specifying the meaning of the Value property." }, "value": { "type": "string", "description": "Gets or sets the additional information included with the error response." } }, "description": "An item of additional information included in an Azure Batch error response." }, "BatchError": { "properties": { "code": { "type": "string", "description": "Gets or sets an identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "$ref": "#/definitions/ErrorMessage", "description": "Gets or sets a message describing the error, intended to be suitable for display in a user interface." }, "values": { "type": "array", "items": { "$ref": "#/definitions/BatchErrorDetail" }, "description": "Gets or sets a collection of key-value pairs containing additional details about the error." } }, "description": "An error response received from the Azure Batch service." } }, "parameters": { "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client API Version." } } }