JobSchedule class
代表 JobSchedule 的類別。
建構函式
| Job |
建立 JobSchedule。 |
方法
建構函式詳細資料
JobSchedule(BatchServiceClientContext)
建立 JobSchedule。
new JobSchedule(client: BatchServiceClientContext)參數
- client
- BatchServiceClientContext
服務客戶端的參考。
方法詳細資料
add(JobScheduleAddParameter, JobScheduleAddOptionalParams)
function add(cloudJobSchedule: JobScheduleAddParameter, options?: JobScheduleAddOptionalParams): Promise<JobScheduleAddResponse>參數
- cloudJobSchedule
- JobScheduleAddParameter
要加入的作業排程。
- options
- JobScheduleAddOptionalParams
選擇性參數
傳回
Promise<JobScheduleAddResponse>
承諾<模型.JobScheduleAddResponse>
add(JobScheduleAddParameter, JobScheduleAddOptionalParams, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, options: JobScheduleAddOptionalParams, callback: ServiceCallback<void>)參數
- cloudJobSchedule
- JobScheduleAddParameter
要加入的作業排程。
- options
- JobScheduleAddOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
add(JobScheduleAddParameter, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, callback: ServiceCallback<void>)參數
- cloudJobSchedule
- JobScheduleAddParameter
要加入的作業排程。
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, JobScheduleDeleteMethodOptionalParams)
當您刪除作業排程時，這也會刪除該排程下的所有作業和工作。 刪除 [工作] 時，也會刪除計算節點上其工作目錄中的所有檔案（會忽略保留期間）。 一旦刪除作業排程，作業排程統計數據仍計入帳戶存留期統計數據，就無法再存取作業排程統計數據。
function deleteMethod(jobScheduleId: string, options?: JobScheduleDeleteMethodOptionalParams): Promise<JobScheduleDeleteResponse>參數
- jobScheduleId
-
string
要刪除之作業排程的識別碼。
選擇性參數
傳回
Promise<JobScheduleDeleteResponse>
承諾<模型.JobScheduleDeleteResponse>
deleteMethod(string, JobScheduleDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, options: JobScheduleDeleteMethodOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要刪除之作業排程的識別碼。
選擇性參數
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要刪除之作業排程的識別碼。
- callback
-
ServiceCallback<void>
回呼
disable(string, JobScheduleDisableOptionalParams)
在再次啟用作業排程之前，將不會建立任何新的作業。
function disable(jobScheduleId: string, options?: JobScheduleDisableOptionalParams): Promise<JobScheduleDisableResponse>參數
- jobScheduleId
-
string
要停用之作業排程的標識碼。
- options
- JobScheduleDisableOptionalParams
選擇性參數
傳回
Promise<JobScheduleDisableResponse>
承諾<Models.JobScheduleDisableResponse>
disable(string, JobScheduleDisableOptionalParams, ServiceCallback<void>)
function disable(jobScheduleId: string, options: JobScheduleDisableOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要停用之作業排程的標識碼。
- options
- JobScheduleDisableOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
disable(string, ServiceCallback<void>)
function disable(jobScheduleId: string, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要停用之作業排程的標識碼。
- callback
-
ServiceCallback<void>
回呼
enable(string, JobScheduleEnableOptionalParams)
function enable(jobScheduleId: string, options?: JobScheduleEnableOptionalParams): Promise<JobScheduleEnableResponse>參數
- jobScheduleId
-
string
要啟用之作業排程的標識碼。
- options
- JobScheduleEnableOptionalParams
選擇性參數
傳回
Promise<JobScheduleEnableResponse>
承諾<Models.JobScheduleEnableResponse>
enable(string, JobScheduleEnableOptionalParams, ServiceCallback<void>)
function enable(jobScheduleId: string, options: JobScheduleEnableOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要啟用之作業排程的標識碼。
- options
- JobScheduleEnableOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
enable(string, ServiceCallback<void>)
function enable(jobScheduleId: string, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要啟用之作業排程的標識碼。
- callback
-
ServiceCallback<void>
回呼
exists(string, JobScheduleExistsOptionalParams)
function exists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<JobScheduleExistsResponse>參數
- jobScheduleId
-
string
您要檢查之作業排程的識別碼。
- options
- JobScheduleExistsOptionalParams
選擇性參數
傳回
Promise<JobScheduleExistsResponse>
承諾<Models.JobScheduleExistsResponse>
exists(string, JobScheduleExistsOptionalParams, ServiceCallback<boolean>)
function exists(jobScheduleId: string, options: JobScheduleExistsOptionalParams, callback: ServiceCallback<boolean>)參數
- jobScheduleId
-
string
您要檢查之作業排程的識別碼。
- options
- JobScheduleExistsOptionalParams
選擇性參數
- callback
-
ServiceCallback<boolean>
回呼
exists(string, ServiceCallback<boolean>)
function exists(jobScheduleId: string, callback: ServiceCallback<boolean>)參數
- jobScheduleId
-
string
您要檢查之作業排程的識別碼。
- callback
-
ServiceCallback<boolean>
回呼
get(string, JobScheduleGetOptionalParams)
取得指定之作業排程的相關信息。
function get(jobScheduleId: string, options?: JobScheduleGetOptionalParams): Promise<JobScheduleGetResponse>參數
- jobScheduleId
-
string
要取得之作業排程的標識碼。
- options
- JobScheduleGetOptionalParams
選擇性參數
傳回
Promise<JobScheduleGetResponse>
承諾<Models.JobScheduleGetResponse>
get(string, JobScheduleGetOptionalParams, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, options: JobScheduleGetOptionalParams, callback: ServiceCallback<CloudJobSchedule>)參數
- jobScheduleId
-
string
要取得之作業排程的標識碼。
- options
- JobScheduleGetOptionalParams
選擇性參數
- callback
回呼
get(string, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, callback: ServiceCallback<CloudJobSchedule>)參數
- jobScheduleId
-
string
要取得之作業排程的標識碼。
- callback
回呼
list(JobScheduleListOptionalParams)
function list(options?: JobScheduleListOptionalParams): Promise<JobScheduleListResponse>參數
- options
- JobScheduleListOptionalParams
選擇性參數
傳回
Promise<JobScheduleListResponse>
承諾<Models.JobScheduleListResponse>
list(JobScheduleListOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function list(options: JobScheduleListOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)參數
- options
- JobScheduleListOptionalParams
選擇性參數
- callback
回呼
list(ServiceCallback<CloudJobScheduleListResult>)
function list(callback: ServiceCallback<CloudJobScheduleListResult>)參數
- callback
回呼
listNext(string, JobScheduleListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobScheduleListNextOptionalParams): Promise<JobScheduleListResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
傳回
Promise<JobScheduleListResponse>
承諾<Models.JobScheduleListResponse>
listNext(string, JobScheduleListNextOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, options: JobScheduleListNextOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
- callback
回呼
listNext(string, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobScheduleListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams)
這隻會取代要求中指定的作業排程屬性。 例如，如果未使用此要求指定 schedule 屬性，Batch 服務會保留現有的排程。 作業排程的變更只會影響更新發生之後排程所建立的作業;目前執行的作業不會受到影響。
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options?: JobSchedulePatchOptionalParams): Promise<JobSchedulePatchResponse>參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求的參數。
- options
- JobSchedulePatchOptionalParams
選擇性參數
傳回
Promise<JobSchedulePatchResponse>
承諾<Models.JobSchedulePatchResponse>
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options: JobSchedulePatchOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求的參數。
- options
- JobSchedulePatchOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
patch(string, JobSchedulePatchParameter, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
terminate(string, JobScheduleTerminateOptionalParams)
function terminate(jobScheduleId: string, options?: JobScheduleTerminateOptionalParams): Promise<JobScheduleTerminateResponse>參數
- jobScheduleId
-
string
要終止之作業排程的標識碼。
選擇性參數
傳回
Promise<JobScheduleTerminateResponse>
承諾<Models.JobScheduleTerminateResponse>
terminate(string, JobScheduleTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobScheduleId: string, options: JobScheduleTerminateOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要終止之作業排程的標識碼。
選擇性參數
- callback
-
ServiceCallback<void>
回呼
terminate(string, ServiceCallback<void>)
function terminate(jobScheduleId: string, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要終止之作業排程的標識碼。
- callback
-
ServiceCallback<void>
回呼
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams)
這會完全取代作業排程的所有可更新屬性。 例如，如果未使用此要求指定 schedule 屬性，Batch 服務將會移除現有的排程。 作業排程的變更只會影響更新發生之後排程所建立的作業;目前執行的作業不會受到影響。
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options?: JobScheduleUpdateOptionalParams): Promise<JobScheduleUpdateResponse>參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求的參數。
- options
- JobScheduleUpdateOptionalParams
選擇性參數
傳回
Promise<JobScheduleUpdateResponse>
承諾<Models.JobScheduleUpdateResponse>
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options: JobScheduleUpdateOptionalParams, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求的參數。
- options
- JobScheduleUpdateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
update(string, JobScheduleUpdateParameter, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, callback: ServiceCallback<void>)參數
- jobScheduleId
-
string
要更新之作業排程的標識碼。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼