你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

PoolUpdatePropertiesParameter 类

要对池进行的更改集。

必须填充所有必需的参数才能发送到 Azure。

继承
PoolUpdatePropertiesParameter

构造函数

PoolUpdatePropertiesParameter(*, certificate_references, application_package_references, metadata, start_task=None, target_node_communication_mode=None, **kwargs)

参数

start_task
StartTask
必需

加入池时要在每个计算节点上运行的任务。 将计算节点添加到池或重启计算节点时,任务将运行。 如果存在此元素,它将覆盖任何现有的 StartTask。 如果省略,则会从池中删除任何现有的 StartTask。

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]
必需

必需。 该列表替换池上的任何现有应用程序包引用。 对应用程序包引用的更改会影响加入池的所有新计算节点,但在重新启动或重置映像之前,不会影响池中已有的计算节点。 任何给定池上最多有 10 个应用程序包引用。 如果省略或指定空集合,则会从池中删除所有现有的应用程序包引用。 在给定的池上最多可以指定 10 个引用。

metadata
list[MetadataItem]
必需

必需。 此列表替换池上配置的任何现有元数据。 如果省略或指定空集合,则会从池中删除任何现有元数据。

target_node_communication_mode
strNodeCommunicationMode
必需

池的所需节点通信模式。 此设置将替换池上的任何现有 targetNodeCommunication 设置。 如果省略,则默认为现有设置。 可能的值包括:“default”、“classic”、“simplified”

方法

as_dict

使用 json.dump 返回可以是 JSONify 的 dict。

高级用法可以选择使用回调作为参数:

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此 对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果 dict。

请参阅此文件中的三个示例:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果需要 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”。 Value 是此 对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果 dict。

请参阅此文件中的三个示例:

  • 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
默认值: True

返回

与 dict JSON 兼容的对象

返回类型

deserialize

使用 RestAPI 语法分析 str 并返回模型。

deserialize(data, content_type=None)

参数

data
str
必需

使用 RestAPI 结构的 str。 默认情况下为 JSON。

content_type
str
默认值: None

默认情况下,如果为 XML,则设置 application/xml。

返回

此模型的实例

例外

DeserializationError if something went wrong

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)

参数

data
dict
必需

使用 RestAPI 结构的 dict

content_type
str
默认值: None

默认情况下,如果为 XML,则设置 application/xml。

key_extractors
默认值: None

返回

此模型的实例

例外

DeserializationError if something went wrong

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)

参数

keep_readonly
bool
默认值: False

如果要序列化只读属性

返回

与 dict JSON 兼容的对象

返回类型

validate

以递归方式验证此模型,并返回 ValidationError 列表。

validate()

返回

验证错误列表

返回类型