你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
PoolAddParameter 类
要添加的Azure Batch服务中的池。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
PoolAddParameter
构造函数
PoolAddParameter(*, id: str, vm_size: str, display_name: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, target_dedicated_nodes: int = None, target_low_priority_nodes: int = None, enable_auto_scale: bool = None, auto_scale_formula: str = None, auto_scale_evaluation_interval=None, enable_inter_node_communication: bool = None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, task_slots_per_node: int = None, task_scheduling_policy=None, user_accounts=None, metadata=None, mount_configuration=None, target_node_communication_mode=None, **kwargs)参数
- id
- str
必需。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是保留大小写且不区分大小写的 (即，帐户中可能没有两个仅因大小写) 而不同的池 ID。
- vm_size
- str
必需。 有关使用 cloudServiceConfiguration) 创建的云服务池 (池的可用虚拟机大小的信息，请参阅云服务 (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/) 的大小。 Batch 支持除 ExtraSmall、A1V2 和 A2V2 以外的所有云服务 VM 大小。 有关使用 virtualMachineConfiguration) 创建的虚拟机市场 (池的映像的池的可用 VM 大小的信息，请参阅适用于 虚拟机 (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) 或 虚拟机 (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/) 的大小。 Batch 支持除STANDARD_A0和具有高级存储 (STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列) 以外的所有 Azure VM 大小。
- cloud_service_configuration
- CloudServiceConfiguration
池的云服务配置。 此属性和 virtualMachineConfiguration 是互斥的，必须指定其中一个属性。 如果 Batch 帐户是在将 poolAllocationMode 属性设置为“UserSubscription”的情况下创建的，则无法指定此属性。
- virtual_machine_configuration
- VirtualMachineConfiguration
池的虚拟机配置。 此属性和 cloudServiceConfiguration 是互斥的，必须指定其中一个属性。
- resize_timeout
- <xref:timedelta>
此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时，它不起作用。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。
- target_dedicated_nodes
- int
池中所需专用计算节点数。 如果 enableAutoScale 设置为 true，则不得指定此属性。 如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes 和/或 targetLowPriorityNodes。
- target_low_priority_nodes
- int
池中所需的现成/低优先级计算节点数。 如果 enableAutoScale 设置为 true，则不得指定此属性。 如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes 和/或 targetLowPriorityNodes。
- enable_auto_scale
- bool
池大小是否应随时间自动调整。 如果为 false，则必须至少指定一个 targetDedicatedNodes 和 targetLowPriorityNodes。 如果为 true，则 autoScaleFormula 属性是必需的，池将根据公式自动调整大小。 默认值为 false。
- auto_scale_formula
- str
如果 enableAutoScale 设置为 false，则不得指定此属性。 如果 enableAutoScale 设置为 true，则是必需的。 在创建池之前，将检查公式的有效性。 如果公式无效，Batch 服务会拒绝包含详细错误信息的请求。 有关指定此公式的详细信息，请参阅“自动缩放Azure Batch池中的计算节点” (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) 。
- auto_scale_evaluation_interval
- <xref:timedelta>
默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。
- enable_inter_node_communication
- bool
池是否允许计算节点之间的直接通信。 启用节点间通信会限制池的最大大小，因为池的计算节点存在部署限制。 这可能会导致池未达到其所需大小。 默认值为 false。
- certificate_references
- list[CertificateReference]
对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在 Task 工作目录内的目录中，并向 Task 提供一个环境变量AZ_BATCH_CERTIFICATES_DIR来查询此位置。 对于“remoteUser”可见性的证书，在用户的主目录中创建一个“certs”目录， (例如 /home/{user-name}/certs) ，证书位于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。请改用 Azure KeyVault 扩展 。
- application_package_references
- list[ApplicationPackageReference]
创建池时，包的应用程序 ID 必须完全限定 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) 。 对包引用的更改会影响加入池的所有新节点，但在重新启动或重置映像之前，不会影响池中已存在的计算节点。 任何给定池中最多有 10 个包引用。
- user_accounts
- list[UserAccount]
- target_node_communication_mode
- str 或 NodeCommunicationMode
池的所需节点通信模式。 如果省略，默认值为 Default。 可能的值包括：“default”、“classic”、“simplified”
方法
| as_dict |
返回可以使用 json.dump 的 JSONify 的 dict。 高级用法可以选择使用回调作为参数： Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。 返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。 请参阅此文件中的三个示例：
如果需要 XML 序列化，可以传递 kwargs is_xml=True。 |
| deserialize |
使用 RestAPI 语法分析 str 并返回模型。 |
| enable_additional_properties_sending | |
| from_dict |
使用给定的键提取程序分析 dict 返回一个模型。 默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
返回将从此模型发送到 azure 的 JSON。 这是as_dict (full_restapi_key_transformer的别名 ，keep_readonly=False) 。 如果需要 XML 序列化，可以传递 kwargs is_xml=True。 |
| validate |
以递归方式验证此模型，并返回 ValidationError 列表。 |
as_dict
返回可以使用 json.dump 的 JSONify 的 dict。
高级用法可以选择使用回调作为参数：
Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。
返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。
请参阅此文件中的三个示例：
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
如果需要 XML 序列化，可以传递 kwargs is_xml=True。
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)参数
- key_transformer
- <xref:function>
密钥转换器函数。
- keep_readonly
返回
与 dict JSON 兼容的对象
返回类型
deserialize
使用 RestAPI 语法分析 str 并返回模型。
deserialize(data, content_type=None)参数
返回
此模型的实例
例外
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
使用给定的键提取程序分析 dict 返回一个模型。
默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)参数
- key_extractors
返回
此模型的实例
例外
is_xml_model
is_xml_model()serialize
返回将从此模型发送到 azure 的 JSON。
这是as_dict (full_restapi_key_transformer的别名 ，keep_readonly=False) 。
如果需要 XML 序列化，可以传递 kwargs is_xml=True。
serialize(keep_readonly=False, **kwargs)参数
返回
与 dict JSON 兼容的对象
