你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Metrics 类
按 API 按小时或分钟聚合分组的请求统计信息摘要。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
azure.storage.queue._generated.models._models_py3.MetricsMetrics
构造函数
Metrics(**kwargs: Any)
仅限关键字的参数
名称 | 说明 |
---|---|
version
|
要配置的存储分析版本。 |
enabled
|
必需。 指示是否为服务启用指标。 |
include_apis
|
指示度量值是否应为调用的 API 操作生成汇总统计信息。 |
retention_policy
|
指标的保留策略。 |
方法
as_dict |
返回可以使用 json.dump 序列化的 dict。 高级用法可以选择使用回调作为参数: Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此 对象中的当前值。 返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果 dict。 请参阅此文件中的三个示例:
如果需要 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。 |
as_dict
返回可以使用 json.dump 序列化的 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]
参数
名称 | 说明 |
---|---|
key_transformer
|
<xref:function>
密钥转换器函数。 |
keep_readonly
|
默认值: True
|
返回
类型 | 说明 |
---|---|
与 dict JSON 兼容的对象 |
deserialize
使用 RestAPI 语法分析 str 并返回模型。
deserialize(data: Any, content_type: str | None = None) -> ModelType
参数
名称 | 说明 |
---|---|
data
必需
|
使用 RestAPI 结构的 str。 默认情况下为 JSON。 |
content_type
|
默认情况下,如果为 XML,则设置 application/xml。 默认值: None
|
返回
类型 | 说明 |
---|---|
此模型的实例 |
例外
类型 | 说明 |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
使用给定的键提取程序分析 dict 会返回模型。
默认情况下,请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)
from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType
参数
名称 | 说明 |
---|---|
data
必需
|
使用 RestAPI 结构的 dict |
content_type
|
默认情况下,如果为 XML,则设置 application/xml。 默认值: None
|
key_extractors
|
默认值: None
|
返回
类型 | 说明 |
---|---|
此模型的实例 |
例外
类型 | 说明 |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
返回将从此模型发送到 Azure 的 JSON。
这是 as_dict (full_restapi_key_transformer 的别名 ,keep_readonly=False) 。
如果需要 XML 序列化,可以传递 kwargs is_xml=True。
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
参数
名称 | 说明 |
---|---|
keep_readonly
|
如果要序列化只读属性 默认值: False
|
返回
类型 | 说明 |
---|---|
与 dict JSON 兼容的对象 |
属性
enabled
指示是否为服务启用指标。
enabled: bool = False
include_apis
指示度量值是否应为调用的 API 操作生成汇总统计信息。
include_apis: bool | None
retention_policy
指标的保留策略。
retention_policy: RetentionPolicy = <azure.storage.queue._models.RetentionPolicy object>
version
要配置的存储分析版本。
version: str = '1.0'