TaskOperations 클래스

  • 참조

TaskOperations 작업.

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

상속
builtins.object
TaskOperations

생성자

TaskOperations(client, config, serializer, deserializer)

매개 변수

client
필수

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

config
필수

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

serializer
필수

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

deserializer
필수

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

변수

api_version

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

메서드

add

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

완료까지 작업의 최대 수명은 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않은 경우 Batch 서비스에 의해 종료되고 해당 시점에 있던 상태로 남게 됩니다.
add_collection

지정된 작업에 작업 컬렉션을 추가합니다.

각 작업에는 고유한 ID가 있어야 합니다. Batch 서비스는 이 요청에서 태스크가 제출된 순서와 동일한 순서로 각 작업에 대한 결과를 반환하지 않을 수 있습니다. 서버 시간이 초과되거나 요청 중에 연결이 닫힌 경우 요청이 부분적으로 또는 완전히 처리되었거나 전혀 처리되지 않았을 수 있습니다. 이러한 경우 사용자는 요청을 다시 실행해야 합니다. 요청을 다시 발급할 때 오류를 올바르게 처리하는 것은 사용자에게 달려 있습니다. 예를 들어 재시도 중에 동일한 작업 ID를 사용하여 이전 작업이 성공한 경우 재시도에서 예기치 않게 추가 작업을 만들지 않도록 해야 합니다. 응답에 추가하지 못한 작업이 포함된 경우 클라이언트는 요청을 다시 시도할 수 있습니다. 다시 시도에서는 추가하지 못한 작업만 다시 제출하고 첫 번째 시도에서 성공적으로 추가된 작업을 생략하는 것이 가장 효율적입니다. 완료까지 작업의 최대 수명은 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않은 경우 Batch 서비스에 의해 종료되고 해당 시점에 있던 상태로 남게 됩니다.
delete

지정된 작업에서 작업을 삭제합니다.

작업이 삭제되면 실행된 컴퓨팅 노드의 해당 디렉터리에 있는 모든 파일도 삭제됩니다(보존 시간에 관계 없이). 다중 instance 작업의 경우 삭제 작업 작업은 기본 작업에 동기적으로 적용됩니다. 그러면 하위 작업과 해당 파일이 백그라운드에서 비동기적으로 삭제됩니다.
get

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

다중 instance 작업의 경우 affinityId, executionInfo 및 nodeInfo와 같은 정보는 기본 작업을 참조하세요. 목록 하위 작업 API를 사용하여 하위 작업에 대한 정보를 검색합니다.
list

지정된 작업과 연결된 모든 작업을 나열합니다.

다중 instance 작업의 경우 affinityId, executionInfo 및 nodeInfo와 같은 정보는 기본 작업을 참조하세요. 목록 하위 작업 API를 사용하여 하위 작업에 대한 정보를 검색합니다.
list_subtasks

지정된 다중 instance 작업과 연결된 모든 하위 작업을 나열합니다.

Task가 다중 instance 작업이 아니면 빈 컬렉션이 반환됩니다.
reactivate

작업을 다시 활성화하여 재시도 횟수가 소진된 경우에도 다시 실행할 수 있습니다.

다시 활성화하면 최대 재시도 횟수까지 작업을 다시 시도할 수 있습니다. 작업의 상태가 활성으로 변경됩니다. 작업이 더 이상 완료되지 않으므로 다시 활성화한 후에는 이전 종료 코드 또는 실패 정보를 더 이상 사용할 수 없습니다. 작업이 다시 활성화될 때마다 재시도 횟수가 0으로 다시 설정됩니다. 완료되지 않았거나 이전에 성공적으로 완료된 작업에 대해 다시 활성화가 실패합니다(종료 코드가 0임). 또한 작업이 완료되었거나 종료 또는 삭제 중이면 실패합니다.
terminate

지정된 작업을 종료합니다.

작업이 종료되면 완료된 상태로 이동합니다. 다중 instance 작업의 경우 종료 작업 작업은 기본 작업에 동기적으로 적용되고 하위 작업은 백그라운드에서 비동기적으로 종료됩니다.
update

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

add

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

완료까지 작업의 최대 수명은 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않은 경우 Batch 서비스에 의해 종료되고 해당 시점에 있던 상태로 남게 됩니다.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업을 추가할 작업의 ID입니다.

task
TaskAddParameter
필수

추가할 작업입니다.

task_add_options
TaskAddOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,
ClientRawResponse

예외

BatchErrorException

add_collection

지정된 작업에 작업 컬렉션을 추가합니다.

각 작업에는 고유한 ID가 있어야 합니다. Batch 서비스는 이 요청에서 태스크가 제출된 순서와 동일한 순서로 각 작업에 대한 결과를 반환하지 않을 수 있습니다. 서버 시간이 초과되거나 요청 중에 연결이 닫힌 경우 요청이 부분적으로 또는 완전히 처리되었거나 전혀 처리되지 않았을 수 있습니다. 이러한 경우 사용자는 요청을 다시 실행해야 합니다. 요청을 다시 발급할 때 오류를 올바르게 처리하는 것은 사용자에게 달려 있습니다. 예를 들어 재시도 중에 동일한 작업 ID를 사용하여 이전 작업이 성공한 경우 재시도에서 예기치 않게 추가 작업을 만들지 않도록 해야 합니다. 응답에 추가하지 못한 작업이 포함된 경우 클라이언트는 요청을 다시 시도할 수 있습니다. 다시 시도에서는 추가하지 못한 작업만 다시 제출하고 첫 번째 시도에서 성공적으로 추가된 작업을 생략하는 것이 가장 효율적입니다. 완료까지 작업의 최대 수명은 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않은 경우 Batch 서비스에 의해 종료되고 해당 시점에 있던 상태로 남게 됩니다.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

매개 변수

job_id
str
필수

작업 컬렉션을 추가할 작업의 ID입니다.

value
list of TaskAddParameter
필수

추가할 작업의 컬렉션입니다. 이 컬렉션의 직렬화된 총 크기는 4MB 미만이어야 합니다. 4MB보다 큰 경우(예: 각 작업에 100개의 리소스 파일 또는 환경 변수가 있는 경우) 요청은 'RequestBodyTooLarge' 코드로 실패하고 더 적은 수의 작업으로 다시 시도해야 합니다.

task_add_collection_options
TaskAddCollectionOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

threads
int
기본값: 0

작업을 추가할 때 병렬로 사용할 스레드 수입니다. 지정되고 0보다 큰 경우 추가 스레드를 시작하여 요청을 제출하고 완료될 때까지 기다립니다. 그렇지 않으면 기본 스레드에서 add_collection 요청을 순차적으로 제출합니다.

반환

TaskAddCollectionResult 또는 ClientRawResponse raw=true인 경우

반환 형식

TaskAddCollectionResult,
ClientRawResponse

예외

azure.batch.custom.CreateTasksErrorException

delete

지정된 작업에서 작업을 삭제합니다.

작업이 삭제되면 실행된 컴퓨팅 노드의 해당 디렉터리에 있는 모든 파일도 삭제됩니다(보존 시간에 관계 없이). 다중 instance 작업의 경우 삭제 작업 작업은 기본 작업에 동기적으로 적용됩니다. 그러면 하위 작업과 해당 파일이 백그라운드에서 비동기적으로 삭제됩니다.

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

매개 변수

job_id
str
필수

작업을 삭제할 작업의 ID입니다.

task_id
str
필수

삭제할 작업의 ID입니다.

task_delete_options
TaskDeleteOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,
ClientRawResponse

예외

BatchErrorException

get

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

다중 instance 작업의 경우 affinityId, executionInfo 및 nodeInfo와 같은 정보는 기본 작업을 참조하세요. 목록 하위 작업 API를 사용하여 하위 작업에 대한 정보를 검색합니다.

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

매개 변수

job_id
str
필수

작업이 포함된 작업의 ID입니다.

task_id
str
필수

정보를 가져올 작업의 ID입니다.

task_get_options
TaskGetOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

CloudTask 또는 ClientRawResponse if raw=true

반환 형식

CloudTask,
ClientRawResponse

예외

BatchErrorException

list

지정된 작업과 연결된 모든 작업을 나열합니다.

다중 instance 작업의 경우 affinityId, executionInfo 및 nodeInfo와 같은 정보는 기본 작업을 참조하세요. 목록 하위 작업 API를 사용하여 하위 작업에 대한 정보를 검색합니다.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업의 ID입니다.

task_list_options
TaskListOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

CloudTask의 instance 같은 반복기

반환 형식

CloudTaskPaged[CloudTask]

예외

BatchErrorException

list_subtasks

지정된 다중 instance 작업과 연결된 모든 하위 작업을 나열합니다.

Task가 다중 instance 작업이 아니면 빈 컬렉션이 반환됩니다.

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업의 ID입니다.

task_id
str
필수

작업의 ID입니다.

task_list_subtasks_options
TaskListSubtasksOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

CloudTaskListSubtasksResult 또는 ClientRawResponse if raw=true

반환 형식

CloudTaskListSubtasksResult,
ClientRawResponse

예외

BatchErrorException

reactivate

작업을 다시 활성화하여 재시도 횟수가 소진된 경우에도 다시 실행할 수 있습니다.

다시 활성화하면 최대 재시도 횟수까지 작업을 다시 시도할 수 있습니다. 작업의 상태가 활성으로 변경됩니다. 작업이 더 이상 완료되지 않으므로 다시 활성화한 후에는 이전 종료 코드 또는 실패 정보를 더 이상 사용할 수 없습니다. 작업이 다시 활성화될 때마다 재시도 횟수가 0으로 다시 설정됩니다. 완료되지 않았거나 이전에 성공적으로 완료된 작업에 대해 다시 활성화가 실패합니다(종료 코드가 0임). 또한 작업이 완료되었거나 종료 또는 삭제 중이면 실패합니다.

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업이 포함된 작업의 ID입니다.

task_id
str
필수

다시 활성화할 작업의 ID입니다.

task_reactivate_options
TaskReactivateOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,
ClientRawResponse

예외

BatchErrorException

terminate

지정된 작업을 종료합니다.

작업이 종료되면 완료된 상태로 이동합니다. 다중 instance 작업의 경우 종료 작업 작업은 기본 작업에 동기적으로 적용되고 하위 작업은 백그라운드에서 비동기적으로 종료됩니다.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업이 포함된 작업의 ID입니다.

task_id
str
필수

종료할 작업의 ID입니다.

task_terminate_options
TaskTerminateOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,
ClientRawResponse

예외

BatchErrorException

update

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

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

job_id
str
필수

작업이 포함된 작업의 ID입니다.

task_id
str
필수

업데이트할 작업의 ID입니다.

constraints
TaskConstraints
기본값: None

이 작업에 적용되는 제약 조건입니다. 생략하면 작업에 기본 제약 조건이 지정됩니다. 다중 instance 작업의 경우 보존 시간 업데이트는 하위 작업이 아닌 기본 작업에만 적용됩니다.

task_update_options
TaskUpdateOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,
ClientRawResponse

예외

BatchErrorException

특성

models 

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