Task - Update

참조

서비스:: Batch Service

API 버전:: 2024-07-01.20.0

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

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

선택적 매개 변수:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
jobId	path	True	string	작업을 포함하는 작업의 ID입니다.
taskId	path	True	string	업데이트할 작업의 ID입니다.
api-version	query	True	string	클라이언트 API 버전입니다.
timeout	query		integer int32	서버에서 요청을 처리하는 데 소요할 수 있는 최대 시간(초)입니다. 기본값은 30초입니다. 값이 30보다 크면 기본값이 대신 사용됩니다.

요청 헤더

Media Types: "application/json; odata=minimalmetadata"

Name	형식	Description
client-request-id	string uuid	9C4D50EE-2D56-4CD3-8152-34347DC9F2B0과 같은 장식이 없는 GUID 형식의 호출자 생성 요청 ID입니다.
return-client-request-id	boolean	서버가 응답에서 client-request-id를 반환해야 하는지 여부입니다.
ocp-date	string date-time-rfc1123	요청이 발급된 시간입니다. 클라이언트 라이브러리는 일반적으로 이를 현재 시스템 클록 시간으로 설정합니다. REST API를 직접 호출하는 경우 명시적으로 설정합니다.
If-Match	string	클라이언트에 알려진 리소스의 버전과 연결된 ETag 값입니다. 이 작업은 서비스에 대한 리소스의 현재 ETag가 클라이언트에서 지정한 값과 정확히 일치하는 경우에만 수행됩니다.
If-None-Match	string	클라이언트에 알려진 리소스의 버전과 연결된 ETag 값입니다. 이 작업은 서비스에서 리소스의 현재 ETag가 클라이언트에서 지정한 값과 일치하지 않는 경우에만 수행됩니다.
If-Modified-Since	string date-time-rfc1123	클라이언트에 알려진 리소스의 마지막으로 수정된 시간을 나타내는 타임스탬프입니다. 지정된 시간 이후 서비스의 리소스가 수정된 경우에만 작업이 수행됩니다.
If-Unmodified-Since	string date-time-rfc1123	클라이언트에 알려진 리소스의 마지막으로 수정된 시간을 나타내는 타임스탬프입니다. 지정된 시간 이후 서비스의 리소스가 수정되지 않은 경우에만 작업이 수행됩니다.

요청 본문

Media Types: "application/json; odata=minimalmetadata"

Name	형식	Description
constraints	TaskConstraints	이 작업에 적용되는 제약 조건입니다. 생략하면 작업에 기본 제약 조건이 지정됩니다. 다중 인스턴스 작업의 경우 보존 시간 업데이트는 하위 작업이 아닌 기본 작업에만 적용됩니다.

응답

Name	형식	Description
200 OK		Batch 서비스에 대한 요청이 성공했습니다. 헤더 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다.

Name

형식

Description

200 OK

Batch 서비스에 대한 요청이 성공했습니다.

헤더

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

Batch 서비스의 오류입니다.

보안

azure_auth

Microsoft Entra OAuth 2.0 인증 코드 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

Authorization

형식: apiKey
In(다음 안에): header

예제

Task update

샘플 요청

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

샘플 응답

상태 코드:: 200

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
TaskConstraints	작업에 적용할 실행 제약 조건입니다.
TaskUpdateParameter	작업에 대한 변경 내용 집합입니다.

BatchError

Azure Batch 서비스에서 받은 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정적이며 프로그래밍 방식으로 사용할 수 있습니다.
message	ErrorMessage	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
values	BatchErrorDetail[]	오류에 대한 추가 세부 정보가 포함된 키-값 쌍의 컬렉션입니다.

BatchErrorDetail

Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.

Name	형식	Description
key	string	Value 속성의 의미를 지정하는 식별자입니다.
value	string	오류 응답에 포함된 추가 정보입니다.

ErrorMessage

Azure Batch 오류 응답에서 받은 오류 메시지입니다.

Name	형식	Description
lang	string	오류 메시지의 언어 코드
value	string	메시지의 텍스트입니다.

TaskConstraints

작업에 적용할 실행 제약 조건입니다.

Name	형식	Description
maxTaskRetryCount	integer	작업을 재시도할 수 있는 최대 횟수입니다. Batch 서비스는 종료 코드가 0이 아닌 경우 작업을 다시 시도합니다. 이 값은 특히 0이 아닌 종료 코드로 인해 작업 실행 파일에 대한 재시도 횟수를 제어합니다. Batch 서비스는 작업을 한 번 시도한 다음 이 제한까지 다시 시도할 수 있습니다. 예를 들어 최대 재시도 횟수가 3인 경우 Batch는 태스크를 최대 4번(초기 시도 1회, 재시도 3회)을 시도합니다. 최대 재시도 횟수가 0이면 Batch 서비스는 첫 번째 시도 후에 작업을 다시 시도하지 않습니다. 최대 재시도 횟수가 -1인 경우 Batch 서비스는 제한 없이 작업을 다시 시도합니다. 그러나 시작 작업이나 작업에는 권장되지 않습니다. 기본값은 0(재시도 안 됨)입니다.
maxWallClockTime	string	태스크가 실행될 수 있는 최대 경과 시간(작업 시작 시간부터 측정)입니다. 태스크가 시간 제한 내에서 완료되지 않으면 Batch 서비스에서 작업을 종료합니다. 이 값을 지정하지 않으면 작업이 실행될 수 있는 기간에 대한 시간 제한이 없습니다.
retentionTime	string	실행이 완료된 시점부터 실행된 컴퓨팅 노드에서 작업 디렉터리를 유지하는 최소 시간입니다. 이 시간 후에 Batch 서비스는 작업 디렉터리와 모든 콘텐츠를 삭제할 수 있습니다. 기본값은 7일입니다. 즉, 컴퓨팅 노드가 제거되거나 작업이 삭제되지 않는 한 작업 디렉터리가 7일 동안 유지됩니다.

TaskUpdateParameter

작업에 대한 변경 내용 집합입니다.

Name	형식	Description
constraints	TaskConstraints	이 작업에 적용되는 제약 조건입니다. 생략하면 작업에 기본 제약 조건이 지정됩니다. 다중 인스턴스 작업의 경우 보존 시간 업데이트는 하위 작업이 아닌 기본 작업에만 적용됩니다.

다음을 통해 공유

Task - Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

Authorization

예제

Task update

샘플 요청

샘플 응답

정의

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

추가 리소스