다음을 통해 공유


JobOperations 클래스

JobOperations 작업.

이 클래스를 직접 인스턴스화하지 말고 클라이언트 instance 만들어서 특성으로 연결해야 합니다.

상속
builtins.object
JobOperations

생성자

JobOperations(client, config, serializer, deserializer)

매개 변수

client
필수

서비스 요청에 대한 클라이언트입니다.

config
필수

서비스 클라이언트의 구성입니다.

serializer
필수

개체 모델 직렬 변환기입니다.

deserializer
필수

개체 모델 역직렬 변환기입니다.

변수

api_version

요청에 사용할 API 버전입니다. 상수 값: "2023-05-01.17.0".

메서드

add

지정된 계정에 작업을 추가합니다.

Batch 서비스는 작업의 일부로 수행된 작업을 제어하는 두 가지 방법을 지원합니다. 첫 번째 방법에서 사용자는 작업 관리자 작업을 지정합니다. Batch 서비스는 작업을 시작할 준비가 되면 이 작업을 시작합니다. 작업 관리자 태스크는 작업 API를 사용하여 이 작업에서 실행되는 다른 모든 작업을 제어합니다. 두 번째 방법에서 사용자는 작업 API를 사용하여 활성 작업에서 작업의 실행을 직접 제어합니다. 또한 작업 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 마세요. Microsoft 지원 엔지니어가 액세스할 수 있는 원격 분석 로그에 이런 정보가 나타날 수 있습니다.

delete

작업을 삭제합니다.

작업을 삭제하면 해당 작업의 일부인 모든 작업과 모든 작업 통계도 삭제됩니다. 또한 작업 데이터의 보존 기간도 재정의합니다. 즉, 작업에 컴퓨팅 노드에 계속 유지되는 태스크가 포함된 경우 Batch 서비스는 해당 태스크의 작업 디렉터리와 모든 내용을 삭제합니다. 작업 삭제 요청이 수신되면 Batch 서비스는 작업을 삭제 상태로 설정합니다. 삭제 상태에 있는 작업에 대한 모든 업데이트 작업은 상태 코드 409(충돌)로 인해 실패하고 작업이 삭제되고 있음을 나타내는 추가 정보가 표시됩니다.

disable

지정된 작업을 사용하지 않도록 설정하여 새 작업이 실행되지 않도록 합니다.

Batch 서비스는 즉시 작업을 비활성화 상태로 이동합니다. 그런 다음 Batch는 disableTasks 매개 변수를 사용하여 현재 실행 중인 작업 작업으로 수행할 작업을 결정합니다. 사용 안 함 작업이 완료되고 disableTasks 옵션에 따라 모든 작업을 처리할 때까지 작업은 비활성화 상태로 유지됩니다. 그런 다음 작업이 비활성화된 상태로 이동합니다. 작업에서 활성 상태로 다시 이동할 때까지 새 작업이 시작되지 않습니다. 활성, 비활성화 또는 사용 안 함 이외의 상태에 있는 작업을 사용하지 않도록 설정하려고 하면 상태 코드 409와 함께 요청이 실패합니다.

enable

지정된 작업을 사용하도록 설정하여 새 작업을 실행할 수 있도록 합니다.

이 API를 호출할 때 Batch 서비스는 비활성화된 작업을 사용 상태로 설정합니다. 이 작업이 완료되면 작업이 활성 상태로 이동하고 작업에서 새 작업의 예약이 다시 시작됩니다. Batch 서비스는 작업이 180일 이상 활성 상태로 유지되도록 허용하지 않습니다. 따라서 180일 전에 추가된 활성 작업이 포함된 작업을 사용하도록 설정하면 해당 작업이 실행되지 않습니다.

get

지정된 작업에 대한 정보를 가져옵니다.

get_task_counts

지정된 작업에 대한 작업 수를 가져옵니다.

작업 수는 활성, 실행 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신 상태인 것은 아닙니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다.

list

지정된 계정의 모든 작업을 나열합니다.

list_from_job_schedule

지정된 작업 일정에 따라 만들어진 작업을 나열합니다.

list_preparation_and_release_task_status

작업이 실행된 컴퓨팅 노드에서 지정된 작업에 대한 작업 준비 및 작업 릴리스 태스크의 실행 상태 나열합니다.

이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 태스크 상태 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.

patch

지정된 작업의 속성을 업데이트.

이렇게 하면 요청에 지정된 작업 속성만 바뀝니다. 예를 들어 Job에 제약 조건이 있고 요청이 제약 조건 요소를 지정하지 않는 경우 Job은 기존 제약 조건을 유지합니다.

terminate

지정된 작업을 종료하여 완료됨으로 표시합니다.

작업 종료 요청이 수신되면 Batch 서비스는 작업을 종료 상태로 설정합니다. 그런 다음 Batch 서비스는 작업과 연결된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그런 다음 작업이 완료된 상태로 이동합니다. 활성 상태의 작업에 작업이 있는 경우 활성 상태로 유지됩니다. 작업이 종료되면 새 작업을 추가할 수 없으며 나머지 활성 작업은 예약되지 않습니다.

update

지정된 작업의 속성을 업데이트.

이렇게 하면 작업의 업데이트 가능한 모든 속성이 완전히 바뀝니다. 예를 들어 작업에 연결된 제약 조건이 있고 이 요청으로 제약 조건이 지정되지 않은 경우 Batch 서비스는 기존 제약 조건을 제거합니다.

add

지정된 계정에 작업을 추가합니다.

Batch 서비스는 작업의 일부로 수행된 작업을 제어하는 두 가지 방법을 지원합니다. 첫 번째 방법에서 사용자는 작업 관리자 작업을 지정합니다. Batch 서비스는 작업을 시작할 준비가 되면 이 작업을 시작합니다. 작업 관리자 태스크는 작업 API를 사용하여 이 작업에서 실행되는 다른 모든 작업을 제어합니다. 두 번째 방법에서 사용자는 작업 API를 사용하여 활성 작업에서 작업의 실행을 직접 제어합니다. 또한 작업 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 마세요. Microsoft 지원 엔지니어가 액세스할 수 있는 원격 분석 로그에 이런 정보가 나타날 수 있습니다.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job
JobAddParameter
필수

추가할 작업입니다.

job_add_options
JobAddOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

delete

작업을 삭제합니다.

작업을 삭제하면 해당 작업의 일부인 모든 작업과 모든 작업 통계도 삭제됩니다. 또한 작업 데이터의 보존 기간도 재정의합니다. 즉, 작업에 컴퓨팅 노드에 계속 유지되는 태스크가 포함된 경우 Batch 서비스는 해당 태스크의 작업 디렉터리와 모든 내용을 삭제합니다. 작업 삭제 요청이 수신되면 Batch 서비스는 작업을 삭제 상태로 설정합니다. 삭제 상태에 있는 작업에 대한 모든 업데이트 작업은 상태 코드 409(충돌)로 인해 실패하고 작업이 삭제되고 있음을 나타내는 추가 정보가 표시됩니다.

delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

삭제할 작업의 ID입니다.

job_delete_options
JobDeleteOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

disable

지정된 작업을 사용하지 않도록 설정하여 새 작업이 실행되지 않도록 합니다.

Batch 서비스는 즉시 작업을 비활성화 상태로 이동합니다. 그런 다음 Batch는 disableTasks 매개 변수를 사용하여 현재 실행 중인 작업 작업으로 수행할 작업을 결정합니다. 사용 안 함 작업이 완료되고 disableTasks 옵션에 따라 모든 작업을 처리할 때까지 작업은 비활성화 상태로 유지됩니다. 그런 다음 작업이 비활성화된 상태로 이동합니다. 작업에서 활성 상태로 다시 이동할 때까지 새 작업이 시작되지 않습니다. 활성, 비활성화 또는 사용 안 함 이외의 상태에 있는 작업을 사용하지 않도록 설정하려고 하면 상태 코드 409와 함께 요청이 실패합니다.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

사용하지 않도록 설정할 작업의 ID입니다.

disable_tasks
str 또는 DisableJobOption
필수

가능한 값은 'requeue', 'terminate', 'wait'입니다.

job_disable_options
JobDisableOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

enable

지정된 작업을 사용하도록 설정하여 새 작업을 실행할 수 있도록 합니다.

이 API를 호출할 때 Batch 서비스는 비활성화된 작업을 사용 상태로 설정합니다. 이 작업이 완료되면 작업이 활성 상태로 이동하고 작업에서 새 작업의 예약이 다시 시작됩니다. Batch 서비스는 작업이 180일 이상 활성 상태로 유지되도록 허용하지 않습니다. 따라서 180일 전에 추가된 활성 작업이 포함된 작업을 사용하도록 설정하면 해당 작업이 실행되지 않습니다.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

사용하도록 설정할 작업의 ID입니다.

job_enable_options
JobEnableOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

get

지정된 작업에 대한 정보를 가져옵니다.

get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업의 ID입니다.

job_get_options
JobGetOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

CloudJob 또는 ClientRawResponse if raw=true

반환 형식

예외

get_task_counts

지정된 작업에 대한 작업 수를 가져옵니다.

작업 수는 활성, 실행 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신 상태인 것은 아닙니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다.

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업의 ID입니다.

job_get_task_counts_options
JobGetTaskCountsOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

TaskCountsResult 또는 ClientRawResponse if raw=true

반환 형식

예외

list

지정된 계정의 모든 작업을 나열합니다.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_list_options
JobListOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

CloudJob의 instance 같은 반복기

반환 형식

예외

list_from_job_schedule

지정된 작업 일정에 따라 만들어진 작업을 나열합니다.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_schedule_id
str
필수

작업 목록을 가져올 작업 일정의 ID입니다.

job_list_from_job_schedule_options
JobListFromJobScheduleOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

CloudJob의 instance 같은 반복기

반환 형식

예외

list_preparation_and_release_task_status

작업이 실행된 컴퓨팅 노드에서 지정된 작업에 대한 작업 준비 및 작업 릴리스 태스크의 실행 상태 나열합니다.

이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 태스크 상태 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업의 ID입니다.

job_list_preparation_and_release_task_status_options
JobListPreparationAndReleaseTaskStatusOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

JobPreparationAndReleaseTaskExecutionInformation의 instance 같은 반복기

반환 형식

예외

patch

지정된 작업의 속성을 업데이트.

이렇게 하면 요청에 지정된 작업 속성만 바뀝니다. 예를 들어 Job에 제약 조건이 있고 요청이 제약 조건 요소를 지정하지 않는 경우 Job은 기존 제약 조건을 유지합니다.

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

속성을 업데이트하려는 작업의 ID입니다.

job_patch_parameter
JobPatchParameter
필수

요청에 대한 매개 변수입니다.

job_patch_options
JobPatchOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

terminate

지정된 작업을 종료하여 완료됨으로 표시합니다.

작업 종료 요청이 수신되면 Batch 서비스는 작업을 종료 상태로 설정합니다. 그런 다음 Batch 서비스는 작업과 연결된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그런 다음 작업이 완료된 상태로 이동합니다. 활성 상태의 작업에 작업이 있는 경우 활성 상태로 유지됩니다. 작업이 종료되면 새 작업을 추가할 수 없으며 나머지 활성 작업은 예약되지 않습니다.

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

종료할 작업의 ID입니다.

terminate_reason
str
기본값: None
job_terminate_options
JobTerminateOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

update

지정된 작업의 속성을 업데이트.

이렇게 하면 작업의 업데이트 가능한 모든 속성이 완전히 바뀝니다. 예를 들어 작업에 연결된 제약 조건이 있고 이 요청으로 제약 조건이 지정되지 않은 경우 Batch 서비스는 기존 제약 조건을 제거합니다.

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

속성을 업데이트하려는 작업의 ID입니다.

job_update_parameter
JobUpdateParameter
필수

요청에 대한 매개 변수입니다.

job_update_options
JobUpdateOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

는 역직렬화된 응답과 함께 직접 응답을 반환합니다.

operation_config
필수

작업 구성 재정의.

반환

None 또는 ClientRawResponse if raw=true

반환 형식

None,

예외

특성

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>