TaskAddParameter interface

패키지:

@azure/batch

Batch는 노드에서 복구 작업이 트리거될 때 작업을 다시 시도합니다. 복구 작업의 예로는 비정상 노드가 다시 부팅되거나 호스트 오류로 인해 컴퓨팅 노드가 사라진 경우(제한되지 않음) 등이 있습니다. 복구 작업으로 인한 재시도는 maxTaskRetryCount와 독립적이며 계산되지 않습니다. maxTaskRetryCount가 0이더라도 복구 작업으로 인한 내부 재시도가 발생할 수 있습니다. 이 때문에 모든 작업은 idempotent여야 합니다. 즉, 작업이 손상되거나 중복된 데이터를 유발하지 않고 중단되고 다시 시작되는 것을 허용해야 합니다. 장기 실행 작업의 모범 사례는 일종의 검사점을 사용하는 것입니다.

속성

affinityInfo	Batch 서비스에서 새 작업을 시작할 컴퓨팅 노드를 선택하는 데 사용할 수 있는 지역성 힌트입니다.
applicationPackageReferences	명령줄을 실행하기 전에 Batch 서비스가 컴퓨팅 노드에 배포할 패키지 목록입니다. 애플리케이션 패키지는 작업 디렉터리가 아닌 공유 디렉터리에 다운로드되고 배포됩니다. 따라서 참조된 패키지가 노드에 이미 있고 최신 상태이면 다시 다운로드되지 않습니다. 컴퓨팅 노드의 기존 복사본이 사용됩니다. 예를 들어 패키지가 삭제되었거나 다운로드에 실패하여 참조된 패키지를 설치할 수 없는 경우 작업이 실패합니다.
authenticationTokenSettings	태스크가 Batch 서비스 작업을 수행하는 데 사용할 수 있는 인증 토큰에 대한 설정입니다. 이 속성이 설정된 경우 Batch 서비스는 계정 액세스 키를 요구하지 않고 Batch 서비스 작업을 인증하는 데 사용할 수 있는 인증 토큰을 Task에 제공합니다. 토큰은 AZ_BATCH_AUTHENTICATION_TOKEN 환경 변수를 통해 제공됩니다. 태스크가 토큰을 사용하여 수행할 수 있는 작업은 설정에 따라 달라집니다. 예를 들어 태스크는 작업에 다른 작업을 추가하거나 작업 또는 작업 아래의 다른 작업의 상태를 확인하기 위해 작업 권한을 요청할 수 있습니다.
commandLine	작업의 명령줄입니다. 다중 인스턴스 작업의 경우 기본 작업 및 모든 하위 작업이 조정 명령줄 실행을 완료한 후 명령줄이 기본 작업으로 실행됩니다. 명령줄은 셸에서 실행되지 않으므로 환경 변수 확장과 같은 셸 기능을 활용할 수 없습니다. 이러한 기능을 활용하려면 명령줄에서 셸을 호출해야 합니다(예: Windows에서 "cmd /c MyCommand"를 사용하거나 Linux에서 "/bin/sh -c MyCommand"). 명령줄이 파일 경로를 참조하는 경우 상대 경로(작업 작업 디렉터리를 기준으로)를 사용하거나 Batch 제공 환경 변수(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)를 사용해야 합니다.
constraints	이 작업에 적용되는 실행 제약 조건입니다. 제약 조건을 지정하지 않으면 maxTaskRetryCount는 작업에 지정된 maxTaskRetryCount이고 maxWallClockTime은 무한하며 retentionTime은 7일입니다.
containerSettings	태스크가 실행되는 컨테이너에 대한 설정입니다. 이 작업을 실행할 풀에 containerConfiguration 집합이 있는 경우 이 설정도 설정해야 합니다. 이 작업을 실행할 풀에 containerConfiguration이 설정되어 있지 않으면 설정하면 안 됩니다. 이 옵션을 지정하면 AZ_BATCH_NODE_ROOT_DIR 아래의 모든 디렉터리(노드의 Azure Batch 디렉터리 루트)가 컨테이너에 매핑되고, 모든 작업 환경 변수가 컨테이너에 매핑되고, 작업 명령줄이 컨테이너에서 실행됩니다. AZ_BATCH_NODE_ROOT_DIR 외부 컨테이너에서 생성된 파일은 호스트 디스크에 반영되지 않을 수 있습니다. 즉, Batch 파일 API가 해당 파일에 액세스할 수 없습니다.
dependsOn	이 태스크가 사용하는 작업입니다. 이 작업은 의존하는 모든 작업이 성공적으로 완료될 때까지 예약되지 않습니다. 이러한 작업이 실패하고 재시도 횟수가 소진되는 경우 이 작업은 예약되지 않습니다. Job에 usesTaskDependencies가 true로 설정되어 있지 않고 이 요소가 있으면 오류 코드 TaskDependenciesNotSpecifiedOnJob과 함께 요청이 실패합니다.
displayName	작업의 표시 이름입니다. 표시 이름은 고유할 필요가 없으며 최대 길이 1024까지 유니코드 문자를 포함할 수 있습니다.
environmentSettings	작업에 대한 환경 변수 설정 목록입니다.
exitConditions	태스크가 완료되면 Batch 서비스가 응답하는 방식입니다.
id	작업 내에서 작업을 고유하게 식별하는 문자열입니다. ID는 하이픈과 밑줄을 포함한 영숫자 문자의 조합을 포함할 수 있으며 64자를 초과할 수 없습니다. ID는 대/소문자를 구분하지 않으며 대/소문자를 구분하지 않습니다. 즉, 대/소문자만 다른 작업 내에 두 개의 ID가 없을 수 있습니다.
multiInstanceSettings	태스크가 다중 인스턴스 작업임을 나타내고 다중 인스턴스 작업을 실행하는 방법에 대한 정보를 포함하는 개체입니다.
outputFiles	명령줄을 실행한 후 Batch 서비스가 Compute 노드에서 업로드할 파일 목록입니다. 다중 인스턴스 작업의 경우 파일은 주 작업이 실행되는 컴퓨팅 노드에서만 업로드됩니다.
requiredSlots	태스크를 실행하는 데 필요한 예약 슬롯 수입니다. 기본값은 1입니다. 노드에 사용 가능한 여유 일정 슬롯이 충분한 경우에만 컴퓨팅 노드에서 작업을 실행하도록 예약할 수 있습니다. 다중 인스턴스 작업의 경우 1이어야 합니다.
resourceFiles	명령줄을 실행하기 전에 Batch 서비스가 컴퓨팅 노드에 다운로드할 파일 목록입니다. 다중 인스턴스 작업의 경우 리소스 파일은 주 태스크가 실행되는 컴퓨팅 노드에만 다운로드됩니다. 리소스 파일 목록에 대한 최대 크기가 있습니다. 최대 크기를 초과하면 요청이 실패하고 응답 오류 코드는 RequestEntityTooLarge가 됩니다. 이 경우 ResourceFiles 컬렉션의 크기를 줄여야 합니다. 이 작업은 .zip 파일, 애플리케이션 패키지 또는 Docker 컨테이너를 사용하여 수행할 수 있습니다.
userIdentity	태스크가 실행되는 사용자 ID입니다. 생략하면 태스크가 작업에 고유한 비관리 사용자로 실행됩니다.

속성 세부 정보

affinityInfo

Batch 서비스에서 새 작업을 시작할 컴퓨팅 노드를 선택하는 데 사용할 수 있는 지역성 힌트입니다.

affinityInfo?: AffinityInformation

속성 값

AffinityInformation

applicationPackageReferences

명령줄을 실행하기 전에 Batch 서비스가 컴퓨팅 노드에 배포할 패키지 목록입니다. 애플리케이션 패키지는 작업 디렉터리가 아닌 공유 디렉터리에 다운로드되고 배포됩니다. 따라서 참조된 패키지가 노드에 이미 있고 최신 상태이면 다시 다운로드되지 않습니다. 컴퓨팅 노드의 기존 복사본이 사용됩니다. 예를 들어 패키지가 삭제되었거나 다운로드에 실패하여 참조된 패키지를 설치할 수 없는 경우 작업이 실패합니다.

applicationPackageReferences?: ApplicationPackageReference[]

속성 값

ApplicationPackageReference[]

authenticationTokenSettings

태스크가 Batch 서비스 작업을 수행하는 데 사용할 수 있는 인증 토큰에 대한 설정입니다. 이 속성이 설정된 경우 Batch 서비스는 계정 액세스 키를 요구하지 않고 Batch 서비스 작업을 인증하는 데 사용할 수 있는 인증 토큰을 Task에 제공합니다. 토큰은 AZ_BATCH_AUTHENTICATION_TOKEN 환경 변수를 통해 제공됩니다. 태스크가 토큰을 사용하여 수행할 수 있는 작업은 설정에 따라 달라집니다. 예를 들어 태스크는 작업에 다른 작업을 추가하거나 작업 또는 작업 아래의 다른 작업의 상태를 확인하기 위해 작업 권한을 요청할 수 있습니다.

authenticationTokenSettings?: AuthenticationTokenSettings

속성 값

AuthenticationTokenSettings

commandLine

작업의 명령줄입니다. 다중 인스턴스 작업의 경우 기본 작업 및 모든 하위 작업이 조정 명령줄 실행을 완료한 후 명령줄이 기본 작업으로 실행됩니다. 명령줄은 셸에서 실행되지 않으므로 환경 변수 확장과 같은 셸 기능을 활용할 수 없습니다. 이러한 기능을 활용하려면 명령줄에서 셸을 호출해야 합니다(예: Windows에서 "cmd /c MyCommand"를 사용하거나 Linux에서 "/bin/sh -c MyCommand"). 명령줄이 파일 경로를 참조하는 경우 상대 경로(작업 작업 디렉터리를 기준으로)를 사용하거나 Batch 제공 환경 변수(https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)를 사용해야 합니다.

commandLine: string

속성 값

string

constraints

이 작업에 적용되는 실행 제약 조건입니다. 제약 조건을 지정하지 않으면 maxTaskRetryCount는 작업에 지정된 maxTaskRetryCount이고 maxWallClockTime은 무한하며 retentionTime은 7일입니다.

constraints?: TaskConstraints

속성 값

TaskConstraints

containerSettings

태스크가 실행되는 컨테이너에 대한 설정입니다. 이 작업을 실행할 풀에 containerConfiguration 집합이 있는 경우 이 설정도 설정해야 합니다. 이 작업을 실행할 풀에 containerConfiguration이 설정되어 있지 않으면 설정하면 안 됩니다. 이 옵션을 지정하면 AZ_BATCH_NODE_ROOT_DIR 아래의 모든 디렉터리(노드의 Azure Batch 디렉터리 루트)가 컨테이너에 매핑되고, 모든 작업 환경 변수가 컨테이너에 매핑되고, 작업 명령줄이 컨테이너에서 실행됩니다. AZ_BATCH_NODE_ROOT_DIR 외부 컨테이너에서 생성된 파일은 호스트 디스크에 반영되지 않을 수 있습니다. 즉, Batch 파일 API가 해당 파일에 액세스할 수 없습니다.

containerSettings?: TaskContainerSettings

속성 값

TaskContainerSettings

dependsOn

이 태스크가 사용하는 작업입니다. 이 작업은 의존하는 모든 작업이 성공적으로 완료될 때까지 예약되지 않습니다. 이러한 작업이 실패하고 재시도 횟수가 소진되는 경우 이 작업은 예약되지 않습니다. Job에 usesTaskDependencies가 true로 설정되어 있지 않고 이 요소가 있으면 오류 코드 TaskDependenciesNotSpecifiedOnJob과 함께 요청이 실패합니다.

dependsOn?: TaskDependencies

속성 값

TaskDependencies

displayName

작업의 표시 이름입니다. 표시 이름은 고유할 필요가 없으며 최대 길이 1024까지 유니코드 문자를 포함할 수 있습니다.

displayName?: string

속성 값

string

environmentSettings

작업에 대한 환경 변수 설정 목록입니다.

environmentSettings?: EnvironmentSetting[]

속성 값

EnvironmentSetting[]

exitConditions

태스크가 완료되면 Batch 서비스가 응답하는 방식입니다.

exitConditions?: ExitConditions

속성 값

ExitConditions

id

작업 내에서 작업을 고유하게 식별하는 문자열입니다. ID는 하이픈과 밑줄을 포함한 영숫자 문자의 조합을 포함할 수 있으며 64자를 초과할 수 없습니다. ID는 대/소문자를 구분하지 않으며 대/소문자를 구분하지 않습니다. 즉, 대/소문자만 다른 작업 내에 두 개의 ID가 없을 수 있습니다.

id: string

속성 값

string

multiInstanceSettings

태스크가 다중 인스턴스 작업임을 나타내고 다중 인스턴스 작업을 실행하는 방법에 대한 정보를 포함하는 개체입니다.

multiInstanceSettings?: MultiInstanceSettings

속성 값

MultiInstanceSettings

outputFiles

명령줄을 실행한 후 Batch 서비스가 Compute 노드에서 업로드할 파일 목록입니다. 다중 인스턴스 작업의 경우 파일은 주 작업이 실행되는 컴퓨팅 노드에서만 업로드됩니다.

outputFiles?: OutputFile[]

속성 값

OutputFile[]

requiredSlots

태스크를 실행하는 데 필요한 예약 슬롯 수입니다. 기본값은 1입니다. 노드에 사용 가능한 여유 일정 슬롯이 충분한 경우에만 컴퓨팅 노드에서 작업을 실행하도록 예약할 수 있습니다. 다중 인스턴스 작업의 경우 1이어야 합니다.

requiredSlots?: number

속성 값

number

resourceFiles

명령줄을 실행하기 전에 Batch 서비스가 컴퓨팅 노드에 다운로드할 파일 목록입니다. 다중 인스턴스 작업의 경우 리소스 파일은 주 태스크가 실행되는 컴퓨팅 노드에만 다운로드됩니다. 리소스 파일 목록에 대한 최대 크기가 있습니다. 최대 크기를 초과하면 요청이 실패하고 응답 오류 코드는 RequestEntityTooLarge가 됩니다. 이 경우 ResourceFiles 컬렉션의 크기를 줄여야 합니다. 이 작업은 .zip 파일, 애플리케이션 패키지 또는 Docker 컨테이너를 사용하여 수행할 수 있습니다.

resourceFiles?: ResourceFile[]

속성 값

ResourceFile[]

userIdentity

태스크가 실행되는 사용자 ID입니다. 생략하면 태스크가 작업에 고유한 비관리 사용자로 실행됩니다.

userIdentity?: UserIdentity

속성 값

UserIdentity