BatchClient class
Client class for accessing Azure Batch service.
메서드
| create |
배치 서비스는 작업의 일부로 수행된 작업을 제어하는 두 가지 방식을 지원합니다. 첫 번째 방법에서는 사용자가 작업 관리자 작업을 지정합니다. 배치 서비스는 작업을 시작할 준비가 되면 이 작업을 실행합니다. 작업 관리자 작업은 작업 API를 사용하여 이 작업 하에서 실행되는 모든 다른 작업을 제어합니다. 두 번째 방법에서는 사용자가 작업 API를 사용하여 활성 작업 내에서 작업 실행을 직접 제어합니다. 또한 참고: 잡 이름을 지정할 때는 사용자 이름이나 비밀 프로젝트 이름과 같은 민감한 정보를 포함하지 마세요. 이 정보는 Microsoft 지원 엔지니어가 접근할 수 있는 텔레메트리 로그에 나타날 수 있습니다. |
| create |
지정된 계정에 작업 일정을 생성합니다. |
| create |
컴퓨트 노드가 유휴 상태이거나 실행 중일 때만 사용자 계정을 추가할 수 있습니다. 컴퓨트 노드에 원격으로 로그인하기 전에 SSH와 RDP용 액세스 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요. |
| create |
풀 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 않도록 합니다. 이 정보는 Microsoft 지원 엔지니어가 접근할 수 있는 텔레메트리 로그에 나타날 수 있습니다. |
| create |
과제의 최대 수명은 추가부터 완료까지 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않으면 배치 서비스에 의해 종료되어 그 시점의 상태로 유지됩니다. |
| create |
각 작업은 고유한 ID를 가져야 한다는 점에 유의하세요. 배치 서비스는 이 요청에서 제출된 작업과 동일한 순서로 각 작업의 결과를 반환할 수 없습니다. 서버가 타임아웃되거나 요청 중 연결이 종료되면 요청이 부분적으로 또는 완전히 처리되었거나 아예 처리되지 않았을 수도 있습니다. 이런 경우에는 사용자가 다시 요청을 발행해야 합니다. 요청을 재발행할 때 실패를 올바르게 처리하는 것은 사용자의 몫임을 유의하세요. 예를 들어, 재시도 시 동일한 작업 ID를 사용해야 하는데, 이는 이전 작업이 성공했을 때 추가 작업이 예상치 못하게 생성되지 않도록 해야 합니다. 응답에 추가에 실패한 작업(Task)이 포함되어 있다면, 클라이언트는 요청을 다시 시도할 수 있습니다. 재시도 시에는 추가에 실패한 작업만 재제출하고, 첫 시도에서 성공적으로 추가된 작업은 생략하는 것이 가장 효율적입니다. 과제의 최대 수명은 추가부터 완료까지 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않으면 배치 서비스에 의해 종료되어 그 시점의 상태로 유지됩니다. |
| deallocate |
컴퓨팅 노드가 유휴 상태이거나 실행 중인 경우에만 할당을 취소할 수 있습니다. |
| delete |
잡을 삭제하면 그 잡의 모든 작업과 모든 잡 통계가 삭제됩니다. 이 기능은 작업 데이터의 보존 기간도 무시합니다; 즉, 작업에 컴퓨트 노드에 남아 있는 작업이 포함되어 있다면, 배치 서비스는 해당 작업의 작업 디렉터리와 모든 내용을 삭제합니다. Delete Job 요청을 받으면 배치 서비스는 해당 작업을 삭제 상태로 설정합니다. 삭제 상태인 작업에 대한 모든 업데이트 작업은 상태 코드 409(충돌)로 실패하며, 추가 정보가 해당 작업이 삭제되고 있음을 나타냅니다. |
| delete |
작업 일정을 삭제하면 해당 일정에 따라 모든 작업 및 작업도 삭제됩니다. 작업이 삭제되면 컴퓨팅 노드의 작업 디렉터리에 있는 모든 파일도 삭제됩니다(보존 기간은 무시됨). 작업 일정 통계는 작업 일정이 삭제된 후에도 더 이상 액세스할 수 없지만 계정 수명 통계로 계산됩니다. |
| delete |
컴퓨팅 노드에서 지정된 파일을 삭제합니다. |
| delete |
사용자 계정이 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드로 삭제할 수 있습니다. 컴퓨트 노드에 원격으로 로그인하기 전에 SSH와 RDP용 액세스 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요. |
| delete |
풀을 삭제하도록 요청하면 다음 작업이 발생합니다. 풀 상태는 삭제로 설정됩니다. 풀에서 진행 중인 크기 조정 작업이 중지됩니다. Batch 서비스는 풀 크기를 컴퓨팅 노드 0으로 조정하기 시작합니다. 기존 컴퓨팅 노드에서 실행되는 모든 태스크는 종료되고 다시 큐에 추가됩니다(기본 다시 큐 옵션으로 풀 크기 조정 작업이 요청된 것처럼). 마지막으로 풀이 시스템에서 제거됩니다. 실행 중인 작업은 다시 큐에 추가되므로 사용자는 작업을 업데이트하여 다른 풀을 대상으로 하여 이러한 작업을 다시 실행할 수 있습니다. 그러면 새 풀에서 작업을 실행할 수 있습니다. 다시 큐에 넣기 동작을 재정의하려면 풀을 삭제하기 전에 크기 조정 풀을 명시적으로 호출하여 풀 크기를 0으로 줄여야 합니다. 삭제 상태에서 풀에서 업데이트, 패치 또는 삭제 API를 호출하는 경우 오류 코드 PoolBeingDeleted가 있는 HTTP 상태 코드 409로 실패합니다. |
| delete |
작업이 삭제되면 작업이 실행된 컴퓨팅 노드의 해당 디렉터리에 있는 모든 파일도 삭제됩니다(보존 시간에 관계 없이). 다중 인스턴스 작업의 경우 작업 삭제 작업이 주 작업에 동기적으로 적용됩니다. 그런 다음 하위 작업과 해당 파일이 백그라운드에서 비동기적으로 삭제됩니다. |
| delete |
태스크가 실행된 컴퓨팅 노드에서 지정된 작업 파일을 삭제합니다. |
| disable |
배치 서비스는 즉시 작업을 비활성화 상태로 전환합니다. 배치는 그 후 disableTasks 매개변수를 사용하여 작업의 현재 실행 중인 작업들을 어떻게 처리할지 결정합니다. 작업은 비활성화 작업이 완료되고 모든 작업이 disableTasks 옵션에 따라 처리될 때까지 비활성화 상태로 유지됩니다; 그 후 직업은 장애 상태로 이동합니다. 작업이 다시 활성 상태로 전환될 때까지 새로운 작업은 시작되지 않습니다. 활성화, 비활성화, 비활성화 이외의 상태에 있는 작업을 비활성화하려 하면 상태 코드 409와 함께 요청이 실패합니다. |
| disable |
작업 일정을 다시 사용하도록 설정할 때까지 새 작업이 만들어지지 않습니다. |
| disable |
현재 스케줄링 상태가 활성화된 경우에만 컴퓨트 노드에서 작업 스케줄링을 비활성화할 수 있습니다. |
| disable |
풀에 대한 자동 크기 조정을 사용하지 않도록 설정합니다. |
| enable |
이 API를 호출하면 배치 서비스가 비활성화된 작업을 활성화 상태로 설정합니다. 이 작업이 완료되면 작업은 활성 상태로 전환되고, 작업 하에 새로운 작업 스케줄링이 재개됩니다. 배치 서비스는 태스크가 활성 상태에 180일 이상 머무르는 것을 허용하지 않습니다. 따라서 180일 이상 전에 추가된 활성 작업이 포함된 작업을 활성화하면, 해당 작업들은 실행되지 않습니다. |
| enable |
작업 일정을 사용하도록 설정합니다. |
| enable |
컴퓨트 노드의 현재 스케줄링 상태가 비활성화된 경우에만 작업 스케줄링을 활성화할 수 있습니다 |
| enable |
풀에서 크기 조정 작업이 진행 중인 경우 풀에서 자동 크기 조정을 사용하도록 설정할 수 없습니다. 풀의 자동 크기 조정이 현재 비활성화된 경우 요청의 일부로 유효한 자동 크기 조정 수식을 지정해야 합니다. 풀의 자동 크기 조정을 이미 사용하도록 설정한 경우 새 자동 크기 조정 수식 및/또는 새 평가 간격을 지정할 수 있습니다. 동일한 풀에 대해 30초마다 두 번 이상 이 API를 호출할 수 없습니다. |
| evaluate |
이 API는 풀에 수식을 적용하지 않고 결과를 반환하기 때문에 주로 자동 크기 조정 수식의 유효성을 검사하기 위한 것입니다. 수식을 평가하려면 풀에 자동 크기 조정을 사용하도록 설정해야 합니다. |
| get |
이 작업은 컴퓨트 노드에서 사용 가능한 애플리케이션과 버전만 반환합니다; 즉, 패키지 참조에서 사용할 수 있습니다. 아직 컴퓨트 노드에 제공되지 않은 애플리케이션 및 버전에 대한 관리자 정보는 Azure 포털 또는 Azure 리소스 매니저 API를 사용하세요. |
| get |
지정된 직무에 대한 정보를 얻습니다. |
| get |
지정된 작업 일정에 대한 정보를 얻습니다. |
| get |
작업 수는 활성, 실행 중 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다. |
| get |
지정된 컴퓨팅 노드에 대한 정보를 가져옵니다. |
| get |
지정된 컴퓨트 노드 확장에 대한 정보를 얻습니다. |
| get |
지정된 컴퓨트 노드 파일의 내용을 반환합니다. |
| get |
지정된 컴퓨팅 노드 파일의 속성을 가져옵니다. |
| get |
원격 로그인 설정을 통해 컴퓨트 노드에 원격으로 로그인하기 전에, 컴퓨트 노드에서 사용자 계정을 만들고 SSH와 RDP용 접근 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요. |
| get |
지정된 풀에 대한 정보를 가져옵니다. |
| get |
다중 인스턴스 작업의 경우, affinityId, executionInfo, nodeInfo와 같은 정보는 기본 작업을 가리킵니다. 하위 작업 정보를 가져오기 위해 List 하위 작업 API를 사용하세요. |
| get |
지정된 작업 파일의 내용을 반환합니다. |
| get |
지정한 작업 파일의 속성을 가져옵니다. |
| job |
지정된 작업 일정이 존재하는지 확인합니다. |
| list |
이 작업은 컴퓨트 노드에서 사용 가능한 애플리케이션과 버전만 반환합니다; 즉, 패키지 참조에서 사용할 수 있습니다. 아직 컴퓨트 노드에 제공되지 않은 애플리케이션 및 버전에 대한 관리자 정보는 Azure 포털 또는 Azure 리소스 매니저 API를 사용하세요. |
| list |
이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업 상태를 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다. |
| list |
지정된 계정에 있는 모든 직무를 나열합니다. |
| list |
지정된 계정 내 모든 작업 일정을 나열합니다. |
| list |
지정된 작업 일정 하에 생성된 작업들을 나열합니다. |
| list |
지정된 풀 내 컴퓨트 노드 확장을 나열합니다. |
| list |
지정된 컴퓨팅 노드의 작업 디렉터리에 있는 모든 파일을 나열합니다. |
| list |
지정된 풀의 컴퓨팅 노드를 나열합니다. |
| list |
풀별로 그룹화된 각 상태의 컴퓨팅 노드 수를 가져옵니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 노드 수가 필요한 경우 목록 쿼리를 사용합니다. |
| list |
지정된 계정의 모든 풀을 나열합니다. |
| list |
poolId를 포함하여 $filter 절을 지정하지 않으면 반환된 집계 간격의 시간 범위에서 계정에 존재했던 모든 풀이 응답에 포함됩니다. startTime 또는 endTime을 포함하여 $filter 절을 지정하지 않으면 이러한 필터는 기본적으로 현재 사용 가능한 마지막 집계 간격의 시작 및 종료 시간으로 설정됩니다. 즉, 마지막 집계 간격만 반환됩니다. |
| list |
작업이 다중 인스턴스 작업이 아니면 빈 컬렉션이 반환됩니다. |
| list |
Azure Batch 서비스에서 지원하는 모든 Virtual Machine 이미지를 나열합니다. |
| list |
컴퓨팅 노드의 작업 디렉터리에 있는 파일을 나열합니다. |
| list |
다중 인스턴스 작업의 경우, affinityId, executionInfo, nodeInfo와 같은 정보는 기본 작업을 가리킵니다. 하위 작업 정보를 가져오기 위해 List 하위 작업 API를 사용하세요. |
| pool |
풀의 기본 속성을 얻습니다. |
| reactivate |
다시 활성화하면 최대 재시도 횟수까지 작업을 다시 시도할 수 있습니다. 작업의 상태가 활성 상태로 변경됩니다. 작업이 더 이상 완료되지 않으므로 다시 활성화한 후에는 이전 종료 코드 또는 오류 정보를 더 이상 사용할 수 없습니다. 작업이 다시 활성화될 때마다 재시도 횟수가 0으로 다시 설정됩니다. 완료되지 않았거나 이전에 성공적으로 완료된 작업에 대해 다시 활성화가 실패합니다(종료 코드가 0임). 또한 작업이 완료되었거나 종료 또는 삭제 중이면 실패합니다. |
| reboot |
컴퓨팅 노드가 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드를 다시 시작할 수 있습니다. |
| reimage |
운영 체제가 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드에 다시 설치할 수 있습니다. 이 API는 클라우드 서비스 구성 속성으로 생성된 풀에서만 호출할 수 있습니다. |
| remove |
이 작업은 풀의 할당 상태가 안정적인 경우에만 실행할 수 있습니다. 이 작업이 실행되면 할당 상태가 안정에서 크기 조정으로 변경됩니다. 각 요청은 최대 100개의 노드를 제거할 수 있습니다. |
| replace |
이로 인해 작업의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 작업에 제약 조건이 연결되어 있고 이 요청에 제약 조건이 명시되어 있지 않다면, 배치 서비스는 기존의 제약 조건을 제거합니다. |
| replace |
이로 인해 작업 일정의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 이 요청에 스케줄이 지정되어 있지 않으면 배치 서비스는 기존 스케줄을 제거합니다. 작업 일정의 변경은 업데이트 이후 일정에 의해 생성된 작업에만 영향을 미치며; 현재 운영 중인 일자리는 영향을 받지 않습니다. |
| replace |
이 연산은 계정의 모든 업데이트 가능한 속성을 대체합니다. 예를 들어, expiryTime 요소가 지정되지 않으면 현재 값이 기본 값으로 대체되며, 수정되지 않은 상태로 남겨두지 않습니다. 컴퓨트 노드의 사용자 계정을 업데이트할 수 있는 것은 유휴 상태이거나 실행 중일 때뿐입니다. |
| replace |
이로써 풀의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 풀에 StartTask가 연결되어 있고 이 요청에 StartTask가 지정되어 있지 않으면, 배치 서비스는 기존의 StartTask를 제거합니다. |
| replace |
지정된 작업의 속성을 업데이트합니다. |
| resize |
할당 상태가 안정적인 경우에만 풀의 크기를 조정할 수 있습니다. 풀의 크기가 이미 조정된 경우 상태 코드 409로 요청이 실패합니다. 풀의 크기를 조정하면 풀의 할당 상태가 안정적에서 크기 조정으로 변경됩니다. 자동 크기 조정을 위해 구성된 풀의 크기를 조정할 수 없습니다. 이 작업을 수행하려고 하면 Batch 서비스에서 오류 409를 반환합니다. 풀의 크기를 아래쪽으로 조정하면 Batch 서비스에서 제거할 컴퓨팅 노드를 선택합니다. 특정 컴퓨팅 노드를 제거하려면 풀을 사용하여 컴퓨팅 노드 API를 제거합니다. |
| start |
컴퓨트 노드는 할당이 해제된 경우에만 시작할 수 있습니다. |
| stop |
이 경우 풀을 크기 조정 전 상태로 복원하지 않으며, 추가 변경만 중단하고 풀은 현재 상태를 유지합니다. 정지 후 풀은 정지 연산 시 유지되던 컴퓨트 노드 수로 안정화됩니다. 정지 작업 동안 풀 할당 상태는 먼저 정지, 그다음 정상으로 바뀝니다. 크기 조정 연산은 명시적인 크기 조절 풀 요청일 필요는 없습니다; 이 API는 풀이 생성될 때 초기 크기 조정을 중단하는 데도 사용할 수 있습니다. |
| terminate |
Terminate Job 요청이 접수되면, 배치 서비스는 Job을 종료 상태로 설정합니다. 배치 서비스는 작업과 관련된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그 후 작업은 완료 상태로 전환됩니다. 작업 중에 활성 상태에 있는 작업이 있다면, 그 작업들은 활성 상태로 유지됩니다. 작업이 종료되면 새로운 작업을 추가할 수 없으며, 남아 있는 활성 작업도 스케줄링되지 않습니다. |
| terminate |
작업 일정을 종료합니다. |
| terminate |
작업이 종료되면 완료된 상태로 이동합니다. 다중 인스턴스 작업의 경우 종료 작업 작업은 주 작업에 동기적으로 적용됩니다. 그런 다음 백그라운드에서 하위 작업이 비동기적으로 종료됩니다. |
| update |
이는 요청에 명시된 작업 속성만 대체합니다. 예를 들어, 작업에 제약 조건이 있고 요청이 제약 요소를 지정하지 않는다면, 작업은 기존 제약 조건을 유지합니다. |
| update |
이는 요청에 명시된 작업 일정 속성만을 대체합니다. 예를 들어, 이 요청에 스케줄(schedule) 속성이 지정되어 있지 않으면, 배치 서비스는 기존 스케줄을 유지합니다. 작업 일정의 변경은 업데이트 이후 일정에 의해 생성된 작업에만 영향을 미치며; 현재 운영 중인 일자리는 영향을 받지 않습니다. |
| update |
이는 요청에 명시된 풀 속성만 대체합니다. 예를 들어, 풀에 StartTask가 연결되어 있고 요청이 StartTask 요소를 지정하지 않는다면, 풀은 기존의 StartTask를 유지합니다. |
| upload |
이는 오류가 발생하고 Azure 지원으로 에스컬레이션하고 싶을 때 컴퓨트 노드에서 Azure 배치 서비스 로그 파일을 자동화하여 수집하기 위한 것입니다. Azure Batch 서비스 로그 파일을 Azure 지원 공유하여 Batch 서비스의 디버깅 문제를 지원해야 합니다. |
생성자 세부 정보
BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)
new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)
매개 변수
- endpointParam
-
string
- credential
- options
- BatchClientOptionalParams
메서드 세부 정보
createJob(BatchJobCreateOptions, CreateJobOptionalParams)
배치 서비스는 작업의 일부로 수행된 작업을 제어하는 두 가지 방식을 지원합니다. 첫 번째 방법에서는 사용자가 작업 관리자 작업을 지정합니다. 배치 서비스는 작업을 시작할 준비가 되면 이 작업을 실행합니다. 작업 관리자 작업은 작업 API를 사용하여 이 작업 하에서 실행되는 모든 다른 작업을 제어합니다. 두 번째 방법에서는 사용자가 작업 API를 사용하여 활성 작업 내에서 작업 실행을 직접 제어합니다. 또한 참고: 잡 이름을 지정할 때는 사용자 이름이나 비밀 프로젝트 이름과 같은 민감한 정보를 포함하지 마세요. 이 정보는 Microsoft 지원 엔지니어가 접근할 수 있는 텔레메트리 로그에 나타날 수 있습니다.
function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>
매개 변수
- options
- CreateJobOptionalParams
반품
Promise<void>
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)
지정된 계정에 작업 일정을 생성합니다.
function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>
매개 변수
- jobSchedule
- BatchJobScheduleCreateOptions
- options
- CreateJobScheduleOptionalParams
반품
Promise<void>
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)
컴퓨트 노드가 유휴 상태이거나 실행 중일 때만 사용자 계정을 추가할 수 있습니다. 컴퓨트 노드에 원격으로 로그인하기 전에 SSH와 RDP용 액세스 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요.
function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- CreateNodeUserOptionalParams
반품
Promise<void>
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)
풀 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 않도록 합니다. 이 정보는 Microsoft 지원 엔지니어가 접근할 수 있는 텔레메트리 로그에 나타날 수 있습니다.
function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>
매개 변수
- options
- CreatePoolOptionalParams
반품
Promise<void>
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)
과제의 최대 수명은 추가부터 완료까지 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않으면 배치 서비스에 의해 종료되어 그 시점의 상태로 유지됩니다.
function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- options
- CreateTaskOptionalParams
반품
Promise<void>
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)
각 작업은 고유한 ID를 가져야 한다는 점에 유의하세요. 배치 서비스는 이 요청에서 제출된 작업과 동일한 순서로 각 작업의 결과를 반환할 수 없습니다. 서버가 타임아웃되거나 요청 중 연결이 종료되면 요청이 부분적으로 또는 완전히 처리되었거나 아예 처리되지 않았을 수도 있습니다. 이런 경우에는 사용자가 다시 요청을 발행해야 합니다. 요청을 재발행할 때 실패를 올바르게 처리하는 것은 사용자의 몫임을 유의하세요. 예를 들어, 재시도 시 동일한 작업 ID를 사용해야 하는데, 이는 이전 작업이 성공했을 때 추가 작업이 예상치 못하게 생성되지 않도록 해야 합니다. 응답에 추가에 실패한 작업(Task)이 포함되어 있다면, 클라이언트는 요청을 다시 시도할 수 있습니다. 재시도 시에는 추가에 실패한 작업만 재제출하고, 첫 시도에서 성공적으로 추가된 작업은 생략하는 것이 가장 효율적입니다. 과제의 최대 수명은 추가부터 완료까지 180일입니다. 작업이 추가된 후 180일 이내에 완료되지 않으면 배치 서비스에 의해 종료되어 그 시점의 상태로 유지됩니다.
function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>
매개 변수
- jobId
-
string
- taskCollection
- BatchTaskGroup
반품
Promise<BatchCreateTaskCollectionResult>
deallocateNode(string, string, DeallocateNodeOptionalParams)
컴퓨팅 노드가 유휴 상태이거나 실행 중인 경우에만 할당을 취소할 수 있습니다.
function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- DeallocateNodeOptionalParams
반품
PollerLike<OperationState<void>, void>
deleteJob(string, DeleteJobOptionalParams)
잡을 삭제하면 그 잡의 모든 작업과 모든 잡 통계가 삭제됩니다. 이 기능은 작업 데이터의 보존 기간도 무시합니다; 즉, 작업에 컴퓨트 노드에 남아 있는 작업이 포함되어 있다면, 배치 서비스는 해당 작업의 작업 디렉터리와 모든 내용을 삭제합니다. Delete Job 요청을 받으면 배치 서비스는 해당 작업을 삭제 상태로 설정합니다. 삭제 상태인 작업에 대한 모든 업데이트 작업은 상태 코드 409(충돌)로 실패하며, 추가 정보가 해당 작업이 삭제되고 있음을 나타냅니다.
function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobId
-
string
- options
- DeleteJobOptionalParams
반품
PollerLike<OperationState<void>, void>
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)
작업 일정을 삭제하면 해당 일정에 따라 모든 작업 및 작업도 삭제됩니다. 작업이 삭제되면 컴퓨팅 노드의 작업 디렉터리에 있는 모든 파일도 삭제됩니다(보존 기간은 무시됨). 작업 일정 통계는 작업 일정이 삭제된 후에도 더 이상 액세스할 수 없지만 계정 수명 통계로 계산됩니다.
function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobScheduleId
-
string
- options
- DeleteJobScheduleOptionalParams
반품
PollerLike<OperationState<void>, void>
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)
컴퓨팅 노드에서 지정된 파일을 삭제합니다.
function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- DeleteNodeFileOptionalParams
반품
Promise<void>
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)
사용자 계정이 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드로 삭제할 수 있습니다. 컴퓨트 노드에 원격으로 로그인하기 전에 SSH와 RDP용 액세스 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요.
function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
- userName
-
string
- options
- DeleteNodeUserOptionalParams
반품
Promise<void>
deletePool(string, DeletePoolOptionalParams)
풀을 삭제하도록 요청하면 다음 작업이 발생합니다. 풀 상태는 삭제로 설정됩니다. 풀에서 진행 중인 크기 조정 작업이 중지됩니다. Batch 서비스는 풀 크기를 컴퓨팅 노드 0으로 조정하기 시작합니다. 기존 컴퓨팅 노드에서 실행되는 모든 태스크는 종료되고 다시 큐에 추가됩니다(기본 다시 큐 옵션으로 풀 크기 조정 작업이 요청된 것처럼). 마지막으로 풀이 시스템에서 제거됩니다. 실행 중인 작업은 다시 큐에 추가되므로 사용자는 작업을 업데이트하여 다른 풀을 대상으로 하여 이러한 작업을 다시 실행할 수 있습니다. 그러면 새 풀에서 작업을 실행할 수 있습니다. 다시 큐에 넣기 동작을 재정의하려면 풀을 삭제하기 전에 크기 조정 풀을 명시적으로 호출하여 풀 크기를 0으로 줄여야 합니다. 삭제 상태에서 풀에서 업데이트, 패치 또는 삭제 API를 호출하는 경우 오류 코드 PoolBeingDeleted가 있는 HTTP 상태 코드 409로 실패합니다.
function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- options
- DeletePoolOptionalParams
반품
PollerLike<OperationState<void>, void>
deleteTask(string, string, DeleteTaskOptionalParams)
작업이 삭제되면 작업이 실행된 컴퓨팅 노드의 해당 디렉터리에 있는 모든 파일도 삭제됩니다(보존 시간에 관계 없이). 다중 인스턴스 작업의 경우 작업 삭제 작업이 주 작업에 동기적으로 적용됩니다. 그런 다음 하위 작업과 해당 파일이 백그라운드에서 비동기적으로 삭제됩니다.
function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- DeleteTaskOptionalParams
반품
Promise<void>
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)
태스크가 실행된 컴퓨팅 노드에서 지정된 작업 파일을 삭제합니다.
function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- DeleteTaskFileOptionalParams
반품
Promise<void>
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)
배치 서비스는 즉시 작업을 비활성화 상태로 전환합니다. 배치는 그 후 disableTasks 매개변수를 사용하여 작업의 현재 실행 중인 작업들을 어떻게 처리할지 결정합니다. 작업은 비활성화 작업이 완료되고 모든 작업이 disableTasks 옵션에 따라 처리될 때까지 비활성화 상태로 유지됩니다; 그 후 직업은 장애 상태로 이동합니다. 작업이 다시 활성 상태로 전환될 때까지 새로운 작업은 시작되지 않습니다. 활성화, 비활성화, 비활성화 이외의 상태에 있는 작업을 비활성화하려 하면 상태 코드 409와 함께 요청이 실패합니다.
function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobId
-
string
- disableOptions
- BatchJobDisableOptions
- options
- DisableJobOptionalParams
반품
PollerLike<OperationState<void>, void>
disableJobSchedule(string, DisableJobScheduleOptionalParams)
작업 일정을 다시 사용하도록 설정할 때까지 새 작업이 만들어지지 않습니다.
function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>
매개 변수
- jobScheduleId
-
string
- options
- DisableJobScheduleOptionalParams
반품
Promise<void>
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)
현재 스케줄링 상태가 활성화된 경우에만 컴퓨트 노드에서 작업 스케줄링을 비활성화할 수 있습니다.
function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
반품
Promise<void>
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)
풀에 대한 자동 크기 조정을 사용하지 않도록 설정합니다.
function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>
매개 변수
- poolId
-
string
반품
Promise<void>
enableJob(string, EnableJobOptionalParams)
이 API를 호출하면 배치 서비스가 비활성화된 작업을 활성화 상태로 설정합니다. 이 작업이 완료되면 작업은 활성 상태로 전환되고, 작업 하에 새로운 작업 스케줄링이 재개됩니다. 배치 서비스는 태스크가 활성 상태에 180일 이상 머무르는 것을 허용하지 않습니다. 따라서 180일 이상 전에 추가된 활성 작업이 포함된 작업을 활성화하면, 해당 작업들은 실행되지 않습니다.
function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobId
-
string
- options
- EnableJobOptionalParams
반품
PollerLike<OperationState<void>, void>
enableJobSchedule(string, EnableJobScheduleOptionalParams)
작업 일정을 사용하도록 설정합니다.
function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>
매개 변수
- jobScheduleId
-
string
- options
- EnableJobScheduleOptionalParams
반품
Promise<void>
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)
컴퓨트 노드의 현재 스케줄링 상태가 비활성화된 경우에만 작업 스케줄링을 활성화할 수 있습니다
function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
반품
Promise<void>
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)
풀에서 크기 조정 작업이 진행 중인 경우 풀에서 자동 크기 조정을 사용하도록 설정할 수 없습니다. 풀의 자동 크기 조정이 현재 비활성화된 경우 요청의 일부로 유효한 자동 크기 조정 수식을 지정해야 합니다. 풀의 자동 크기 조정을 이미 사용하도록 설정한 경우 새 자동 크기 조정 수식 및/또는 새 평가 간격을 지정할 수 있습니다. 동일한 풀에 대해 30초마다 두 번 이상 이 API를 호출할 수 없습니다.
function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- enableAutoScaleOptions
- BatchPoolEnableAutoScaleOptions
반품
Promise<void>
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)
이 API는 풀에 수식을 적용하지 않고 결과를 반환하기 때문에 주로 자동 크기 조정 수식의 유효성을 검사하기 위한 것입니다. 수식을 평가하려면 풀에 자동 크기 조정을 사용하도록 설정해야 합니다.
function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>
매개 변수
- poolId
-
string
- evaluateAutoScaleOptions
- BatchPoolEvaluateAutoScaleOptions
반품
Promise<AutoScaleRun>
getApplication(string, GetApplicationOptionalParams)
이 작업은 컴퓨트 노드에서 사용 가능한 애플리케이션과 버전만 반환합니다; 즉, 패키지 참조에서 사용할 수 있습니다. 아직 컴퓨트 노드에 제공되지 않은 애플리케이션 및 버전에 대한 관리자 정보는 Azure 포털 또는 Azure 리소스 매니저 API를 사용하세요.
function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>
매개 변수
- applicationId
-
string
- options
- GetApplicationOptionalParams
반품
Promise<BatchApplication>
getJob(string, GetJobOptionalParams)
지정된 직무에 대한 정보를 얻습니다.
function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>
매개 변수
- jobId
-
string
- options
- GetJobOptionalParams
반품
Promise<BatchJob>
getJobSchedule(string, GetJobScheduleOptionalParams)
지정된 작업 일정에 대한 정보를 얻습니다.
function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>
매개 변수
- jobScheduleId
-
string
- options
- GetJobScheduleOptionalParams
반품
Promise<BatchJobSchedule>
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)
작업 수는 활성, 실행 중 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다.
function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>
매개 변수
- jobId
-
string
- options
- GetJobTaskCountsOptionalParams
반품
Promise<BatchTaskCountsResult>
getNode(string, string, GetNodeOptionalParams)
지정된 컴퓨팅 노드에 대한 정보를 가져옵니다.
function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- GetNodeOptionalParams
반품
Promise<BatchNode>
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)
지정된 컴퓨트 노드 확장에 대한 정보를 얻습니다.
function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>
매개 변수
- poolId
-
string
- nodeId
-
string
- extensionName
-
string
- options
- GetNodeExtensionOptionalParams
반품
Promise<BatchNodeVMExtension>
getNodeFile(string, string, string, GetNodeFileOptionalParams)
지정된 컴퓨트 노드 파일의 내용을 반환합니다.
function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>
매개 변수
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- GetNodeFileOptionalParams
반품
Promise<Uint8Array>
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)
지정된 컴퓨팅 노드 파일의 속성을 가져옵니다.
function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>
매개 변수
- poolId
-
string
- nodeId
-
string
- filePath
-
string
반품
Promise<BatchNodeFile>
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)
원격 로그인 설정을 통해 컴퓨트 노드에 원격으로 로그인하기 전에, 컴퓨트 노드에서 사용자 계정을 만들고 SSH와 RDP용 접근 포트를 설정해야 합니다. 자세한 내용은 https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration를 참조하세요.
function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>
매개 변수
- poolId
-
string
- nodeId
-
string
반품
Promise<BatchNodeRemoteLoginSettings>
getPool(string, GetPoolOptionalParams)
지정된 풀에 대한 정보를 가져옵니다.
function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>
매개 변수
- poolId
-
string
- options
- GetPoolOptionalParams
반품
Promise<BatchPool>
getTask(string, string, GetTaskOptionalParams)
다중 인스턴스 작업의 경우, affinityId, executionInfo, nodeInfo와 같은 정보는 기본 작업을 가리킵니다. 하위 작업 정보를 가져오기 위해 List 하위 작업 API를 사용하세요.
function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- GetTaskOptionalParams
반품
Promise<BatchTask>
getTaskFile(string, string, string, GetTaskFileOptionalParams)
지정된 작업 파일의 내용을 반환합니다.
function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>
매개 변수
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- GetTaskFileOptionalParams
반품
Promise<Uint8Array>
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)
지정한 작업 파일의 속성을 가져옵니다.
function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>
매개 변수
- jobId
-
string
- taskId
-
string
- filePath
-
string
반품
Promise<BatchNodeFile>
jobScheduleExists(string, JobScheduleExistsOptionalParams)
지정된 작업 일정이 존재하는지 확인합니다.
function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>
매개 변수
- jobScheduleId
-
string
- options
- JobScheduleExistsOptionalParams
반품
Promise<boolean>
listApplications(ListApplicationsOptionalParams)
이 작업은 컴퓨트 노드에서 사용 가능한 애플리케이션과 버전만 반환합니다; 즉, 패키지 참조에서 사용할 수 있습니다. 아직 컴퓨트 노드에 제공되지 않은 애플리케이션 및 버전에 대한 관리자 정보는 Azure 포털 또는 Azure 리소스 매니저 API를 사용하세요.
function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>
매개 변수
- options
- ListApplicationsOptionalParams
반품
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)
이 API는 작업 준비 또는 작업 릴리스 태스크를 실행한 모든 컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업 상태를 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.
function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>
매개 변수
- jobId
-
string
반품
listJobs(ListJobsOptionalParams)
지정된 계정에 있는 모든 직무를 나열합니다.
function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>
매개 변수
- options
- ListJobsOptionalParams
반품
listJobSchedules(ListJobSchedulesOptionalParams)
지정된 계정 내 모든 작업 일정을 나열합니다.
function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>
매개 변수
- options
- ListJobSchedulesOptionalParams
반품
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)
지정된 작업 일정 하에 생성된 작업들을 나열합니다.
function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>
매개 변수
- jobScheduleId
-
string
반품
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)
지정된 풀 내 컴퓨트 노드 확장을 나열합니다.
function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- ListNodeExtensionsOptionalParams
반품
listNodeFiles(string, string, ListNodeFilesOptionalParams)
지정된 컴퓨팅 노드의 작업 디렉터리에 있는 모든 파일을 나열합니다.
function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- ListNodeFilesOptionalParams
반품
listNodes(string, ListNodesOptionalParams)
지정된 풀의 컴퓨팅 노드를 나열합니다.
function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>
매개 변수
- poolId
-
string
- options
- ListNodesOptionalParams
반품
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)
풀별로 그룹화된 각 상태의 컴퓨팅 노드 수를 가져옵니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 노드 수가 필요한 경우 목록 쿼리를 사용합니다.
function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>
매개 변수
- options
- ListPoolNodeCountsOptionalParams
반품
listPools(ListPoolsOptionalParams)
지정된 계정의 모든 풀을 나열합니다.
function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>
매개 변수
- options
- ListPoolsOptionalParams
반품
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)
poolId를 포함하여 $filter 절을 지정하지 않으면 반환된 집계 간격의 시간 범위에서 계정에 존재했던 모든 풀이 응답에 포함됩니다. startTime 또는 endTime을 포함하여 $filter 절을 지정하지 않으면 이러한 필터는 기본적으로 현재 사용 가능한 마지막 집계 간격의 시작 및 종료 시간으로 설정됩니다. 즉, 마지막 집계 간격만 반환됩니다.
function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>
매개 변수
반품
listSubTasks(string, string, ListSubTasksOptionalParams)
작업이 다중 인스턴스 작업이 아니면 빈 컬렉션이 반환됩니다.
function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- ListSubTasksOptionalParams
반품
listSupportedImages(ListSupportedImagesOptionalParams)
Azure Batch 서비스에서 지원하는 모든 Virtual Machine 이미지를 나열합니다.
function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>
매개 변수
반품
listTaskFiles(string, string, ListTaskFilesOptionalParams)
컴퓨팅 노드의 작업 디렉터리에 있는 파일을 나열합니다.
function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- ListTaskFilesOptionalParams
반품
listTasks(string, ListTasksOptionalParams)
다중 인스턴스 작업의 경우, affinityId, executionInfo, nodeInfo와 같은 정보는 기본 작업을 가리킵니다. 하위 작업 정보를 가져오기 위해 List 하위 작업 API를 사용하세요.
function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>
매개 변수
- jobId
-
string
- options
- ListTasksOptionalParams
반품
poolExists(string, PoolExistsOptionalParams)
풀의 기본 속성을 얻습니다.
function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>
매개 변수
- poolId
-
string
- options
- PoolExistsOptionalParams
반품
Promise<boolean>
reactivateTask(string, string, ReactivateTaskOptionalParams)
다시 활성화하면 최대 재시도 횟수까지 작업을 다시 시도할 수 있습니다. 작업의 상태가 활성 상태로 변경됩니다. 작업이 더 이상 완료되지 않으므로 다시 활성화한 후에는 이전 종료 코드 또는 오류 정보를 더 이상 사용할 수 없습니다. 작업이 다시 활성화될 때마다 재시도 횟수가 0으로 다시 설정됩니다. 완료되지 않았거나 이전에 성공적으로 완료된 작업에 대해 다시 활성화가 실패합니다(종료 코드가 0임). 또한 작업이 완료되었거나 종료 또는 삭제 중이면 실패합니다.
function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- ReactivateTaskOptionalParams
반품
Promise<void>
rebootNode(string, string, RebootNodeOptionalParams)
컴퓨팅 노드가 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드를 다시 시작할 수 있습니다.
function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- RebootNodeOptionalParams
반품
PollerLike<OperationState<void>, void>
reimageNode(string, string, ReimageNodeOptionalParams)
운영 체제가 유휴 상태이거나 실행 중인 경우에만 컴퓨팅 노드에 다시 설치할 수 있습니다. 이 API는 클라우드 서비스 구성 속성으로 생성된 풀에서만 호출할 수 있습니다.
function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- ReimageNodeOptionalParams
반품
PollerLike<OperationState<void>, void>
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)
이 작업은 풀의 할당 상태가 안정적인 경우에만 실행할 수 있습니다. 이 작업이 실행되면 할당 상태가 안정에서 크기 조정으로 변경됩니다. 각 요청은 최대 100개의 노드를 제거할 수 있습니다.
function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- removeOptions
- BatchNodeRemoveOptions
- options
- RemoveNodesOptionalParams
반품
PollerLike<OperationState<void>, void>
replaceJob(string, BatchJob, ReplaceJobOptionalParams)
이로 인해 작업의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 작업에 제약 조건이 연결되어 있고 이 요청에 제약 조건이 명시되어 있지 않다면, 배치 서비스는 기존의 제약 조건을 제거합니다.
function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- job
- BatchJob
- options
- ReplaceJobOptionalParams
반품
Promise<void>
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)
이로 인해 작업 일정의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 이 요청에 스케줄이 지정되어 있지 않으면 배치 서비스는 기존 스케줄을 제거합니다. 작업 일정의 변경은 업데이트 이후 일정에 의해 생성된 작업에만 영향을 미치며; 현재 운영 중인 일자리는 영향을 받지 않습니다.
function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>
매개 변수
- jobScheduleId
-
string
- jobSchedule
- BatchJobSchedule
- options
- ReplaceJobScheduleOptionalParams
반품
Promise<void>
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)
이 연산은 계정의 모든 업데이트 가능한 속성을 대체합니다. 예를 들어, expiryTime 요소가 지정되지 않으면 현재 값이 기본 값으로 대체되며, 수정되지 않은 상태로 남겨두지 않습니다. 컴퓨트 노드의 사용자 계정을 업데이트할 수 있는 것은 유휴 상태이거나 실행 중일 때뿐입니다.
function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- nodeId
-
string
- userName
-
string
- updateOptions
- BatchNodeUserUpdateOptions
- options
- ReplaceNodeUserOptionalParams
반품
Promise<void>
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)
이로써 풀의 모든 업데이트 가능한 속성이 완전히 대체됩니다. 예를 들어, 풀에 StartTask가 연결되어 있고 이 요청에 StartTask가 지정되어 있지 않으면, 배치 서비스는 기존의 StartTask를 제거합니다.
function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>
매개 변수
- poolId
-
string
반품
Promise<void>
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)
지정된 작업의 속성을 업데이트합니다.
function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- taskId
-
string
- task
- BatchTask
- options
- ReplaceTaskOptionalParams
반품
Promise<void>
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)
할당 상태가 안정적인 경우에만 풀의 크기를 조정할 수 있습니다. 풀의 크기가 이미 조정된 경우 상태 코드 409로 요청이 실패합니다. 풀의 크기를 조정하면 풀의 할당 상태가 안정적에서 크기 조정으로 변경됩니다. 자동 크기 조정을 위해 구성된 풀의 크기를 조정할 수 없습니다. 이 작업을 수행하려고 하면 Batch 서비스에서 오류 409를 반환합니다. 풀의 크기를 아래쪽으로 조정하면 Batch 서비스에서 제거할 컴퓨팅 노드를 선택합니다. 특정 컴퓨팅 노드를 제거하려면 풀을 사용하여 컴퓨팅 노드 API를 제거합니다.
function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- resizeOptions
- BatchPoolResizeOptions
- options
- ResizePoolOptionalParams
반품
PollerLike<OperationState<void>, void>
startNode(string, string, StartNodeOptionalParams)
컴퓨트 노드는 할당이 해제된 경우에만 시작할 수 있습니다.
function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- nodeId
-
string
- options
- StartNodeOptionalParams
반품
PollerLike<OperationState<void>, void>
stopPoolResize(string, StopPoolResizeOptionalParams)
이 경우 풀을 크기 조정 전 상태로 복원하지 않으며, 추가 변경만 중단하고 풀은 현재 상태를 유지합니다. 정지 후 풀은 정지 연산 시 유지되던 컴퓨트 노드 수로 안정화됩니다. 정지 작업 동안 풀 할당 상태는 먼저 정지, 그다음 정상으로 바뀝니다. 크기 조정 연산은 명시적인 크기 조절 풀 요청일 필요는 없습니다; 이 API는 풀이 생성될 때 초기 크기 조정을 중단하는 데도 사용할 수 있습니다.
function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- poolId
-
string
- options
- StopPoolResizeOptionalParams
반품
PollerLike<OperationState<void>, void>
terminateJob(string, TerminateJobOptionalParams)
Terminate Job 요청이 접수되면, 배치 서비스는 Job을 종료 상태로 설정합니다. 배치 서비스는 작업과 관련된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그 후 작업은 완료 상태로 전환됩니다. 작업 중에 활성 상태에 있는 작업이 있다면, 그 작업들은 활성 상태로 유지됩니다. 작업이 종료되면 새로운 작업을 추가할 수 없으며, 남아 있는 활성 작업도 스케줄링되지 않습니다.
function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobId
-
string
- options
- TerminateJobOptionalParams
반품
PollerLike<OperationState<void>, void>
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)
작업 일정을 종료합니다.
function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>
매개 변수
- jobScheduleId
-
string
반품
PollerLike<OperationState<void>, void>
terminateTask(string, string, TerminateTaskOptionalParams)
작업이 종료되면 완료된 상태로 이동합니다. 다중 인스턴스 작업의 경우 종료 작업 작업은 주 작업에 동기적으로 적용됩니다. 그런 다음 백그라운드에서 하위 작업이 비동기적으로 종료됩니다.
function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- taskId
-
string
- options
- TerminateTaskOptionalParams
반품
Promise<void>
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)
이는 요청에 명시된 작업 속성만 대체합니다. 예를 들어, 작업에 제약 조건이 있고 요청이 제약 요소를 지정하지 않는다면, 작업은 기존 제약 조건을 유지합니다.
function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>
매개 변수
- jobId
-
string
- options
- UpdateJobOptionalParams
반품
Promise<void>
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)
이는 요청에 명시된 작업 일정 속성만을 대체합니다. 예를 들어, 이 요청에 스케줄(schedule) 속성이 지정되어 있지 않으면, 배치 서비스는 기존 스케줄을 유지합니다. 작업 일정의 변경은 업데이트 이후 일정에 의해 생성된 작업에만 영향을 미치며; 현재 운영 중인 일자리는 영향을 받지 않습니다.
function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>
매개 변수
- jobScheduleId
-
string
- jobSchedule
- BatchJobScheduleUpdateOptions
- options
- UpdateJobScheduleOptionalParams
반품
Promise<void>
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)
이는 요청에 명시된 풀 속성만 대체합니다. 예를 들어, 풀에 StartTask가 연결되어 있고 요청이 StartTask 요소를 지정하지 않는다면, 풀은 기존의 StartTask를 유지합니다.
function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>
매개 변수
- poolId
-
string
- options
- UpdatePoolOptionalParams
반품
Promise<void>
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)
이는 오류가 발생하고 Azure 지원으로 에스컬레이션하고 싶을 때 컴퓨트 노드에서 Azure 배치 서비스 로그 파일을 자동화하여 수집하기 위한 것입니다. Azure Batch 서비스 로그 파일을 Azure 지원 공유하여 Batch 서비스의 디버깅 문제를 지원해야 합니다.
function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>
매개 변수
- poolId
-
string
- nodeId
-
string
- uploadOptions
- UploadBatchServiceLogsOptions
- options
- UploadNodeLogsOptionalParams
반품
Promise<UploadBatchServiceLogsResult>