{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Jobschedules API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Jobschedules", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Lists All Of The Job Schedules In The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobschedules", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Lists all of the Job Schedules in the specified Account." }, { "info": { "name": "Microsoft Azure Creates A Job Schedule To The Specified Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobschedules", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." } ] }, "docs": "Creates a Job Schedule to the specified Account." }, { "info": { "name": "Microsoft Azure Get Jobschedules Jobscheduleid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobschedules/:jobScheduleId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to get." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Gets information about the specified Job Schedule." }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Job Schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/jobschedules/:jobScheduleId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to update." } ] }, "docs": "This fully replaces all the updatable properties of the Job Schedule. For
example, if the schedule property is not specified with this request, then the
Batch service will remove the existing schedule. Changes to a Job Schedule only
impact Jobs created by the schedule after the update has taken place; currently
running Jobs are unaffected." }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Job Schedule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/jobschedules/:jobScheduleId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to update." } ] }, "docs": "This replaces only the Job Schedule properties specified in the request. For
example, if the schedule property is not specified with this request, then the
Batch service will keep the existing schedule. Changes to a Job Schedule only
impact Jobs created by the schedule after the update has taken place; currently
running Jobs are unaffected." }, { "info": { "name": "Microsoft Azure Deletes A Job Schedule From The Specified Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobschedules/:jobScheduleId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to delete." } ] }, "docs": "When you delete a Job Schedule, this also deletes all Jobs and Tasks under that
schedule. When Tasks are deleted, all the files in their working directories on
the Compute Nodes are also deleted (the retention period is ignored). The Job
Schedule statistics are no longer accessible once the Job Schedule is deleted,
though they are still counted towards Account lifetime statistics." }, { "info": { "name": "Microsoft Azure Checks The Specified Job Schedule Exists", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/jobschedules/:jobScheduleId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule which you want to check." } ] }, "docs": "Checks the specified Job Schedule exists." }, { "info": { "name": "Microsoft Azure Disables A Job Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobschedules/:jobScheduleId/disable", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to disable." } ] }, "docs": "No new Jobs will be created until the Job Schedule is enabled again." }, { "info": { "name": "Microsoft Azure Enables A Job Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobschedules/:jobScheduleId/enable", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to enable." } ] }, "docs": "Enables a Job Schedule." }, { "info": { "name": "Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobschedules/:jobScheduleId/jobs", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule from which you want to get a list of Jobs." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Lists the Jobs that have been created under the specified Job Schedule." }, { "info": { "name": "Microsoft Azure Terminates A Job Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobschedules/:jobScheduleId/terminate", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule to terminates." } ] }, "docs": "Terminates a Job Schedule." } ] } ], "bundled": true }