PoolOperations Класс

Операции PoolOperations.

Не следует создавать экземпляр этого класса напрямую, а создавать экземпляр клиента, который создаст его автоматически и вложит в качестве атрибута.

Наследование

builtins.object

PoolOperations

Конструктор

PoolOperations(client, config, serializer, deserializer)

Параметры

client

Обязательно

Клиент для запросов на обслуживание.

config

Обязательно

Настройка клиента службы.

serializer

Обязательно

Сериализатор объектной модели.

deserializer

Обязательно

Десериализатор объектной модели.

Переменные

api_version

Версия API для использования в запросе. Постоянное значение: "2023-05-01.17.0".

Методы

add	Добавляет пул в указанную учетную запись. При именовании пулов не включайте конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эти сведения могут отображаться в журналах телеметрии, доступных инженерам службы поддержки Майкрософт.
delete	Удаляет пул из указанной учетной записи. При запросе на удаление пула выполняются следующие действия: состояние пула — удаление; любая текущая операция изменения размера в пуле останавливается; Пакетная служба начинает изменять размер пула до нуля вычислительных узлов; все задачи, выполняемые на существующих вычислительных узлах, завершаются и отправляются в очередь (как если бы была запрошена операция изменения размера пула с параметром повторной очереди по умолчанию); наконец, пул удаляется из системы. Так как выполняемые задачи выполняются повторно, пользователь может повторно выполнить эти задачи, обновив задание для другого пула. Затем задачи могут выполняться в новом пуле. Если вы хотите переопределить поведение повторной отправки, необходимо явно вызвать изменение размера пула, чтобы уменьшить размер пула до нуля перед удалением пула. При вызове API обновления, исправления или удаления в пуле в состоянии удаления произойдет сбой с кодом состояния HTTP 409 с кодом ошибки PoolBeingDeleted.
disable_auto_scale	Отключает автоматическое масштабирование для пула.
enable_auto_scale	Включает автоматическое масштабирование для пула. Вы не можете включить автоматическое масштабирование в пуле, если в пуле выполняется операция изменения размера. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Вы не можете вызывать этот API для одного и того же пула более одного раза в 30 секунд.
evaluate_auto_scale	Возвращает результат вычисления формулы автоматического масштабирования в пуле. Этот API в первую очередь предназначен для проверки формулы автомасштабирования, так как он просто возвращает результат без применения формулы к пулу. Для вычисления формулы в пуле должно быть включено автоматическое масштабирование.
exists	Возвращает основные свойства пула.
get	Возвращает сведения об указанном пуле.
list	Выводит список всех пулов в указанной учетной записи.
list_usage_metrics	Перечисляет метрики использования, агрегированные по пулу за отдельные интервалы времени для указанной учетной записи. Если не указать предложение $filter, включая poolId, ответ включает все пулы, существующие в учетной записи, в диапазоне времени возвращаемых интервалов агрегирования. Если не указать предложение $filter, включая startTime или endTime, эти фильтры по умолчанию определяют время начала и окончания последнего доступного интервала агрегирования; то есть возвращается только последний интервал агрегирования.
patch	Обновления свойства указанного пула. Это только заменяет свойства пула, указанные в запросе. Например, если с пулом связана задача StartTask, а в запросе не указан элемент StartTask, то пул сохраняет существующий элемент StartTask.
remove_nodes	Удаляет вычислительные узлы из указанного пула. Эта операция может выполняться только в том случае, если состояние выделения пула стабильное. При выполнении этой операции состояние выделения изменяется с устойчивого на изменение размера. Каждый запрос может удалить до 100 узлов.
resize	Изменяет количество вычислительных узлов, назначенных пулу. Размер пула можно изменять только в том случае, если его состояние выделения стабильное. Если размер пула уже изменяется, запрос завершается ошибкой с кодом состояния 409. При изменении размера пула состояние распределения пула меняется с устойчивого на изменение размера. Невозможно изменить размер пулов, настроенных для автоматического масштабирования. При попытке сделать это пакетная служба возвращает ошибку 409. При уменьшении размера пула пакетная служба выбирает, какие вычислительные узлы следует удалить. Чтобы удалить определенные вычислительные узлы, используйте API удаления пула вычислительных узлов.
stop_resize	Останавливает текущую операцию изменения размера в пуле. Это не приводит к восстановлению предыдущего состояния пула до операции изменения размера: он только останавливает дальнейшие изменения, и пул сохраняет свое текущее состояние. После остановки пул стабилизируется при количестве вычислительных узлов, на которых он находился на момент завершения операции остановки. Во время операции остановки состояние выделения пула сначала изменяется на остановленное, а затем на устойчивое. Операция изменения размера не обязательно должна быть явным запросом на изменение размера пула; этот API также можно использовать для остановки начального изменения размера пула при его создании.
update_properties	Обновления свойства указанного пула. Это полностью заменяет все обновляемые свойства пула. Например, если с пулом связана задача StartTask и параметр StartTask не указан в этом запросе, то пакетная служба удалит существующий элемент StartTask.

add

Добавляет пул в указанную учетную запись.

При именовании пулов не включайте конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эти сведения могут отображаться в журналах телеметрии, доступных инженерам службы поддержки Майкрософт.

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

delete

Удаляет пул из указанной учетной записи.

При запросе на удаление пула выполняются следующие действия: состояние пула — удаление; любая текущая операция изменения размера в пуле останавливается; Пакетная служба начинает изменять размер пула до нуля вычислительных узлов; все задачи, выполняемые на существующих вычислительных узлах, завершаются и отправляются в очередь (как если бы была запрошена операция изменения размера пула с параметром повторной очереди по умолчанию); наконец, пул удаляется из системы. Так как выполняемые задачи выполняются повторно, пользователь может повторно выполнить эти задачи, обновив задание для другого пула. Затем задачи могут выполняться в новом пуле. Если вы хотите переопределить поведение повторной отправки, необходимо явно вызвать изменение размера пула, чтобы уменьшить размер пула до нуля перед удалением пула. При вызове API обновления, исправления или удаления в пуле в состоянии удаления произойдет сбой с кодом состояния HTTP 409 с кодом ошибки PoolBeingDeleted.

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

Параметры

pool_id

str

Обязательно

Идентификатор удаляемого пула.

pool_delete_options

PoolDeleteOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

disable_auto_scale

Отключает автоматическое масштабирование для пула.

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

Параметры

pool_id

str

Обязательно

Идентификатор пула, в котором отключается автоматическое масштабирование.

pool_disable_auto_scale_options

PoolDisableAutoScaleOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

enable_auto_scale

Включает автоматическое масштабирование для пула.

Вы не можете включить автоматическое масштабирование в пуле, если в пуле выполняется операция изменения размера. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Вы не можете вызывать этот API для одного и того же пула более одного раза в 30 секунд.

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

Обязательно

Идентификатор пула, для которого необходимо включить автоматическое масштабирование.

auto_scale_formula

str

значение по умолчанию: None

Формула проверяется на допустимость перед применением к пулу. Если формула недопустимая, пакетная служба отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в статье Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

auto_scale_evaluation_interval

<xref:timedelta>

значение по умолчанию: None

Значение по умолчанию — 15 минут. Минимальное и максимальное значения — 5 минут и 168 часов соответственно. Если указать значение меньше 5 минут или больше 168 часов, пакетная служба отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Если указать новый интервал, то существующее расписание оценки автомасштабирования будет остановлено и будет запущено новое расписание оценки автомасштабирования, а его начальным временем является время выдачи этого запроса.

pool_enable_auto_scale_options

PoolEnableAutoScaleOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

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

Обязательно

Идентификатор пула, в котором вычисляет формулу автоматического масштабирования.

auto_scale_formula

str

Обязательно

Формула проверяется и вычисляется ее результаты, но не применяется к пулу. Чтобы применить формулу к пулу, включите автоматическое масштабирование в пуле. Дополнительные сведения об указании этой формулы см. в статье Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure (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, если raw=true

Возвращаемый тип

AutoScaleRun,

ClientRawResponse

Исключения

BatchErrorException

exists

Возвращает основные свойства пула.

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

Параметры

pool_id

str

Обязательно

Идентификатор пула, который требуется получить.

pool_exists_options

PoolExistsOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

bool или ClientRawResponse, если raw=true

Возвращаемый тип

bool,

ClientRawResponse

Исключения

BatchErrorException

get

Возвращает сведения об указанном пуле.

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

Параметры

pool_id

str

Обязательно

Идентификатор пула, который требуется получить.

pool_get_options

PoolGetOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

CloudPool или ClientRawResponse, если raw=true

Возвращаемый тип

CloudPool,

ClientRawResponse

Исключения

BatchErrorException

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

Возвращаемый тип

CloudPoolPaged[CloudPool]

Исключения

BatchErrorException

list_usage_metrics

Перечисляет метрики использования, агрегированные по пулу за отдельные интервалы времени для указанной учетной записи.

Если не указать предложение $filter, включая poolId, ответ включает все пулы, существующие в учетной записи, в диапазоне времени возвращаемых интервалов агрегирования. Если не указать предложение $filter, включая startTime или endTime, эти фильтры по умолчанию определяют время начала и окончания последнего доступного интервала агрегирования; то есть возвращается только последний интервал агрегирования.

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

Возвращаемый тип

PoolUsageMetricsPaged[PoolUsageMetrics]

Исключения

BatchErrorException

patch

Обновления свойства указанного пула.

Это только заменяет свойства пула, указанные в запросе. Например, если с пулом связана задача StartTask, а в запросе не указан элемент StartTask, то пул сохраняет существующий элемент StartTask.

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

Параметры

pool_id

str

Обязательно

Идентификатор обновляемого пула.

pool_patch_parameter

PoolPatchParameter

Обязательно

Параметры для запроса.

pool_patch_options

PoolPatchOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

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

Обязательно

Идентификатор пула, из которого требуется удалить вычислительные узлы.

node_remove_parameter

NodeRemoveParameter

Обязательно

Параметры для запроса.

pool_remove_nodes_options

PoolRemoveNodesOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

resize

Изменяет количество вычислительных узлов, назначенных пулу.

Размер пула можно изменять только в том случае, если его состояние выделения стабильное. Если размер пула уже изменяется, запрос завершается ошибкой с кодом состояния 409. При изменении размера пула состояние распределения пула меняется с устойчивого на изменение размера. Невозможно изменить размер пулов, настроенных для автоматического масштабирования. При попытке сделать это пакетная служба возвращает ошибку 409. При уменьшении размера пула пакетная служба выбирает, какие вычислительные узлы следует удалить. Чтобы удалить определенные вычислительные узлы, используйте API удаления пула вычислительных узлов.

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

Параметры

pool_id

str

Обязательно

Идентификатор пула для изменения размера.

pool_resize_parameter

PoolResizeParameter

Обязательно

Параметры для запроса.

pool_resize_options

PoolResizeOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

stop_resize

Останавливает текущую операцию изменения размера в пуле.

Это не приводит к восстановлению предыдущего состояния пула до операции изменения размера: он только останавливает дальнейшие изменения, и пул сохраняет свое текущее состояние. После остановки пул стабилизируется при количестве вычислительных узлов, на которых он находился на момент завершения операции остановки. Во время операции остановки состояние выделения пула сначала изменяется на остановленное, а затем на устойчивое. Операция изменения размера не обязательно должна быть явным запросом на изменение размера пула; этот API также можно использовать для остановки начального изменения размера пула при его создании.

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

Параметры

pool_id

str

Обязательно

Идентификатор пула, размер которого требуется остановить.

pool_stop_resize_options

PoolStopResizeOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

update_properties

Обновления свойства указанного пула.

Это полностью заменяет все обновляемые свойства пула. Например, если с пулом связана задача StartTask и параметр StartTask не указан в этом запросе, то пакетная служба удалит существующий элемент StartTask.

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

Параметры

pool_id

str

Обязательно

Идентификатор обновляемого пула.

pool_update_properties_parameter

PoolUpdatePropertiesParameter

Обязательно

Параметры для запроса.

pool_update_properties_options

PoolUpdatePropertiesOptions

значение по умолчанию: None

Дополнительные параметры для операции

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

BatchErrorException

Атрибуты

models

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