JobProperties クラス

  • リファレンス

JobProperties。

継承
Model
JobProperties

コンストラクター

JobProperties(*, job_id: str = None, start_time_utc=None, end_time_utc=None, type=None, status=None, progress: int = None, input_blob_container_uri: str = None, input_blob_name: str = None, output_blob_container_uri: str = None, output_blob_name: str = None, exclude_keys_in_export: bool = None, storage_authentication_type=None, identity=None, failure_reason: str = None, include_configurations: bool = None, configurations_blob_name: str = None, **kwargs)

パラメーター

job_id
str
必須

ジョブの一意識別子。

start_time_utc
datetime
必須

システムが生成されました。 作成時に無視されます。 ジョブの開始日時 (UTC)。

end_time_utc
datetime
必須

システムが生成されました。 作成時に無視されます。 ジョブの終了日時 (UTC)。

type
str または <xref:protocol.models.enum>
必須

ジョブの種類。 使用可能な値には、'unknown'、'export'、'import'、'backup'、'readDeviceProperties'、'writeDeviceProperties'、'updateDeviceConfiguration'、'rebootDevice'、'factoryResetDevice'、'firmwareUpdate'、'scheduleDeviceMethod'、'scheduleUpdateTwin'、'restoreFromBackup'、'failoverDataCopy' などがあります。

status
str または <xref:protocol.models.enum>
必須

システムが生成されました。 作成時に無視されます。 ジョブの状態。 使用可能な値には、'unknown'、'enqueued'、'running'、'completed'、'failed'、'cancelled'、'scheduled'、'queued' などがあります。

progress
int
必須

システムが生成されました。 作成時に無視されます。 ジョブの完了率。

input_blob_container_uri
str
必須

同期するレジストリ データを含む BLOB コンテナーへの SAS トークンを含む URI。

input_blob_name
str
必須

入力 BLOB コンテナーからインポートするときに使用する BLOB 名。

output_blob_container_uri
str
必須

BLOB コンテナーにアクセスするための SAS トークン。 これは、ジョブの状態と結果を出力するために使用されます。

output_blob_name
str
必須

出力 BLOB コンテナーに作成される BLOB 名。 この BLOB には、IoT Hubのエクスポートされたデバイス レジストリ情報が含まれます。

exclude_keys_in_export
bool
必須

エクスポート ジョブの場合は省略可能。他のジョブでは無視されます。 指定しない場合、サービスの既定値は false になります。 false の場合、承認キーはエクスポート出力に含まれます。 それ以外の場合、キーは null としてエクスポートされます。

storage_authentication_type
str または <xref:protocol.models.enum>
必須

ストレージ アカウントへの接続に使用される認証の種類。 使用できる値は、'keyBased'、'identityBased' です。

identity
ManagedIdentity
必須
failure_reason
str
必須

系遺伝子導入。 作成時に無視されます。 エラーが発生した場合のエラーの理由。

include_configurations
bool
必須

既定値は false です。 true の場合、構成はデータのエクスポート/インポートに含まれます。

configurations_blob_name
str
必須

既定値は configurations.txt です。 構成をエクスポートまたはインポートするときに使用する BLOB の名前を指定します。

メソッド

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 互換オブジェクト

の戻り値の型 :

dict

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 互換オブジェクト

の戻り値の型 :

dict

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list