共用方式為

TaskTerminateOptions 類別

  • 參考

終止作業的其他參數。

繼承
Model
TaskTerminateOptions

建構函式

TaskTerminateOptions(*, timeout: int = 30, client_request_id: str = None, return_client_request_id: bool = False, ocp_date=None, if_match: str = None, if_none_match: str = None, if_modified_since=None, if_unmodified_since=None, **kwargs)

參數

timeout
int
必要

伺服器可以花費在數秒內處理要求的時間上限。 預設值為 30 秒。 預設值：30 。

client_request_id
str
必要

呼叫端產生的要求身分識別，格式為不含大括弧的 GUID，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。

return_client_request_id
bool
必要

伺服器是否應該在回應中傳回 client-request-id。 預設值：False 。

ocp_date
datetime
必要

發出要求的時間。 用戶端程式庫通常會將此設定為目前的系統時鐘時間;如果您直接呼叫 REST API，請明確設定它。

if_match
str
必要

與用戶端已知的資源版本相關聯的 ETag 值。 只有在服務的目前 ETag 與用戶端所指定的值完全相符時，才會執行作業。

if_none_match
str
必要

與用戶端已知的資源版本相關聯的 ETag 值。 只有在服務的目前 ETag 不符合用戶端所指定的值時，才會執行作業。

if_modified_since
datetime
必要

時間戳記，指出用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行作業。

if_unmodified_since
datetime
必要

時間戳記，指出用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時，才會執行作業。

方法

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 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。
validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 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=True, key_transformer=<function attribute_transformer>, **kwargs)

參數

key_transformer
<xref:function>

按鍵轉換程式函式。

keep_readonly
預設值: True

傳回

聽寫 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

使用指定的索引鍵擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (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 結構的聽寫

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

如果您想要序列化唯讀屬性

傳回

聽寫 JSON 相容物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list