PoolOperations 클래스

PoolOperations 작업.

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

상속
builtins.object
PoolOperations

생성자

PoolOperations(client, config, serializer, deserializer)

매개 변수

client
필수

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

config
필수

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

serializer
필수

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

deserializer
필수

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

변수

api_version

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

메서드

add

지정된 계정에 풀을 추가합니다.

풀의 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 마세요. Microsoft 지원 엔지니어가 액세스할 수 있는 원격 분석 로그에 이런 정보가 나타날 수 있습니다.

delete

지정된 계정에서 풀을 삭제합니다.

풀 삭제를 요청할 때 다음 작업이 발생합니다. 풀 상태는 삭제로 설정됩니다. 풀에서 진행 중인 크기 조정 작업이 중지됩니다. Batch 서비스는 풀 크기를 컴퓨팅 노드 0으로 조정하기 시작합니다. 기존 컴퓨팅 노드에서 실행되는 모든 작업은 종료되고 다시 큐에 추가됩니다(기본 다시 큐 옵션으로 풀 크기 조정 작업이 요청된 것처럼). 마지막으로 풀이 시스템에서 제거됩니다. 실행 중인 작업은 다시 큐에 추가되므로 사용자는 작업을 업데이트하여 다른 풀을 대상으로 하여 이러한 작업을 다시 실행할 수 있습니다. 그런 다음 새 풀에서 작업을 실행할 수 있습니다. 다시 큐에 넣기 동작을 재정의하려면 풀을 삭제하기 전에 풀 크기를 0으로 줄이기 위해 명시적으로 풀 크기를 조정해야 합니다. 삭제 상태의 풀에서 업데이트, 패치 또는 삭제 API를 호출하는 경우 오류 코드 PoolBeingDeleted가 있는 HTTP 상태 코드 409로 실패합니다.

disable_auto_scale

풀에 대한 자동 크기 조정을 사용하지 않도록 설정합니다.

enable_auto_scale

풀에 대해 자동 크기 조정을 사용하도록 설정합니다.

풀에서 크기 조정 작업이 진행 중인 경우 풀에서 자동 크기 조정을 사용하도록 설정할 수 없습니다. 풀의 자동 크기 조정을 현재 사용하지 않도록 설정한 경우 요청의 일부로 유효한 자동 크기 조정 수식을 지정해야 합니다. 풀의 자동 크기 조정을 이미 사용하도록 설정한 경우 새 자동 크기 조정 수식 및/또는 새 평가 간격을 지정할 수 있습니다. 30초마다 두 번 이상 동일한 풀에 대해 이 API를 호출할 수 없습니다.

evaluate_auto_scale

풀에서 자동 크기 조정 수식을 평가한 결과를 가져옵니다.

이 API는 풀에 수식을 적용하지 않고 결과를 반환하기 때문에 주로 자동 크기 조정 수식의 유효성을 검사하기 위한 것입니다. 수식을 평가하려면 풀에 자동 크기 조정을 사용하도록 설정해야 합니다.

exists

풀의 기본 속성을 가져옵니다.

get

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

list

지정된 계정의 모든 풀을 나열합니다.

list_usage_metrics

지정된 계정에 대해 개별 시간 간격에 걸쳐 풀로 집계된 사용 메트릭을 나열합니다.

poolId를 포함하여 $filter 절을 지정하지 않으면 반환된 집계 간격의 시간 범위에서 계정에 존재했던 모든 풀이 응답에 포함됩니다. startTime 또는 endTime을 포함하여 $filter 절을 지정하지 않으면 이러한 필터는 기본적으로 현재 사용 가능한 마지막 집계 간격의 시작 및 종료 시간으로 설정됩니다. 즉, 마지막 집계 간격만 반환됩니다.

patch

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

이는 요청에 지정된 풀 속성만 대체합니다. 예를 들어 풀에 연결된 StartTask가 있고 요청이 StartTask 요소를 지정하지 않는 경우 풀은 기존 StartTask를 유지합니다.

remove_nodes

지정된 풀에서 컴퓨팅 노드를 제거합니다.

이 작업은 풀의 할당 상태가 안정적일 때만 실행할 수 있습니다. 이 작업이 실행되면 할당 상태가 안정에서 크기 조정으로 변경됩니다. 각 요청은 최대 100개의 노드를 제거할 수 있습니다.

resize

풀에 할당된 컴퓨팅 노드 수를 변경합니다.

할당 상태가 안정적인 경우에만 풀의 크기를 조정할 수 있습니다. 풀의 크기가 이미 조정된 경우 상태 코드 409로 요청이 실패합니다. 풀 크기를 조정하면 풀의 할당 상태가 안정적에서 크기 조정으로 변경됩니다. 자동 크기 조정을 위해 구성된 풀의 크기를 조정할 수 없습니다. 이 작업을 수행하려고 하면 Batch 서비스에서 오류 409를 반환합니다. 풀 크기를 아래쪽으로 조정하는 경우 Batch 서비스는 제거할 컴퓨팅 노드를 선택합니다. 특정 컴퓨팅 노드를 제거하려면 풀 제거 컴퓨팅 노드 API를 대신 사용합니다.

stop_resize

풀에서 진행 중인 크기 조정 작업을 중지합니다.

이렇게 하면 크기 조정 작업 전에 풀이 이전 상태로 복원되지 않습니다. 추가 변경 내용만 중지하고 풀은 현재 상태를 유지합니다. 중지한 후 풀은 중지 작업이 완료되었을 때의 컴퓨팅 노드 수로 안정화됩니다. 중지 작업 중에 풀 할당 상태가 먼저 중지로 변경된 다음 안정적으로 변경됩니다. 크기 조정 작업은 명시적 크기 조정 풀 요청이 아니어야 합니다. 이 API를 사용하여 풀을 만들 때 풀의 초기 크기 조정을 중지할 수도 있습니다.

update_properties

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

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

add

지정된 계정에 풀을 추가합니다.

풀의 이름을 지정할 때 사용자 이름 또는 비밀 프로젝트 이름과 같은 중요한 정보를 포함하지 마세요. Microsoft 지원 엔지니어가 액세스할 수 있는 원격 분석 로그에 이런 정보가 나타날 수 있습니다.

add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool
PoolAddParameter
필수

추가할 풀입니다.

pool_add_options
PoolAddOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

delete

지정된 계정에서 풀을 삭제합니다.

풀 삭제를 요청할 때 다음 작업이 발생합니다. 풀 상태는 삭제로 설정됩니다. 풀에서 진행 중인 크기 조정 작업이 중지됩니다. Batch 서비스는 풀 크기를 컴퓨팅 노드 0으로 조정하기 시작합니다. 기존 컴퓨팅 노드에서 실행되는 모든 작업은 종료되고 다시 큐에 추가됩니다(기본 다시 큐 옵션으로 풀 크기 조정 작업이 요청된 것처럼). 마지막으로 풀이 시스템에서 제거됩니다. 실행 중인 작업은 다시 큐에 추가되므로 사용자는 작업을 업데이트하여 다른 풀을 대상으로 하여 이러한 작업을 다시 실행할 수 있습니다. 그런 다음 새 풀에서 작업을 실행할 수 있습니다. 다시 큐에 넣기 동작을 재정의하려면 풀을 삭제하기 전에 풀 크기를 0으로 줄이기 위해 명시적으로 풀 크기를 조정해야 합니다. 삭제 상태의 풀에서 업데이트, 패치 또는 삭제 API를 호출하는 경우 오류 코드 PoolBeingDeleted가 있는 HTTP 상태 코드 409로 실패합니다.

delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

삭제할 풀의 ID입니다.

pool_delete_options
PoolDeleteOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

disable_auto_scale

풀에 대한 자동 크기 조정을 사용하지 않도록 설정합니다.

disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

자동 크기 조정을 사용하지 않도록 설정할 풀의 ID입니다.

pool_disable_auto_scale_options
PoolDisableAutoScaleOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

enable_auto_scale

풀에 대해 자동 크기 조정을 사용하도록 설정합니다.

풀에서 크기 조정 작업이 진행 중인 경우 풀에서 자동 크기 조정을 사용하도록 설정할 수 없습니다. 풀의 자동 크기 조정을 현재 사용하지 않도록 설정한 경우 요청의 일부로 유효한 자동 크기 조정 수식을 지정해야 합니다. 풀의 자동 크기 조정을 이미 사용하도록 설정한 경우 새 자동 크기 조정 수식 및/또는 새 평가 간격을 지정할 수 있습니다. 30초마다 두 번 이상 동일한 풀에 대해 이 API를 호출할 수 없습니다.

enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

자동 크기 조정을 사용하도록 설정할 풀의 ID입니다.

auto_scale_formula
str
기본값: None

수식이 풀에 적용되기 전에 유효성을 검사합니다. 수식이 유효하지 않으면 Batch 서비스는 자세한 오류 정보가 포함된 요청을 거부합니다. 이 수식을 지정하는 방법에 대한 자세한 내용은 Azure Batch 풀()에서 자동으로 컴퓨팅 노드 크기 조정을https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling 참조하세요.

auto_scale_evaluation_interval
<xref:timedelta>
기본값: None

기본값은 15분입니다. 최소 및 최대값은 각각 5분 및 168시간입니다. 5분 미만 또는 168시간보다 큰 값을 지정하면 Batch 서비스는 잘못된 속성 값 오류로 요청을 거부합니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 400(잘못된 요청)입니다. 새 간격을 지정하면 기존 자동 크기 조정 평가 일정이 중지되고 새 자동 크기 조정 평가 일정이 시작되며 시작 시간은 이 요청이 실행된 시간입니다.

pool_enable_auto_scale_options
PoolEnableAutoScaleOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

evaluate_auto_scale

풀에서 자동 크기 조정 수식을 평가한 결과를 가져옵니다.

이 API는 풀에 수식을 적용하지 않고 결과를 반환하기 때문에 주로 자동 크기 조정 수식의 유효성을 검사하기 위한 것입니다. 수식을 평가하려면 풀에 자동 크기 조정을 사용하도록 설정해야 합니다.

evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

자동 크기 조정 수식을 평가할 풀의 ID입니다.

auto_scale_formula
str
필수

수식의 유효성이 검사되고 결과가 계산되지만 풀에는 적용되지 않습니다. 풀에 수식을 적용하려면 '풀에서 자동 크기 조정 사용'을 선택합니다. 이 수식을 지정하는 방법에 대한 자세한 내용은 Azure Batch 풀()에서 자동으로 컴퓨팅 노드 크기 조정을https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling 참조하세요.

pool_evaluate_auto_scale_options
PoolEvaluateAutoScaleOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

autoScaleRun 또는 ClientRawResponse if raw=true

반환 형식

예외

exists

풀의 기본 속성을 가져옵니다.

exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

가져올 풀의 ID입니다.

pool_exists_options
PoolExistsOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

bool 또는 ClientRawResponse if raw=true

반환 형식

bool,

예외

get

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

get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

가져올 풀의 ID입니다.

pool_get_options
PoolGetOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

cloudPool 또는 ClientRawResponse if raw=true

반환 형식

예외

list

지정된 계정의 모든 풀을 나열합니다.

list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_list_options
PoolListOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

CloudPool의 instance 같은 반복기

반환 형식

예외

list_usage_metrics

지정된 계정에 대해 개별 시간 간격에 걸쳐 풀로 집계된 사용 메트릭을 나열합니다.

poolId를 포함하여 $filter 절을 지정하지 않으면 반환된 집계 간격의 시간 범위에서 계정에 존재했던 모든 풀이 응답에 포함됩니다. startTime 또는 endTime을 포함하여 $filter 절을 지정하지 않으면 이러한 필터는 기본적으로 현재 사용 가능한 마지막 집계 간격의 시작 및 종료 시간으로 설정됩니다. 즉, 마지막 집계 간격만 반환됩니다.

list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_list_usage_metrics_options
PoolListUsageMetricsOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

PoolUsageMetrics의 instance 같은 반복기

반환 형식

예외

patch

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

이는 요청에 지정된 풀 속성만 대체합니다. 예를 들어 풀에 연결된 StartTask가 있고 요청이 StartTask 요소를 지정하지 않는 경우 풀은 기존 StartTask를 유지합니다.

patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

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

pool_patch_parameter
PoolPatchParameter
필수

요청에 대한 매개 변수입니다.

pool_patch_options
PoolPatchOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

remove_nodes

지정된 풀에서 컴퓨팅 노드를 제거합니다.

이 작업은 풀의 할당 상태가 안정적일 때만 실행할 수 있습니다. 이 작업이 실행되면 할당 상태가 안정에서 크기 조정으로 변경됩니다. 각 요청은 최대 100개의 노드를 제거할 수 있습니다.

remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

컴퓨팅 노드를 제거할 풀의 ID입니다.

node_remove_parameter
NodeRemoveParameter
필수

요청에 대한 매개 변수입니다.

pool_remove_nodes_options
PoolRemoveNodesOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

resize

풀에 할당된 컴퓨팅 노드 수를 변경합니다.

할당 상태가 안정적인 경우에만 풀의 크기를 조정할 수 있습니다. 풀의 크기가 이미 조정된 경우 상태 코드 409로 요청이 실패합니다. 풀 크기를 조정하면 풀의 할당 상태가 안정적에서 크기 조정으로 변경됩니다. 자동 크기 조정을 위해 구성된 풀의 크기를 조정할 수 없습니다. 이 작업을 수행하려고 하면 Batch 서비스에서 오류 409를 반환합니다. 풀 크기를 아래쪽으로 조정하는 경우 Batch 서비스는 제거할 컴퓨팅 노드를 선택합니다. 특정 컴퓨팅 노드를 제거하려면 풀 제거 컴퓨팅 노드 API를 대신 사용합니다.

resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

크기를 조정할 풀의 ID입니다.

pool_resize_parameter
PoolResizeParameter
필수

요청에 대한 매개 변수입니다.

pool_resize_options
PoolResizeOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

stop_resize

풀에서 진행 중인 크기 조정 작업을 중지합니다.

이렇게 하면 크기 조정 작업 전에 풀이 이전 상태로 복원되지 않습니다. 추가 변경 내용만 중지하고 풀은 현재 상태를 유지합니다. 중지한 후 풀은 중지 작업이 완료되었을 때의 컴퓨팅 노드 수로 안정화됩니다. 중지 작업 중에 풀 할당 상태가 먼저 중지로 변경된 다음 안정적으로 변경됩니다. 크기 조정 작업은 명시적 크기 조정 풀 요청이 아니어야 합니다. 이 API를 사용하여 풀을 만들 때 풀의 초기 크기 조정을 중지할 수도 있습니다.

stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

크기 조정을 중지하려는 풀의 ID입니다.

pool_stop_resize_options
PoolStopResizeOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

update_properties

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

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

update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)

매개 변수

pool_id
str
필수

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

pool_update_properties_parameter
PoolUpdatePropertiesParameter
필수

요청에 대한 매개 변수입니다.

pool_update_properties_options
PoolUpdatePropertiesOptions
기본값: None

작업에 대한 추가 매개 변수

custom_headers
dict
기본값: None

요청에 추가될 헤더

raw
bool
기본값: False

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

operation_config
필수

작업 구성 재정의.

반환

raw=true인 경우 None 또는 ClientRawResponse

반환 형식

None,

예외

특성

models

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