QueueAnalyticsLogging 類別
Azure 分析記錄設定。
必須填入所有必要的參數,才能傳送至 Azure。
- 繼承
-
azure.storage.queue._generated.models._models_py3.LoggingQueueAnalyticsLogging
建構函式
QueueAnalyticsLogging(**kwargs: Any)
僅限關鍵字的參數
名稱 | Description |
---|---|
version
|
必要。 要設定的儲存體分析版本。 |
delete
|
必要。 指出是否需記錄所有刪除要求。 |
read
|
必要。 指出是否應該需記錄所有讀取要求。 |
write
|
必要。 指出是否需記錄所有寫入要求。 |
retention_policy
|
計量的保留原則。 |
方法
as_dict |
傳回可使用 json.dump 序列化的聽寫。 進階用法可以選擇性地使用回呼作為參數: 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例:
如果您想要 XML 序列化,您可以傳遞 kwargs is_xml=True。 |
deserialize |
使用 RestAPI 語法剖析 str 並傳回模型。 |
enable_additional_properties_sending | |
from_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 序列化的聽寫。
進階用法可以選擇性地使用回呼作為參數:
索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例:
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]
參數
名稱 | Description |
---|---|
key_transformer
|
<xref:function>
按鍵轉換程式函式。 |
keep_readonly
|
預設值: True
|
傳回
類型 | Description |
---|---|
聽寫 JSON 相容物件 |
deserialize
使用 RestAPI 語法剖析 str 並傳回模型。
deserialize(data: Any, content_type: str | None = None) -> ModelType
參數
名稱 | Description |
---|---|
data
必要
|
使用 RestAPI 結構的 str。 根據預設,JSON。 |
content_type
|
根據預設,如果 XML,請設定 application/xml。 預設值: None
|
傳回
類型 | Description |
---|---|
此模型的實例 |
例外狀況
類型 | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_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
參數
名稱 | Description |
---|---|
data
必要
|
使用 RestAPI 結構的聽寫 |
content_type
|
根據預設,如果 XML,請設定 application/xml。 預設值: None
|
key_extractors
|
預設值: None
|
傳回
類型 | Description |
---|---|
此模型的實例 |
例外狀況
類型 | Description |
---|---|
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]
參數
名稱 | Description |
---|---|
keep_readonly
|
如果您想要序列化唯讀屬性 預設值: False
|
傳回
類型 | Description |
---|---|
聽寫 JSON 相容物件 |
屬性
delete
指出是否需記錄所有刪除要求。
delete: bool = False
read
指出是否應該需記錄所有讀取要求。
read: bool = False
retention_policy
計量的保留原則。
retention_policy: RetentionPolicy = <azure.storage.queue._models.RetentionPolicy object>
version
要設定的儲存體分析版本。
version: str = '1.0'
write
指出是否需記錄所有寫入要求。
write: bool = False