Share via


OperationStatus クラス

操作状態オブジェクト。 操作とは、スナップショットの取得やスナップショットの適用を含む非同期バックエンド タスクを指します。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承
OperationStatus

コンストラクター

OperationStatus(*, status, created_time, last_action_time=None, resource_location: str = None, message: str = None, **kwargs)

パラメーター

status
str または OperationStatusType
必須

必須。 操作の状態: 未開始、実行中、成功、失敗。 操作が要求され、実行を待機している場合、状態は開始されません。 操作がバックエンドで進行中の場合、状態は実行中です。 状態が成功したとは、操作が正常に完了したことを意味します。具体的には、スナップショット スナップショットが適切に実行され、適用する準備ができていることを示し、スナップショット適用操作では、ターゲット オブジェクトがスナップショットによって作成が完了し、使用する準備ができたことを示します。 状態の失敗は、多くの場合、スナップショットを取得中にソース オブジェクトを編集したり、完了前にスナップショットを適用しているときにターゲット オブジェクトを編集したりすることによって発生します。エラーの理由をチェックするには、フィールド "message" を参照してください。 使用可能な値には、'notstarted'、'running'、'succeeded'、'failed' などがあります。

created_time
datetime
必須

必須。 操作が要求された時刻 (スナップショットを受け取るか適用する) を記述する UTC の日付と時刻の組み合わせ文字列。 例: 2018-12-25T11:41:02.2331413Z。

last_action_time
datetime
必須

操作が最後にデータを移行する (スナップショットを取得または適用する) ことを示す UTC 日付と時刻の組み合わせ文字列。 lastActionTime は、操作が完了するまで増加し続けます。 例: 2018-12-25T11:51:27.8705696Z。

resource_location
str
必須

操作が正常に成功すると、スナップショット操作の場合、スナップショット ID がこのフィールドに含まれ、操作を適用スナップショット場合は、このフィールドにターゲット オブジェクトを取得するためのパスが返されます。

message
str
必須

操作が失敗した場合にエラー メッセージを表示します (操作が成功した場合は省略します)。

メソッド

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • 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 できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • 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

既定では JSON、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

既定では JSON、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()

戻り値

検証エラーの一覧

の戻り値の型 :