--- title: "GET /jobschedules" method: GET path: "/jobschedules" tags: ["JobSchedules"] --- # GET /jobschedules `GET /jobschedules` Lists all of the job schedules in the specified account. ## Query parameters - `$filter` string - `$select` string - `$expand` string - `maxresults` integer - `timeout` integer - `api-version` string, required ## Headers - `client-request-id` string - `return-client-request-id` boolean - `ocp-date` string, date-time-rfc1123 ## Response `200` OK - CloudJobScheduleListResult — Response to a CloudJobScheduleOperation.List request. - `value` CloudJobSchedule[] — The list of job schedules. - `id` string — A string that uniquely identifies the schedule within the account. A GUID is recommended. - `displayName` string — The display name for the schedule. - `url` string — The URL of the job schedule. - `eTag` string — The ETag of the job schedule. - `lastModified` string, date-time — The last modified time of the job schedule. - `creationTime` string, date-time — The creation time of the job schedule. - `state` 'active' | 'completed' | 'disabled' | 'terminating' | 'deleting' — The current state of the job schedule. - `stateTransitionTime` string, date-time — The time at which the job schedule entered the current state. - `previousState` 'active' | 'completed' | 'disabled' | 'terminating' | 'deleting' — The previous state of the job schedule. - `previousStateTransitionTime` string, date-time — The time at which the job schedule entered its previous state. - `schedule` Schedule — The schedule according to which jobs will be created - `doNotRunUntil` string, date-time — 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` string, date-time — 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` string, duration — 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` string, duration — 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. - `jobSpecification` JobSpecification — Specifies details of the jobs to be created on a schedule. - `priority` integer — 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` string — 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` boolean — The flag that determines if this job will use tasks with dependencies. - `constraints` JobConstraints — Specifies the execution constraints for jobs created on a schedule. - `maxWallClockTime` string, duration — 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` integer — The maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero. - `jobManagerTask` JobManagerTask — Specifies details of a Job Manager task. - `id` string — A string that uniquely identifies the Job Manager task. A GUID is recommended. - `displayName` string — The display name of the Job Manager task. - `commandLine` string — The command line of the Job Manager task. - `resourceFiles` ResourceFile[] — A list of files that the Batch service will download to the compute node before running the command line. - `blobSource` string — The URL of the file within Azure Blob Storage. This URL should include a shared access signature if the blob is not publicly readable. - `filePath` string — The location to which to download the file, relative to the task's working directory. - `fileMode` string — The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node. - `environmentSettings` EnvironmentSetting[] — A list of environment variable settings for the Job Manager task. - `name` string — The name of the environment variable. - `value` string — The value of the environment variable. - `constraints` TaskConstraints — Constraints to apply to the Job Manager task. - `maxWallClockTime` string, duration — 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` string, duration — The minimum time to retain the working directory for the task on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the working directory and all its contents. The default is infinite. - `maxTaskRetryCount` integer — The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. - `killJobOnCompletion` boolean — Whether completion of the Job Manager task signifies completion of the entire job. - `runElevated` boolean — Whether to run the Job Manager task in elevated mode. The default value is false. - `runExclusive` boolean — Whether the Job Manager task requires exclusive use of the compute node where it runs. If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. (The Job Manager task counts normally against the node's concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks.) - `jobPreparationTask` JobPreparationTask — A Job Preparation task to run before any tasks of the job on any given compute node. - `id` string — 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` string — The command line of the Job Preparation task. - `resourceFiles` ResourceFile[] — A list of files that the Batch service will download to the compute node before running the command line. - `blobSource` string — The URL of the file within Azure Blob Storage. This URL should include a shared access signature if the blob is not publicly readable. - `filePath` string — The location to which to download the file, relative to the task's working directory. - `fileMode` string — The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node. - `environmentSettings` EnvironmentSetting[] — A list of environment variable settings for the Job Preparation task. - `name` string — The name of the environment variable. - `value` string — The value of the environment variable. - `constraints` TaskConstraints — Constraints to apply to the Job Manager task. - `maxWallClockTime` string, duration — 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` string, duration — The minimum time to retain the working directory for the task on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the working directory and all its contents. The default is infinite. - `maxTaskRetryCount` integer — The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. - `waitForSuccess` boolean — 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` boolean — Whether to run the Job Preparation task in elevated mode. The default value is false. - `rerunOnNodeRebootAfterSuccess` boolean — Whether the Batch service should rerun the Job Preparation task after a compute node reboots. Note that the Job Preparation task should still be written to be idempotent because it can be rerun if the compute node is rebooted while Job Preparation task is still running. The default value is true. - `jobReleaseTask` JobReleaseTask — A Job Release task to run on job completion on any compute node where the job has run. - `id` string — 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` string — The command line of the Job Release task. - `resourceFiles` ResourceFile[] — A list of files that the Batch service will download to the compute node before running the command line. - `blobSource` string — The URL of the file within Azure Blob Storage. This URL should include a shared access signature if the blob is not publicly readable. - `filePath` string — The location to which to download the file, relative to the task's working directory. - `fileMode` string — The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node. - `environmentSettings` EnvironmentSetting[] — A list of environment variable settings for the Job Release task. - `name` string — The name of the environment variable. - `value` string — The value of the environment variable. - `maxWallClockTime` string, duration — 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` string, duration — 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` boolean — Whether to run the Job Release task in elevated mode. The default value is false. - `commonEnvironmentSettings` EnvironmentSetting[] — 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). - `name` string — The name of the environment variable. - `value` string — The value of the environment variable. - `poolInfo` PoolInformation — Specifies how a job should be assigned to a pool. - `poolId` string — 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` AutoPoolSpecification — 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. - `autoPoolIdPrefix` string — 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` 'jobschedule' | 'job' | 'unmapped', required — The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. - `keepAlive` boolean — Whether to keep an auto pool alive after its lifetime expires. - `pool` PoolSpecification — Specification for creating a new pool. - `displayName` string — The display name for the pool. - `vmSize` string — The size of the virtual machines in the pool. All virtual machines in a pool are the same size. - `cloudServiceConfiguration` CloudServiceConfiguration — The configuration for nodes in a pool based on the Azure Cloud Services platform. - … - `virtualMachineConfiguration` VirtualMachineConfiguration — The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. - … - `maxTasksPerNode` integer — The maximum number of tasks that can run concurrently on a single compute node in the pool. - `taskSchedulingPolicy` TaskSchedulingPolicy — Specifies how tasks should be distributed across compute nodes. - … - `resizeTimeout` string, duration — The timeout for allocation of compute nodes to the pool. - `targetDedicated` integer — The desired number of compute nodes in the pool. - `enableAutoScale` boolean — Whether the pool size should automatically adjust over time. - `autoScaleFormula` string — The formula for the desired number of compute nodes in the pool. - `autoScaleEvaluationInterval` string, duration — A time interval for the desired AutoScale evaluation period in the pool. - `enableInterNodeCommunication` boolean — Whether the pool permits direct communication between nodes. - `startTask` StartTask — A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. - … - `certificateReferences` CertificateReference[] — A list of certificates to be installed on each compute node in the pool. - … - `applicationPackageReferences` ApplicationPackageReference[] — The list of application packages to be installed on each compute node in the pool. - … - `metadata` MetadataItem[] — A list of name-value pairs associated with the pool as metadata. - … - `metadata` MetadataItem[] — A list of name-value pairs associated with each job created under this schedule as metadata. - `name` string — The name of the metadata item. - `value` string — The value of the metadata item. - `executionInfo` JobScheduleExecutionInformation — Specifies how tasks should be run in a job associated with a job schedule. - `nextRunTime` string, date-time — The next time at which a job will be created under this schedule. - `recentJob` RecentJob — Information about the most recent job to run under the job schedule. - `id` string — The id of the job. - `url` string — The URL of the job. - `endTime` string, date-time — The time at which the schedule ended. This property is set only if the job schedule is in the completed state. - `metadata` MetadataItem[] — A list of name-value pairs associated with the schedule as metadata. - `name` string — The name of the metadata item. - `value` string — The value of the metadata item. - `stats` JobScheduleStatistics — Resource usage statistics for a job schedule. - `url` string, required — The URL of the statistics. - `startTime` string, date-time, required — The start time of the time range covered by the statistics. - `lastUpdateTime` string, date-time, required — The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. - `userCPUTime` string, duration, required — The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule. - `kernelCPUTime` string, duration, required — The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule. - `wallClockTime` string, duration, required — The total wall clock time of all the tasks in all the jobs created under the schedule. - `readIOps` integer, required — The total number of disk read operations made by all tasks in all jobs created under the schedule. - `writeIOps` integer, required — The total number of disk write operations made by all tasks in all jobs created under the schedule. - `readIOGiB` number, double, required — The total gibibytes read from disk by all tasks in all jobs created under the schedule. - `writeIOGiB` number, double, required — The total gibibytes written to disk by all tasks in all jobs created under the schedule. - `numSucceededTasks` integer, required — 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` integer, required — 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` integer, required — The total number of retries during the given time range on all tasks in all jobs created under the schedule. - `waitTime` string, duration, required — The total wait time of all tasks in all jobs created under the schedule. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.) - `odata.nextLink` string — The URL to get the next set of results. ## Other responses - `default` — The error from the Batch service. --- [API](https://skmtc.dev/azure/apis/batch-batch.md) · [All operations](https://skmtc.dev/azure/apis/batch-batch/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/batch-batch/revisions/bee2d837bf8f/schema)