Job class
작업을 나타내는 클래스입니다.
생성자
| Job(Batch |
작업을 만듭니다. |
메서드
생성자 세부 정보
Job(BatchServiceClientContext)
작업을 만듭니다.
new Job(client: BatchServiceClientContext)
매개 변수
- client
- BatchServiceClientContext
서비스 클라이언트에 대한 참조입니다.
메서드 세부 정보
add(JobAddParameter, JobAddOptionalParams)
Batch 서비스는 작업의 일부로 수행된 작업을 제어하는 두 가지 방법을 지원합니다. 첫 번째 방법에서 사용자는 작업 관리자 작업을 지정합니다. Batch 서비스는 작업을 시작할 준비가 되면 이 작업을 시작합니다. 작업 관리자 태스크는 작업 API를 사용하여 이 작업에서 실행되는 다른 모든 작업을 제어합니다. 두 번째 방법에서 사용자는 작업 API를 사용하여 활성 작업에서 태스크 실행을 직접 제어합니다. 또한 작업 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 않도록 합니다. 이 정보는 Microsoft 지원 엔지니어가 액세스할 수 있는 원격 분석 로그에 나타날 수 있습니다.
function add(job: JobAddParameter, options?: JobAddOptionalParams): Promise<JobAddResponse>
매개 변수
- job
- JobAddParameter
추가할 작업입니다.
- options
- JobAddOptionalParams
선택적 매개 변수
반환
Promise<JobAddResponse>
Models JobAddResponse 약속<>
add(JobAddParameter, JobAddOptionalParams, ServiceCallback<void>)
function add(job: JobAddParameter, options: JobAddOptionalParams, callback: ServiceCallback<void>)
매개 변수
- job
- JobAddParameter
추가할 작업입니다.
- options
- JobAddOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
add(JobAddParameter, ServiceCallback<void>)
function add(job: JobAddParameter, callback: ServiceCallback<void>)
매개 변수
- job
- JobAddParameter
추가할 작업입니다.
- callback
-
ServiceCallback<void>
콜백
deleteMethod(string, JobDeleteMethodOptionalParams)
또한 작업을 삭제하면 해당 작업의 일부인 모든 작업과 모든 작업 통계가 삭제됩니다. 또한 작업 데이터의 보존 기간도 재정의합니다. 즉, 작업에 컴퓨팅 노드에 계속 유지되는 태스크가 포함된 경우 Batch 서비스는 해당 태스크의 작업 디렉터리와 모든 내용을 삭제합니다. 작업 삭제 요청이 수신되면 Batch 서비스는 작업을 삭제 상태로 설정합니다. 삭제 상태에 있는 작업의 모든 업데이트 작업은 상태 코드 409(충돌)로 인해 실패하고 작업이 삭제되고 있음을 나타내는 추가 정보가 표시됩니다.
function deleteMethod(jobId: string, options?: JobDeleteMethodOptionalParams): Promise<JobDeleteResponse>
매개 변수
- jobId
-
string
삭제할 작업의 ID입니다.
- options
- JobDeleteMethodOptionalParams
선택적 매개 변수
반환
Promise<JobDeleteResponse>
Promise<Models.JobDeleteResponse를 사용합니다.>
deleteMethod(string, JobDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, options: JobDeleteMethodOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
삭제할 작업의 ID입니다.
- options
- JobDeleteMethodOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobId: string, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
삭제할 작업의 ID입니다.
- callback
-
ServiceCallback<void>
콜백
disable(string, DisableJobOption, JobDisableOptionalParams)
Batch 서비스는 즉시 작업을 비활성화 상태로 이동합니다. 그런 다음 Batch는 disableTasks 매개 변수를 사용하여 현재 실행 중인 작업 작업으로 수행할 작업을 결정합니다. 작업은 사용 안 함 작업이 완료되고 disableTasks 옵션에 따라 모든 작업이 처리될 때까지 비활성화 상태로 유지됩니다. 그러면 작업이 비활성화된 상태로 이동합니다. 작업에서 활성 상태로 다시 이동할 때까지 새 작업이 시작되지 않습니다. 활성, 사용 안 함 또는 사용 안 함 이외의 상태에 있는 작업을 사용하지 않도록 설정하려고 하면 상태 코드 409로 요청이 실패합니다.
function disable(jobId: string, disableTasks: DisableJobOption, options?: JobDisableOptionalParams): Promise<JobDisableResponse>
매개 변수
- jobId
-
string
사용하지 않도록 설정할 작업의 ID입니다.
- disableTasks
- DisableJobOption
작업과 연결된 활성 작업으로 수행할 작업입니다. 가능한 값은 'requeue', 'terminate', 'wait'입니다.
- options
- JobDisableOptionalParams
선택적 매개 변수
반환
Promise<JobDisableResponse>
Models JobDisableResponse 약속<>
disable(string, DisableJobOption, JobDisableOptionalParams, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, options: JobDisableOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
사용하지 않도록 설정할 작업의 ID입니다.
- disableTasks
- DisableJobOption
작업과 연결된 활성 작업으로 수행할 작업입니다. 가능한 값은 'requeue', 'terminate', 'wait'입니다.
- options
- JobDisableOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
disable(string, DisableJobOption, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
사용하지 않도록 설정할 작업의 ID입니다.
- disableTasks
- DisableJobOption
작업과 연결된 활성 작업으로 수행할 작업입니다. 가능한 값은 'requeue', 'terminate', 'wait'입니다.
- callback
-
ServiceCallback<void>
콜백
enable(string, JobEnableOptionalParams)
이 API를 호출할 때 Batch 서비스는 비활성화된 작업을 사용 상태로 설정합니다. 이 작업이 완료되면 작업이 활성 상태로 이동하고 작업 아래에 있는 새 작업의 일정이 다시 시작됩니다. Batch 서비스는 작업이 180일 이상 활성 상태로 유지되도록 허용하지 않습니다. 따라서 180일 전에 추가된 활성 작업이 포함된 작업을 사용하도록 설정하면 해당 작업이 실행되지 않습니다.
function enable(jobId: string, options?: JobEnableOptionalParams): Promise<JobEnableResponse>
매개 변수
- jobId
-
string
사용하도록 설정할 작업의 ID입니다.
- options
- JobEnableOptionalParams
선택적 매개 변수
반환
Promise<JobEnableResponse>
Models.JobEnableResponse를 약속합니다<.>
enable(string, JobEnableOptionalParams, ServiceCallback<void>)
function enable(jobId: string, options: JobEnableOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
사용하도록 설정할 작업의 ID입니다.
- options
- JobEnableOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
enable(string, ServiceCallback<void>)
function enable(jobId: string, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
사용하도록 설정할 작업의 ID입니다.
- callback
-
ServiceCallback<void>
콜백
get(string, JobGetOptionalParams)
function get(jobId: string, options?: JobGetOptionalParams): Promise<JobGetResponse>
매개 변수
- jobId
-
string
작업의 ID입니다.
- options
- JobGetOptionalParams
선택적 매개 변수
반환
Promise<JobGetResponse>
Models<약속.JobGetResponse>
get(string, JobGetOptionalParams, ServiceCallback<CloudJob>)
function get(jobId: string, options: JobGetOptionalParams, callback: ServiceCallback<CloudJob>)
매개 변수
- jobId
-
string
작업의 ID입니다.
- options
- JobGetOptionalParams
선택적 매개 변수
- callback
콜백
get(string, ServiceCallback<CloudJob>)
function get(jobId: string, callback: ServiceCallback<CloudJob>)
매개 변수
- jobId
-
string
작업의 ID입니다.
- callback
콜백
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams)
통계는 계정 생성부터 통계의 마지막 업데이트 시간까지 계정에 존재했던 모든 작업에서 집계됩니다. 통계를 즉시 사용할 수 없습니다. Batch 서비스는 통계의 주기적인 롤업을 수행합니다. 일반적인 지연 시간은 약 30분입니다.
function getAllLifetimeStatistics(options?: JobGetAllLifetimeStatisticsOptionalParams): Promise<JobGetAllLifetimeStatisticsResponse>
매개 변수
선택적 매개 변수
반환
Promise<JobGetAllLifetimeStatisticsResponse>
Promise<Models.JobGetAllLifetimeStatisticsResponse 응답>
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams, ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(options: JobGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<JobStatistics>)
매개 변수
선택적 매개 변수
- callback
콜백
getAllLifetimeStatistics(ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<JobStatistics>)
매개 변수
- callback
콜백
getTaskCounts(string, JobGetTaskCountsOptionalParams)
작업 수는 활성, 실행 중 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다.
function getTaskCounts(jobId: string, options?: JobGetTaskCountsOptionalParams): Promise<JobGetTaskCountsResponse>
매개 변수
- jobId
-
string
작업의 ID입니다.
- options
- JobGetTaskCountsOptionalParams
선택적 매개 변수
반환
Promise<JobGetTaskCountsResponse>
Promise<Models.JobGetTaskCountsResponse>
getTaskCounts(string, JobGetTaskCountsOptionalParams, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, options: JobGetTaskCountsOptionalParams, callback: ServiceCallback<TaskCountsResult>)
매개 변수
- jobId
-
string
작업의 ID입니다.
- options
- JobGetTaskCountsOptionalParams
선택적 매개 변수
- callback
콜백
getTaskCounts(string, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, callback: ServiceCallback<TaskCountsResult>)
매개 변수
- jobId
-
string
작업의 ID입니다.
- callback
콜백
list(JobListOptionalParams)
function list(options?: JobListOptionalParams): Promise<JobListResponse>
매개 변수
- options
- JobListOptionalParams
선택적 매개 변수
반환
Promise<JobListResponse>
Models<약속 JobListResponse>
list(JobListOptionalParams, ServiceCallback<CloudJobListResult>)
function list(options: JobListOptionalParams, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- options
- JobListOptionalParams
선택적 매개 변수
- callback
콜백
list(ServiceCallback<CloudJobListResult>)
function list(callback: ServiceCallback<CloudJobListResult>)
매개 변수
- callback
콜백
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams)
function listFromJobSchedule(jobScheduleId: string, options?: JobListFromJobScheduleOptionalParams): Promise<JobListFromJobScheduleResponse>
매개 변수
- jobScheduleId
-
string
작업 목록을 가져올 작업 일정의 ID입니다.
선택적 매개 변수
반환
Promise<JobListFromJobScheduleResponse>
Promise<Models.JobListFromJobScheduleResponse>
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, options: JobListFromJobScheduleOptionalParams, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- jobScheduleId
-
string
작업 목록을 가져올 작업 일정의 ID입니다.
선택적 매개 변수
- callback
콜백
listFromJobSchedule(string, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- jobScheduleId
-
string
작업 목록을 가져올 작업 일정의 ID입니다.
- callback
콜백
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams)
function listFromJobScheduleNext(nextPageLink: string, options?: JobListFromJobScheduleNextOptionalParams): Promise<JobListFromJobScheduleResponse>
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
선택적 매개 변수
반환
Promise<JobListFromJobScheduleResponse>
Promise<Models.JobListFromJobScheduleResponse>
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, options: JobListFromJobScheduleNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
선택적 매개 변수
- callback
콜백
listFromJobScheduleNext(string, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
- callback
콜백
listNext(string, JobListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobListNextOptionalParams): Promise<JobListResponse>
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
- options
- JobListNextOptionalParams
선택적 매개 변수
반환
Promise<JobListResponse>
Models<약속 JobListResponse>
listNext(string, JobListNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, options: JobListNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
- options
- JobListNextOptionalParams
선택적 매개 변수
- callback
콜백
listNext(string, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
- callback
콜백
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams)
이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업 상태를 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.
function listPreparationAndReleaseTaskStatus(jobId: string, options?: JobListPreparationAndReleaseTaskStatusOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>
매개 변수
- jobId
-
string
작업의 ID입니다.
선택적 매개 변수
반환
Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, options: JobListPreparationAndReleaseTaskStatusOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
매개 변수
- jobId
-
string
작업의 ID입니다.
선택적 매개 변수
listPreparationAndReleaseTaskStatus(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
매개 변수
- jobId
-
string
작업의 ID입니다.
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams)
이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업 상태를 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options?: JobListPreparationAndReleaseTaskStatusNextOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
선택적 매개 변수
반환
Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options: JobListPreparationAndReleaseTaskStatusNextOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
선택적 매개 변수
listPreparationAndReleaseTaskStatusNext(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
매개 변수
- nextPageLink
-
string
이전에 성공한 목록 작업 호출의 NextLink입니다.
patch(string, JobPatchParameter, JobPatchOptionalParams)
그러면 요청에 지정된 작업 속성만 바뀝니다. 예를 들어 작업에 제약 조건이 있고 요청이 제약 조건 요소를 지정하지 않는 경우 작업은 기존 제약 조건을 유지합니다.
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options?: JobPatchOptionalParams): Promise<JobPatchResponse>
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobPatchParameter
- JobPatchParameter
요청에 대한 매개 변수입니다.
- options
- JobPatchOptionalParams
선택적 매개 변수
반환
Promise<JobPatchResponse>
Models<약속.JobPatchResponse>
patch(string, JobPatchParameter, JobPatchOptionalParams, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options: JobPatchOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobPatchParameter
- JobPatchParameter
요청에 대한 매개 변수입니다.
- options
- JobPatchOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
patch(string, JobPatchParameter, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobPatchParameter
- JobPatchParameter
요청에 대한 매개 변수입니다.
- callback
-
ServiceCallback<void>
콜백
terminate(string, JobTerminateOptionalParams)
작업 종료 요청을 받으면 Batch 서비스는 작업을 종료 상태로 설정합니다. 그런 다음 Batch 서비스는 작업과 연결된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그런 다음 작업이 완료된 상태로 이동합니다. 작업에서 활성 상태의 태스크가 있는 경우 활성 상태로 유지됩니다. 작업이 종료되면 새 작업을 추가할 수 없으며 나머지 활성 작업은 예약되지 않습니다.
function terminate(jobId: string, options?: JobTerminateOptionalParams): Promise<JobTerminateResponse>
매개 변수
- jobId
-
string
종료할 작업의 ID입니다.
- options
- JobTerminateOptionalParams
선택적 매개 변수
반환
Promise<JobTerminateResponse>
Promise<Models.JobTerminateResponse를 사용합니다.>
terminate(string, JobTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, options: JobTerminateOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
종료할 작업의 ID입니다.
- options
- JobTerminateOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
terminate(string, ServiceCallback<void>)
function terminate(jobId: string, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
종료할 작업의 ID입니다.
- callback
-
ServiceCallback<void>
콜백
update(string, JobUpdateParameter, JobUpdateOptionalParams)
이렇게 하면 작업의 업데이트 가능한 모든 속성이 완전히 바뀝니다. 예를 들어 작업에 연결된 제약 조건이 있고 이 요청으로 제약 조건이 지정되지 않은 경우 Batch 서비스는 기존 제약 조건을 제거합니다.
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options?: JobUpdateOptionalParams): Promise<JobUpdateResponse>
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobUpdateParameter
- JobUpdateParameter
요청에 대한 매개 변수입니다.
- options
- JobUpdateOptionalParams
선택적 매개 변수
반환
Promise<JobUpdateResponse>
Models<약속 JobUpdateResponse>
update(string, JobUpdateParameter, JobUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options: JobUpdateOptionalParams, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobUpdateParameter
- JobUpdateParameter
요청에 대한 매개 변수입니다.
- options
- JobUpdateOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
update(string, JobUpdateParameter, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, callback: ServiceCallback<void>)
매개 변수
- jobId
-
string
속성을 업데이트하려는 작업의 ID입니다.
- jobUpdateParameter
- JobUpdateParameter
요청에 대한 매개 변수입니다.
- callback
-
ServiceCallback<void>
콜백