openapi-directory/api/windows.net/batch-BatchService.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"A client for issuing REST requests to the Azure Batch service.","title":"BatchService","version":"2018-08-01.7.0","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"BatchServiceClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json","version":"2.0"}],"x-preferred":true,"x-providerName":"windows.net","x-serviceName":"batch-BatchService"},"paths":{"/applications":{"get":{"description":"This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.","operationId":"Application_List","parameters":[{"description":"The maximum number of items to return in the response. A maximum of 1000 applications can be returned.","in":"query","name":"maxresults","required":false,"x-ms-client-name":"maxResults","x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":1000}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"List applications":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the list of applications.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListResult"},"examples":{"List applications":{"$ref":"#/components/examples/List_applications"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Lists all of the applications available in the specified account.","tags":["Applications"],"x-ms-pageable":{"nextLinkName":"odata.nextLink"},"x-ms-request-id":"request-id"}},"/applications/{applicationId}":{"get":{"description":"This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.","operationId":"Application_Get","parameters":[{"description":"The ID of the application.","in":"path","name":"applicationId","required":true,"schema":{"type":"string"},"examples":{"Get applications":{"value":"my_application_id"}}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Get applications":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the application.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSummary"},"examples":{"Get applications":{"$ref":"#/components/examples/Get_applications"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Gets information about the specified application.","tags":["Applications"],"x-ms-request-id":"request-id"}},"/certificates":{"get":{"operationId":"Certificate_List","parameters":[{"description":"An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.","in":"query","name":"$filter","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An OData $select clause.","in":"query","name":"$select","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"The maximum number of items to return in the response. A maximum of 1000 certificates can be returned.","in":"query","name":"maxresults","required":false,"x-ms-client-name":"maxResults","x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":1000}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Certificate list":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the list of certificates.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateListResult"},"examples":{"Certificate list":{"$ref":"#/components/examples/Certificate_list"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Lists all of the certificates that have been added to the specified account.","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"odata.nextLink"},"x-ms-request-id":"request-id"},"post":{"operationId":"Certificate_Add","parameters":[{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Certificate add":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json; odata=minimalmetadata":{"schema":{"$ref":"#/components/schemas/CertificateAddParameter"}}},"description":"The certificate to be added.","required":true},"responses":{"201":{"description":"The request to the Batch service was successful.","headers":{"DataServiceId":{"description":"The OData ID of the resource to which the request applied.","schema":{"type":"string"}},"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Adds a certificate to the specified account.","tags":["Certificates"],"x-ms-request-id":"request-id"}},"/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})":{"delete":{"description":"You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.","operationId":"Certificate_Delete","parameters":[{"description":"The algorithm used to derive the thumbprint parameter. This must be sha1.","in":"path","name":"thumbprintAlgorithm","required":true,"schema":{"type":"string"},"examples":{"Certificate delete":{"value":"sha1"}}},{"description":"The thumbprint of the certificate to be deleted.","in":"path","name":"thumbprint","required":true,"schema":{"type":"string"},"examples":{"Certificate delete":{"value":"0123456789abcdef0123456789abcdef01234567"}}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Certificate delete":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"202":{"description":"The request to the Batch service was successful.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Deletes a certificate from the specified account.","tags":["Certificates"],"x-ms-request-id":"request-id"},"get":{"description":"Gets information about the specified certificate.","operationId":"Certificate_Get","parameters":[{"description":"The algorithm used to derive the thumbprint parameter. This must be sha1.","in":"path","name":"thumbprintAlgorithm","required":true,"schema":{"type":"string"},"examples":{"Certificate get":{"value":"sha1"}}},{"description":"The thumbprint of the certificate to get.","in":"path","name":"thumbprint","required":true,"schema":{"type":"string"},"examples":{"Certificate get":{"value":"0123456789abcdef0123456789abcdef01234567"}}},{"description":"An OData $select clause.","in":"query","name":"$select","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Certificate get":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the certificate.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Certificate get":{"$ref":"#/components/examples/Certificate_get"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"tags":["Certificates"],"x-ms-request-id":"request-id"}},"/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete":{"post":{"description":"If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.","operationId":"Certificate_CancelDeletion","parameters":[{"description":"The algorithm used to derive the thumbprint parameter. This must be sha1.","in":"path","name":"thumbprintAlgorithm","required":true,"schema":{"type":"string"},"examples":{"Certificate cancel delete":{"value":"sha1"}}},{"description":"The thumbprint of the certificate being deleted.","in":"path","name":"thumbprint","required":true,"schema":{"type":"string"},"examples":{"Certificate cancel delete":{"value":"0123456789abcdef0123456789abcdef01234567"}}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Certificate cancel delete":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The request to the Batch service was successful.","headers":{"DataServiceId":{"description":"The OData ID of the resource to which the request applied.","schema":{"type":"string"}},"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Cancels a failed deletion of a certificate from the specified account.","tags":["Certificates"],"x-ms-request-id":"request-id"}},"/jobs":{"get":{"operationId":"Job_List","parameters":[{"description":"An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.","in":"query","name":"$filter","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An OData $select clause.","in":"query","name":"$select","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An OData $expand clause.","in":"query","name":"$expand","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.","in":"query","name":"maxresults","required":false,"x-ms-client-name":"maxResults","x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":1000}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Job list":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the list of jobs.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudJobListResult"},"examples":{"Job list":{"$ref":"#/components/examples/Job_list"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Lists all of the jobs in the specified account.","tags":["Jobs"],"x-ms-pageable":{"nextLinkName":"odata.nextLink"},"x-ms-request-id":"request-id"},"post":{"description":"The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.","operationId":"Job_Add","parameters":[{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Add a basic job":{"value":"00000000-0000-0000-0000-000000000000"},"Add a complex job":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json; odata=minimalmetadata":{"schema":{"$ref":"#/components/schemas/JobAddParameter"}}},"description":"The job to be added.","required":true},"responses":{"201":{"description":"The request to the Batch service was successful.","headers":{"DataServiceId":{"description":"The OData ID of the resource to which the request applied.","schema":{"type":"string"}},"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Adds a job to the specified account.","tags":["Jobs"],"x-ms-request-id":"request-id"}},"/jobs/{jobId}":{"delete":{"description":"Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents.  When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.","operationId":"Job_Delete","parameters":[{"description":"The ID of the job to delete.","in":"path","name":"jobId","required":true,"schema":{"type":"string"},"examples":{"Delete Job":{"value":"jobId"}}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Delete Job":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.","in":"header","name":"If-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.","in":"header","name":"If-None-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.","in":"header","name":"If-Modified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.","in":"header","name":"If-Unmodified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"202":{"description":"The request to the Batch service was successful.","headers":{"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string"}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Deletes a job.","tags":["Jobs"],"x-ms-request-id":"request-id"},"get":{"operationId":"Job_Get","parameters":[{"description":"The ID of the job.","in":"path","name":"jobId","required":true,"schema":{"type":"string"},"examples":{"Job get":{"value":"jobId"}}},{"description":"An OData $select clause.","in":"query","name":"$select","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An OData $expand clause.","in":"query","name":"$expand","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Job get":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.","in":"header","name":"If-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.","in":"header","name":"If-None-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.","in":"header","name":"If-Modified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.","in":"header","name":"If-Unmodified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response containing the job.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudJob"},"examples":{"Job get":{"$ref":"#/components/examples/Job_get"}}}}},"default":{"description":"The error from the Batch service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchError"}}}}},"summary":"Gets information about the specified job.","tags":["Jobs"],"x-ms-request-id":"request-id"},"patch":{"description":"This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.","operationId":"Job_Patch","parameters":[{"description":"The ID of the job whose properties you want to update.","in":"path","name":"jobId","required":true,"schema":{"type":"string"},"examples":{"Job patch":{"value":"jobId"}}},{"description":"The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.","in":"query","name":"timeout","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"integer","format":"int32","default":30}},{"description":"The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.","in":"header","name":"client-request-id","required":false,"x-ms-client-request-id":true,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"uuid"},"examples":{"Job patch":{"value":"00000000-0000-0000-0000-000000000000"}}},{"description":"Whether the server should return the client-request-id in the response.","in":"header","name":"return-client-request-id","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"boolean","default":false}},{"description":"The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.","in":"header","name":"ocp-date","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.","in":"header","name":"If-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.","in":"header","name":"If-None-Match","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.","in":"header","name":"If-Modified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"description":"A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.","in":"header","name":"If-Unmodified-Since","required":false,"x-ms-parameter-grouping":{"postfix":"Options"},"schema":{"type":"string","format":"date-time-rfc1123"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json; odata=minimalmetadata":{"schema":{"$ref":"#/components/schemas/JobPatchParameter"}}},"description":"The parameters for the request.","required":true},"responses":{"200":{"description":"The request to the Batch service was successful.","headers":{"DataServiceId":{"description":"The OData ID of the resource to which the request applied.","schema":{"type":"string"}},"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.","schema":{"type":"string"}},"Last-Modified":{"description":"The time at which the resource was last modified.","schema":{"type":"string","format":"date-time-rfc1123"}},"client-request-id":{"description":"The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.","schema":{"type":"string","format":"uuid"}},"request-id":{"description":"A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region t