Pool - Update Properties

참조

서비스:: Batch Service

API 버전:: 2024-07-01.20.0

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

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0

선택적 매개 변수:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
poolId	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를 직접 호출하는 경우 명시적으로 설정합니다.

요청 본문

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

Name	필수	형식	Description
applicationPackageReferences	True	ApplicationPackageReference[]	풀의 각 컴퓨팅 노드에 설치할 애플리케이션 패키지 목록입니다. 이 목록은 풀의 기존 애플리케이션 패키지 참조를 대체합니다. 애플리케이션 패키지 참조에 대한 변경 내용은 풀에 조인하는 모든 새 컴퓨팅 노드에 영향을 주지만 다시 부팅하거나 이미지로 다시 설치할 때까지 풀에 이미 있는 컴퓨팅 노드에는 영향을 미치지 않습니다. 지정된 풀에는 최대 10개의 애플리케이션 패키지 참조가 있습니다. 생략하거나 빈 컬렉션을 지정하는 경우 기존 애플리케이션 패키지 참조가 풀에서 제거됩니다. 지정된 풀에 최대 10개의 참조를 지정할 수 있습니다.
certificateReferences	True	CertificateReference[]	풀의 각 컴퓨팅 노드에 설치할 인증서 목록입니다. 이 목록은 풀에 구성된 기존 인증서 참조를 대체합니다. 빈 컬렉션을 지정하면 기존 인증서 참조가 풀에서 제거됩니다. Windows 노드의 경우 Batch 서비스는 지정된 인증서 저장소 및 위치에 인증서를 설치합니다. Linux 컴퓨팅 노드의 경우 인증서는 작업 작업 디렉터리 내의 디렉터리에 저장되고 AZ_BATCH_CERTIFICATES_DIR 환경 변수는 이 위치를 쿼리하기 위해 태스크에 제공됩니다. 'remoteUser'의 표시 유형이 있는 인증서의 경우 사용자의 홈 디렉터리(예: /home/{user-name}/certs)에 'certs' 디렉터리가 만들어지고 인증서가 해당 디렉터리에 배치됩니다. 경고: 이 속성은 더 이상 사용되지 않으며 2024년 2월 이후에 제거됩니다. 대신 Azure KeyVault 확장 사용하세요.
metadata	True	MetadataItem[]	풀과 메타데이터로 연결된 이름-값 쌍의 목록입니다. 이 목록은 풀에 구성된 기존 메타데이터를 대체합니다. 생략하거나 빈 컬렉션을 지정하는 경우 풀에서 기존 메타데이터가 제거됩니다.
startTask		StartTask	풀에 조인할 때 각 컴퓨팅 노드에서 실행할 작업입니다. 태스크는 컴퓨팅 노드가 풀에 추가되거나 컴퓨팅 노드가 다시 시작될 때 실행됩니다. 이 요소가 있으면 기존 StartTask를 덮어씁니다. 생략하면 기존 StartTask가 풀에서 제거됩니다.
targetNodeCommunicationMode		NodeCommunicationMode	풀에 대해 원하는 노드 통신 모드입니다. 이 설정은 풀의 기존 targetNodeCommunication 설정을 대체합니다. 생략하면 기존 설정이 기본값입니다.

응답

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

Name

형식

Description

204 No Content

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

예제

Pool update

샘플 요청

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

샘플 응답

상태 코드:: 204

정의

Name	Description
ApplicationPackageReference	컴퓨팅 노드에 배포할 패키지에 대한 참조입니다.
AutoUserScope	자동 사용자에 대한 범위
AutoUserSpecification	Batch 서비스에서 작업을 실행하는 자동 사용자에 대한 매개 변수를 지정합니다.
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
CertificateReference	풀의 컴퓨팅 노드에 설치할 인증서에 대한 참조입니다.
CertificateStoreLocation	인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다.
CertificateVisibility	컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다.
ComputeNodeIdentityReference	컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.
ContainerHostBatchBindMountEntry	작업 컨테이너에 탑재할 경로 및 탑재 모드의 항목입니다.
ContainerHostDataPath	컨테이너 태스크의 컨테이너에 탑재될 경로입니다.
ContainerRegistry	프라이빗 컨테이너 레지스트리입니다.
ContainerWorkingDirectory	컨테이너 작업 디렉터리의 위치입니다.
ElevationLevel	사용자의 권한 상승 수준입니다.
EnvironmentSetting	작업 프로세스에서 설정할 환경 변수입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
MetadataItem	Batch 서비스 리소스와 연결된 이름-값 쌍입니다.
NodeCommunicationMode	풀이 Batch 서비스와 통신하는 방법을 결정합니다.
PoolUpdatePropertiesParameter	풀에 대한 변경 내용 집합입니다.
ResourceFile	컴퓨팅 노드에 다운로드할 단일 파일 또는 여러 파일입니다.
StartTask	노드가 Azure Batch 서비스에서 풀에 조인하거나 컴퓨팅 노드를 다시 부팅하거나 이미지로 다시 설치할 때 실행되는 작업입니다.
TaskContainerSettings	작업에 대한 컨테이너 설정입니다.
UserIdentity	작업이 실행되는 사용자 ID의 정의입니다.

ApplicationPackageReference

컴퓨팅 노드에 배포할 패키지에 대한 참조입니다.

Name	형식	Description
applicationId	string	배포할 애플리케이션의 ID입니다. 풀을 만들 때 패키지의 애플리케이션 ID는 정규화되어야 합니다(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	배포할 애플리케이션의 버전입니다. 생략하면 기본 버전이 배포됩니다. 풀에서 생략되고 이 애플리케이션에 대한 기본 버전이 지정되지 않은 경우 오류 코드 InvalidApplicationPackageReferences 및 HTTP 상태 코드 409와 함께 요청이 실패합니다. 이 작업이 작업에서 생략되고 이 애플리케이션에 대한 기본 버전이 지정되지 않은 경우 태스크가 사전 처리 오류와 함께 실패합니다.

AutoUserScope

자동 사용자에 대한 범위

Name	형식	Description
pool	string	태스크가 풀의 모든 컴퓨팅 노드에서 생성되는 공통 자동 사용자 계정으로 실행되도록 지정합니다.
task	string	서비스에서 Task에 대한 새 사용자를 만들어야 임을 지정합니다.

AutoUserSpecification

Batch 서비스에서 작업을 실행하는 자동 사용자에 대한 매개 변수를 지정합니다.

Name	형식	Description
elevationLevel	ElevationLevel	자동 사용자의 권한 상승 수준입니다. 기본값은 nonAdmin입니다.
scope	AutoUserScope	자동 사용자에 대한 범위 기본값은 풀입니다. 풀이 Windows를 실행하는 경우 작업 간에 더 엄격한 격리가 필요한 경우 작업 값을 지정해야 합니다. 예를 들어 태스크가 다른 작업에 영향을 미칠 수 있는 방식으로 레지스트리를 변경하거나 일반 작업에서 액세스할 수 없지만 StartTasks에서 액세스할 수 있어야 하는 풀에 인증서를 지정한 경우입니다.

BatchError

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

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

BatchErrorDetail

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

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

CertificateReference

풀의 컴퓨팅 노드에 설치할 인증서에 대한 참조입니다.

Name	형식	Description
storeLocation	CertificateStoreLocation	인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다. 기본값은 currentuser입니다. 이 속성은 Windows 컴퓨팅 노드로 구성된 풀에만 적용됩니다. Linux 컴퓨팅 노드의 경우 인증서는 작업 작업 디렉터리 내의 디렉터리에 저장되고 AZ_BATCH_CERTIFICATES_DIR 환경 변수는 이 위치를 쿼리하기 위해 태스크에 제공됩니다. 'remoteUser'의 표시 유형이 있는 인증서의 경우 사용자의 홈 디렉터리(예: /home/{user-name}/certs)에 'certs' 디렉터리가 만들어지고 인증서가 해당 디렉터리에 배치됩니다.
storeName	string	인증서를 설치할 컴퓨팅 노드의 인증서 저장소 이름입니다. 이 속성은 Windows 컴퓨팅 노드로 구성된 풀에만 적용됩니다. 일반적인 저장소 이름에는 My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook 등이 있지만 사용자 지정 저장소 이름도 사용할 수 있습니다. 기본값은 My입니다.
thumbprint	string	인증서의 지문입니다.
thumbprintAlgorithm	string	지문이 연결된 알고리즘입니다. sha1이어야 합니다.
visibility	CertificateVisibility[]	컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다. 이 컬렉션에서 둘 이상의 표시 유형을 지정할 수 있습니다. 기본값은 모든 계정입니다.

CertificateStoreLocation

인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다.

Name	형식	Description
currentuser	string	인증서는 CurrentUser 인증서 저장소에 설치해야 합니다.
localmachine	string	인증서는 LocalMachine 인증서 저장소에 설치해야 합니다.

CertificateVisibility

컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다.

Name	형식	Description
remoteuser	string	인증서는 사용자가 컴퓨팅 노드에 원격으로 액세스하는 사용자 계정에 표시되어야 합니다.
starttask	string	인증서는 StartTask가 실행되는 사용자 계정에 표시됩니다. AutoUser 범위가 StartTask 및 작업 모두에 대한 풀인 경우 이 인증서도 작업에 표시됩니다.
task	string	인증서는 작업 작업이 실행되는 사용자 계정에 표시되어야 합니다.

ComputeNodeIdentityReference

컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.

Name	형식	Description
resourceId	string	사용자 할당 ID의 ARM 리소스 ID입니다.

ContainerHostBatchBindMountEntry

작업 컨테이너에 탑재할 경로 및 탑재 모드의 항목입니다.

Name	형식	Description
isReadOnly	boolean	이 원본 경로를 읽기 전용 모드로 탑재합니다. 기본값은 false(읽기/쓰기 모드)입니다. Linux의 경우 이 경로를 읽기/쓰기 모드로 탑재하는 경우 컨테이너의 모든 사용자가 경로에 대한 읽기/쓰기 액세스 권한을 가지는 것은 아니며 호스트 VM의 액세스에 따라 달라집니다. 이 경로가 읽기 전용으로 탑재된 경우 컨테이너 내의 모든 사용자가 경로를 수정할 수 없습니다.
source	ContainerHostDataPath	컨테이너 고객에게 탑재할 경로는 선택할 수 있습니다.

ContainerHostDataPath

컨테이너 태스크의 컨테이너에 탑재될 경로입니다.

Name	형식	Description
Applications	string	애플리케이션 경로입니다.
JobPrep	string	작업 준비 작업 경로입니다.
Shared	string	파일을 공유하는 다중 인스턴스 작업의 경로입니다.
Startup	string	시작 작업의 경로입니다.
Task	string	작업 경로입니다.
VfsMounts	string	경로에는 이 노드에 탑재된 모든 가상 파일 시스템이 포함됩니다.

ContainerRegistry

프라이빗 컨테이너 레지스트리입니다.

Name	형식	Description
identityReference	ComputeNodeIdentityReference	사용자 이름 및 암호 대신 Azure Container Registry에 액세스하는 데 사용할 사용자 할당 ID에 대한 참조입니다. 컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.
password	string	레지스트리 서버에 로그인할 암호입니다.
registryServer	string	레지스트리 URL입니다. 생략하면 기본값은 "docker.io"입니다.
username	string	레지스트리 서버에 로그인할 사용자 이름입니다.

ContainerWorkingDirectory

컨테이너 작업 디렉터리의 위치입니다.

Name	형식	Description
containerImageDefault	string	컨테이너 이미지에 정의된 작업 디렉터리를 사용합니다. 이 디렉터리에는 Batch에서 다운로드한 리소스 파일이 포함되지 않습니다.
taskWorkingDirectory	string	Batch로 채워진 작업 리소스 파일을 포함하는 표준 Batch 서비스 작업 디렉터리를 사용합니다.

ElevationLevel

사용자의 권한 상승 수준입니다.

Name	형식	Description
admin	string	사용자는 상승된 액세스 권한을 가진 사용자이며 전체 관리자 권한으로 작동합니다.
nonadmin	string	사용자는 상승된 액세스 권한이 없는 표준 사용자입니다.

EnvironmentSetting

작업 프로세스에서 설정할 환경 변수입니다.

Name	형식	Description
name	string	환경 변수의 이름입니다.
value	string	환경 변수의 값입니다.

ErrorMessage

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

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

MetadataItem

Batch 서비스 리소스와 연결된 이름-값 쌍입니다.

Name	형식	Description
name	string	메타데이터 항목의 이름입니다.
value	string	메타데이터 항목의 값입니다.

NodeCommunicationMode

풀이 Batch 서비스와 통신하는 방법을 결정합니다.

Name	형식	Description
classic	string	클래식 통신 모드를 사용하는 노드에는 "BatchNodeManagement"의 포트 29876 및 29877에서 인바운드 TCP 통신이 필요합니다. 포트 443에서 "Storage.region" 및 "BatchNodeManagement"로의 {region}" 서비스 태그 및 아웃바운드 TCP 통신 {region}" 서비스 태그입니다.
default	string	노드 통신 모드는 Batch 서비스에 의해 자동으로 설정됩니다.
simplified	string	간소화된 통신 모드를 사용하는 노드에는 포트 443에서 "BatchNodeManagement"로의 아웃바운드 TCP 통신이 필요합니다. {region}" 서비스 태그입니다. 열려 있는 인바운드 포트는 필요하지 않습니다.