JobSchedule | @azure/batch

Class representing a JobSchedule.

Hierarchy

JobSchedule

Index

Constructors

constructor

Methods

Constructors

constructor

new JobSchedule(client: BatchServiceClientContext): JobSchedule

- Defined in operations/jobSchedule.ts:19
Create a JobSchedule.

Parameters
- client: BatchServiceClientContext
  
  Reference to the service client.
Returns JobSchedule

Methods

add

add(cloudJobSchedule: JobScheduleAddParameter, options?: Models.JobScheduleAddOptionalParams): Promise<Models.JobScheduleAddResponse>
add(cloudJobSchedule: JobScheduleAddParameter, callback: msRest.ServiceCallback<void>): void
add(cloudJobSchedule: JobScheduleAddParameter, options: JobScheduleAddOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:281
summary

Adds a job schedule to the specified account.

Parameters
- cloudJobSchedule: JobScheduleAddParameter
  
  The job schedule to be added.
- Optional options: Models.JobScheduleAddOptionalParams
Returns Promise<Models.JobScheduleAddResponse>

Promise<Models.JobScheduleAddResponse>
- Defined in operations/jobSchedule.ts:286
Parameters
- cloudJobSchedule: JobScheduleAddParameter
  
  The job schedule to be added.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:292
Parameters
- cloudJobSchedule: JobScheduleAddParameter
  
  The job schedule to be added.
- options: JobScheduleAddOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

deleteMethod

deleteMethod(jobScheduleId: string, options?: Models.JobScheduleDeleteMethodOptionalParams): Promise<Models.JobScheduleDeleteResponse>
deleteMethod(jobScheduleId: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(jobScheduleId: string, options: JobScheduleDeleteMethodOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:68
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.

summary

Deletes a job schedule from the specified account.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to delete.
- Optional options: Models.JobScheduleDeleteMethodOptionalParams
Returns Promise<Models.JobScheduleDeleteResponse>

Promise<Models.JobScheduleDeleteResponse>
- Defined in operations/jobSchedule.ts:73
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to delete.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:79
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to delete.
- options: JobScheduleDeleteMethodOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

disable

disable(jobScheduleId: string, options?: Models.JobScheduleDisableOptionalParams): Promise<Models.JobScheduleDisableResponse>
disable(jobScheduleId: string, callback: msRest.ServiceCallback<void>): void
disable(jobScheduleId: string, options: JobScheduleDisableOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:197
No new jobs will be created until the job schedule is enabled again.

summary

Disables a job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to disable.
- Optional options: Models.JobScheduleDisableOptionalParams
Returns Promise<Models.JobScheduleDisableResponse>

Promise<Models.JobScheduleDisableResponse>
- Defined in operations/jobSchedule.ts:202
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to disable.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:208
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to disable.
- options: JobScheduleDisableOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

enable

enable(jobScheduleId: string, options?: Models.JobScheduleEnableOptionalParams): Promise<Models.JobScheduleEnableResponse>
enable(jobScheduleId: string, callback: msRest.ServiceCallback<void>): void
enable(jobScheduleId: string, options: JobScheduleEnableOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:225
summary

Enables a job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to enable.
- Optional options: Models.JobScheduleEnableOptionalParams
Returns Promise<Models.JobScheduleEnableResponse>

Promise<Models.JobScheduleEnableResponse>
- Defined in operations/jobSchedule.ts:230
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to enable.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:236
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to enable.
- options: JobScheduleEnableOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

exists

exists(jobScheduleId: string, options?: Models.JobScheduleExistsOptionalParams): Promise<Models.JobScheduleExistsResponse>
exists(jobScheduleId: string, callback: msRest.ServiceCallback<boolean>): void
exists(jobScheduleId: string, options: JobScheduleExistsOptionalParams, callback: msRest.ServiceCallback<boolean>): void

- Defined in operations/jobSchedule.ts:35
summary

Checks the specified job schedule exists.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule which you want to check.
- Optional options: Models.JobScheduleExistsOptionalParams
Returns Promise<Models.JobScheduleExistsResponse>

Promise<Models.JobScheduleExistsResponse>
- Defined in operations/jobSchedule.ts:40
Parameters
- jobScheduleId: string
  
  The ID of the job schedule which you want to check.
- callback: msRest.ServiceCallback<boolean>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:46
Parameters
- jobScheduleId: string
  
  The ID of the job schedule which you want to check.
- options: JobScheduleExistsOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<boolean>
  
  The callback
Returns void

get

get(jobScheduleId: string, options?: Models.JobScheduleGetOptionalParams): Promise<Models.JobScheduleGetResponse>
get(jobScheduleId: string, callback: msRest.ServiceCallback<CloudJobSchedule>): void
get(jobScheduleId: string, options: JobScheduleGetOptionalParams, callback: msRest.ServiceCallback<CloudJobSchedule>): void

- Defined in operations/jobSchedule.ts:96
Gets information about the specified job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to get.
- Optional options: Models.JobScheduleGetOptionalParams
Returns Promise<Models.JobScheduleGetResponse>

Promise<Models.JobScheduleGetResponse>
- Defined in operations/jobSchedule.ts:101
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to get.
- callback: msRest.ServiceCallback<CloudJobSchedule>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:107
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to get.
- options: JobScheduleGetOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<CloudJobSchedule>
  
  The callback
Returns void

list

list(options?: Models.JobScheduleListOptionalParams): Promise<Models.JobScheduleListResponse>
list(callback: msRest.ServiceCallback<CloudJobScheduleListResult>): void
list(options: JobScheduleListOptionalParams, callback: msRest.ServiceCallback<CloudJobScheduleListResult>): void

- Defined in operations/jobSchedule.ts:308
summary

Lists all of the job schedules in the specified account.

Parameters
- Optional options: Models.JobScheduleListOptionalParams
Returns Promise<Models.JobScheduleListResponse>

Promise<Models.JobScheduleListResponse>
- Defined in operations/jobSchedule.ts:312
Parameters
- callback: msRest.ServiceCallback<CloudJobScheduleListResult>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:317
Parameters
- options: JobScheduleListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<CloudJobScheduleListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: Models.JobScheduleListNextOptionalParams): Promise<Models.JobScheduleListResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<CloudJobScheduleListResult>): void
listNext(nextPageLink: string, options: JobScheduleListNextOptionalParams, callback: msRest.ServiceCallback<CloudJobScheduleListResult>): void

- Defined in operations/jobSchedule.ts:333
summary

Lists all of the job schedules in the specified account.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: Models.JobScheduleListNextOptionalParams
Returns Promise<Models.JobScheduleListResponse>

Promise<Models.JobScheduleListResponse>
- Defined in operations/jobSchedule.ts:338
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<CloudJobScheduleListResult>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:344
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: JobScheduleListNextOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<CloudJobScheduleListResult>
  
  The callback
Returns void

patch

patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options?: Models.JobSchedulePatchOptionalParams): Promise<Models.JobSchedulePatchResponse>
patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, callback: msRest.ServiceCallback<void>): void
patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options: JobSchedulePatchOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:129
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.

summary

Updates the properties of the specified job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobSchedulePatchParameter: JobSchedulePatchParameter
  
  The parameters for the request.
- Optional options: Models.JobSchedulePatchOptionalParams
Returns Promise<Models.JobSchedulePatchResponse>

Promise<Models.JobSchedulePatchResponse>
- Defined in operations/jobSchedule.ts:135
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobSchedulePatchParameter: JobSchedulePatchParameter
  
  The parameters for the request.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:142
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobSchedulePatchParameter: JobSchedulePatchParameter
  
  The parameters for the request.
- options: JobSchedulePatchOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

terminate

terminate(jobScheduleId: string, options?: Models.JobScheduleTerminateOptionalParams): Promise<Models.JobScheduleTerminateResponse>
terminate(jobScheduleId: string, callback: msRest.ServiceCallback<void>): void
terminate(jobScheduleId: string, options: JobScheduleTerminateOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:253
summary

Terminates a job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to terminates.
- Optional options: Models.JobScheduleTerminateOptionalParams
Returns Promise<Models.JobScheduleTerminateResponse>

Promise<Models.JobScheduleTerminateResponse>
- Defined in operations/jobSchedule.ts:258
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to terminates.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:264
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to terminates.
- options: JobScheduleTerminateOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

update

update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options?: Models.JobScheduleUpdateOptionalParams): Promise<Models.JobScheduleUpdateResponse>
update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, callback: msRest.ServiceCallback<void>): void
update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options: JobScheduleUpdateOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobSchedule.ts:165
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.

summary

Updates the properties of the specified job schedule.

Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobScheduleUpdateParameter: JobScheduleUpdateParameter
  
  The parameters for the request.
- Optional options: Models.JobScheduleUpdateOptionalParams
Returns Promise<Models.JobScheduleUpdateResponse>

Promise<Models.JobScheduleUpdateResponse>
- Defined in operations/jobSchedule.ts:171
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobScheduleUpdateParameter: JobScheduleUpdateParameter
  
  The parameters for the request.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobSchedule.ts:178
Parameters
- jobScheduleId: string
  
  The ID of the job schedule to update.
- jobScheduleUpdateParameter: JobScheduleUpdateParameter
  
  The parameters for the request.
- options: JobScheduleUpdateOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: BatchServiceClientContext

Returns JobSchedule

Methods

add

Parameters

cloudJobSchedule: JobScheduleAddParameter

Optional options: Models.JobScheduleAddOptionalParams

Returns Promise<Models.JobScheduleAddResponse>

Parameters

cloudJobSchedule: JobScheduleAddParameter

callback: msRest.ServiceCallback<void>

Returns void

Parameters

cloudJobSchedule: JobScheduleAddParameter

options: JobScheduleAddOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

deleteMethod

Parameters

jobScheduleId: string

Optional options: Models.JobScheduleDeleteMethodOptionalParams

Returns Promise<Models.JobScheduleDeleteResponse>

Parameters

jobScheduleId: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

jobScheduleId: string

options: JobScheduleDeleteMethodOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

disable

Parameters

jobScheduleId: string

Optional options: Models.JobScheduleDisableOptionalParams

Returns Promise<Models.JobScheduleDisableResponse>

Parameters

jobScheduleId: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

jobScheduleId: string

options: JobScheduleDisableOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

enable

Parameters

jobScheduleId: string

Optional options: Models.JobScheduleEnableOptionalParams

Returns Promise<Models.JobScheduleEnableResponse>

Parameters

jobScheduleId: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

jobScheduleId: string

options: JobScheduleEnableOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

exists

Parameters

jobScheduleId: string

Optional options: Models.JobScheduleExistsOptionalParams

Returns Promise<Models.JobScheduleExistsResponse>

Parameters

jobScheduleId: string

callback: msRest.ServiceCallback<boolean>

Returns void

Parameters

jobScheduleId: string

options: JobScheduleExistsOptionalParams

callback: msRest.ServiceCallback<boolean>

Returns void