通过

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

ImageReference 类

  • 参考

对 Azure 虚拟机 市场映像或共享映像库映像的引用。 若要获取Azure Batch验证的所有Azure 市场图像引用的列表，请参阅“列出支持的映像”操作。

变量仅由服务器填充，在发送请求时将被忽略。

继承
Model
ImageReference

构造函数

ImageReference(*, publisher: str = None, offer: str = None, sku: str = None, version: str = None, virtual_machine_image_id: str = None, **kwargs)

参数

publisher
str
必需

例如，Canonical 或 MicrosoftWindowsServer。

offer
str
必需

例如，UbuntuServer 或 WindowsServer。

sku
str
必需

例如，18.04-LTS 或 2019-Datacenter。

version
str
必需

可以指定“latest”值以选择映像的最新版本。 如果省略，则默认值为“latest”。

virtual_machine_image_id
str
必需

此属性与其他 ImageReference 属性互斥。 共享映像库映像必须在同一区域中具有副本，并且必须与 Azure Batch 帐户位于同一订阅中。 如果未在 imageId 中指定映像版本，则将使用最新版本。 有关 Batch 计算节点代理与 Batch 服务通信的防火墙设置的信息，请参阅 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration。

变量

exact_version
str

用于创建节点的平台映像或市场映像的特定版本。 仅当创建池时为“version”指定的值为“latest”时，此只读字段才与“version”不同。

方法

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

返回

与 dict JSON 兼容的对象

返回类型

dict

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 兼容的对象

返回类型

dict

validate

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

validate()

返回

验证错误列表

返回类型

list