你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
PoolOperations 类
PoolOperations 操作。
不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建该类并将其附加为属性。
- 继承
-
builtins.objectPoolOperations
构造函数
PoolOperations(client, config, serializer, deserializer)参数
- client
服务请求的客户端。
- config
服务客户端的配置。
- serializer
对象模型序列化程序。
- deserializer
对象模型反序列化程序。
变量
- api_version
要用于请求的 API 版本。 常量值：“2023-05-01.17.0”。
方法
| add |
将池添加到指定的帐户。 命名池时，请避免包括敏感信息，如用户名或机密项目名称。 此信息可能会出现在可供 Microsoft 支持部门工程师访问的遥测日志中。 |
| delete |
从指定的帐户中删除池。 请求删除池时，将执行以下操作：池状态设置为“删除”;池上正在进行的调整大小操作都已停止;Batch 服务开始将池大小调整为零计算节点;在现有计算节点上运行的任何任务 (终止并重新排队，就好像已使用默认的重新排队选项) 请求重排池操作一样;最后，池将从系统中删除。 由于正在运行的任务已重新排队，因此用户可以通过更新其作业以面向其他池来重新运行这些任务。 然后，任务可以在新池上运行。 如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。 如果在处于删除状态的池上调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码 PoolBeingDeleted。 |
| disable_auto_scale |
禁用池的自动缩放。 |
| enable_auto_scale |
为池启用自动缩放。 如果在池上执行重设大小操作，则无法对池启用自动缩放。 如果池的自动缩放当前已禁用，则必须在请求中指定有效的自动缩放公式。 如果已启用池的自动缩放，则可以指定新的自动缩放公式和/或新的评估间隔。 对于同一池，不能每 30 秒多次调用此 API。 |
| evaluate_auto_scale |
获取计算池上的自动缩放公式的结果。 此 API 主要用于验证自动缩放公式，因为它只需返回结果，而不将公式应用于池。 池必须启用自动缩放才能计算公式。 |
| exists |
获取池的基本属性。 |
| get |
获取有关指定池的信息。 |
| list |
列出指定帐户中的所有池。 |
| list_usage_metrics |
列出指定帐户的使用情况指标，按池跨各个时间间隔聚合。 如果未指定包含 poolId 的 $filter 子句，则响应将在返回的聚合间隔的时间范围内包括 Account 中存在的所有池。 如果未指定包含 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)参数
- operation_config
操作配置替代。
返回
如果 raw=true，则为 None 或 ClientRawResponse
返回类型
例外
delete
从指定的帐户中删除池。
请求删除池时，将执行以下操作：池状态设置为“删除”;池上正在进行的调整大小操作都已停止;Batch 服务开始将池大小调整为零计算节点;在现有计算节点上运行的任何任务 (终止并重新排队，就好像已使用默认的重新排队选项) 请求重排池操作一样;最后，池将从系统中删除。 由于正在运行的任务已重新排队，因此用户可以通过更新其作业以面向其他池来重新运行这些任务。 然后，任务可以在新池上运行。 如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。 如果在处于删除状态的池上调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码 PoolBeingDeleted。
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
如果 raw=true，则为 None 或 ClientRawResponse
返回类型
例外
disable_auto_scale
禁用池的自动缩放。
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
如果 raw=true，则为 None 或 ClientRawResponse
返回类型
例外
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)参数
- auto_scale_formula
- str
在将公式应用到池之前，将检查公式的有效性。 如果公式无效，Batch 服务会拒绝包含详细错误信息的请求。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。
- auto_scale_evaluation_interval
- <xref:timedelta>
默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将拒绝请求并显示无效的属性值错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。 如果指定新间隔，则会停止现有的自动缩放评估计划，并启动新的自动缩放评估计划，其启动时间是发出此请求的时间。
- operation_config
操作配置替代。
返回
如果 raw=true，则为 None 或 ClientRawResponse
返回类型
例外
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)参数
- auto_scale_formula
- str
公式经过验证并计算其结果，但不应用于池。 若要将公式应用于池，请在池上启用自动缩放。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。
- operation_config
操作配置替代。
返回
AutoScaleRun 或 ClientRawResponse（如果 raw=true）
返回类型
例外
exists
获取池的基本属性。
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
bool 或 ClientRawResponse（如果 raw=true）
返回类型
例外
get
获取有关指定池的信息。
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
如果 raw=true，则为 CloudPool 或 ClientRawResponse
返回类型
例外
list
列出指定帐户中的所有池。
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
一个迭代器，例如 CloudPool 的实例
返回类型
例外
list_usage_metrics
列出指定帐户的使用情况指标，按池跨各个时间间隔聚合。
如果未指定包含 poolId 的 $filter 子句，则响应将在返回的聚合间隔的时间范围内包括 Account 中存在的所有池。 如果未指定包含 startTime 或 endTime 的 $filter 子句，则这些筛选器默认为当前可用的最后一个聚合间隔的开始和结束时间;也就是说，仅返回最后一个聚合间隔。
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
一个迭代器，如 PoolUsageMetrics 的实例
返回类型
例外
patch
汇报指定池的属性。
这仅替换请求中指定的池属性。 例如，如果池具有与之关联的 StartTask，并且请求未指定 StartTask 元素，则池将保留现有的 StartTask。
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
remove_nodes
从指定的池中删除计算节点。
只有在池的分配状态稳定时，才能运行此操作。 运行此操作时，分配状态将从“稳定”更改为“调整大小”。 每个请求最多可以删除 100 个节点。
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
resize
更改分配给池的计算节点数。
只能在池的分配状态稳定时调整其大小。 如果池已调整大小，请求将失败，状态代码为 409。 调整池大小时，池的分配状态将从稳定更改为调整大小。 无法调整为自动缩放配置的池的大小。 如果尝试执行此操作，Batch 服务将返回错误 409。 如果向下调整池的大小，Batch 服务将选择要删除的计算节点。 若要删除特定的计算节点，请改用池删除计算节点 API。
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
stop_resize
停止对池正在进行的重设大小操作。
这不会在重设大小操作之前将池还原到其以前的状态：它只会停止所做的任何进一步更改，并且池会保持其当前状态。 停止后，池将稳定在完成停止操作时位于的计算节点数处。 在停止操作期间，池分配状态首先更改为“正在停止”，然后更改为“稳定”。 调整大小操作不需要是显式调整池大小请求;此 API 还可用于在创建池时停止池的初始大小调整。
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
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)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
属性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>