JobProperties Osztály

JobProperties.

Öröklődés

Model

JobProperties

Konstruktor

JobProperties(**kwargs)

Paraméterek

job_id

str

Kötelező

A feladat egyedi azonosítója.

start_time_utc

datetime

Kötelező

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat kezdési dátuma és időpontja (UTC).

end_time_utc

datetime

Kötelező

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezési dátuma és időpontja (UTC).

type

str vagy <xref:protocol.models.enum>

Kötelező

A feladat típusa. Lehetséges értékek: "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy"

status

str vagy <xref:protocol.models.enum>

Kötelező

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat állapota. Lehetséges értékek: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'queued'

progress

int

Kötelező

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezésének százalékos aránya.

input_blob_container_uri

str

Kötelező

Az SAS-jogkivonatot tartalmazó URI egy olyan blobtárolóba, amely szinkronizálandó beállításjegyzék-adatokat tartalmaz.

input_blob_name

str

Kötelező

A bemeneti blobtárolóból való importáláshoz használandó blobnév.

output_blob_container_uri

str

Kötelező

A blobtároló eléréséhez szükséges SAS-jogkivonat. Ez a feladat állapotának és eredményeinek kimenetére szolgál.

output_blob_name

str

Kötelező

A kimeneti blobtárolóban létrehozandó blobnév. Ez a blob tartalmazni fogja a IoT Hub exportált eszközregisztrációs adatbázisának adatait.

exclude_keys_in_export

bool

Kötelező

Exportálási feladatokhoz nem kötelező; más feladatok esetében figyelmen kívül hagyva. Ha nincs megadva, a szolgáltatás alapértelmezés szerint false (hamis). Ha hamis, az engedélyezési kulcsok szerepelnek az exportálási kimenetben. A kulcsok exportálása egyébként null értékű.

storage_authentication_type

str vagy <xref:protocol.models.enum>

Kötelező

A tárfiókhoz való csatlakozáshoz használt hitelesítési típus. Lehetséges értékek: "keyBased", "identityBased"

identity

ManagedIdentity

Kötelező

failure_reason

str

Kötelező

A rendszer nemesített. A létrehozáskor figyelmen kívül hagyva. A hiba oka, ha hiba történt.

include_configurations

bool

Kötelező

Az alapértelmezett érték a hamis. Ha igaz, akkor a konfigurációk az adatexportálás/-importálás részét képezik.

configurations_blob_name

str

Kötelező

Alapértelmezés szerint configurations.txt. Megadja a konfigurációk exportálásakor/importálásakor használandó blob nevét.

Metódusok

as_dict	Adjon vissza egy JSONify típusú diktáltot a json.dump használatával. A speciális használat opcionálisan visszahívást is használhat paraméterként: A kulcs a Pythonban használt attribútumnév. Attr_desc a metaadatok diktálása. Jelenleg a "type" az msrest típussal, a "key" pedig a RestAPI kódolású kulccsal. Az érték az objektum aktuális értéke. A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor a rendszer hierarchikus eredménydiktátumnak tekinti. Tekintse meg a fájl három példáját: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Ha XML-szerializálást szeretne, átadhatja a kwargs is_xml=True értéket.
deserialize	Elemezhet egy str-t a RestAPI szintaxissal, és visszaad egy modellt.
enable_additional_properties_sending
from_dict	A diktálás adott kulcselszívóval történő elemzése modell visszaadása. Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	A modellből az Azure-ba küldendő JSON-t adja vissza. Ez a as_dict(full_restapi_key_transformer, keep_readonly=Hamis) alias. Ha XML-szerializálást szeretne, átadhatja a kwargs is_xml=True értéket.
validate	Ellenőrizze a modellt rekurzív módon, és adja vissza a ValidationError listáját.

as_dict

Adjon vissza egy JSONify típusú diktáltot a json.dump használatával.

A speciális használat opcionálisan visszahívást is használhat paraméterként:

A kulcs a Pythonban használt attribútumnév. Attr_desc a metaadatok diktálása. Jelenleg a "type" az msrest típussal, a "key" pedig a RestAPI kódolású kulccsal. Az érték az objektum aktuális értéke.

A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor a rendszer hierarchikus eredménydiktátumnak tekinti.

Tekintse meg a fájl három példáját:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Ha XML-szerializálást szeretne, átadhatja a kwargs is_xml=True értéket.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Paraméterek

key_transformer

<xref:function>

Egy kulcsátalakító függvény.

keep_readonly

alapértelmezett érték: True

Válaszok

A dict JSON-kompatibilis objektum

Visszatérési típus

dict

deserialize

Elemezhet egy str-t a RestAPI szintaxissal, és visszaad egy modellt.

deserialize(data, content_type=None)

Paraméterek

data

str

Kötelező

RestAPI-struktúrát használó struktúra. JSON alapértelmezés szerint.

content_type

str

alapértelmezett érték: None

A JSON alapértelmezés szerint az alkalmazás/xml beállítása XML esetén.

Válaszok

A modell egy példánya

Kivételek

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

A diktálás adott kulcselszívóval történő elemzése modell visszaadása.

Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Paraméterek

data

dict

Kötelező

Egy restAPI-struktúrát használó diktálás

content_type

str

alapértelmezett érték: None

A JSON alapértelmezés szerint az alkalmazás/xml beállítása XML esetén.

key_extractors

alapértelmezett érték: None

Válaszok

A modell egy példánya

Kivételek

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

A modellből az Azure-ba küldendő JSON-t adja vissza.

Ez a as_dict(full_restapi_key_transformer, keep_readonly=Hamis) alias.

Ha XML-szerializálást szeretne, átadhatja a kwargs is_xml=True értéket.

serialize(keep_readonly=False, **kwargs)

Paraméterek

keep_readonly

bool

alapértelmezett érték: False

Ha szerializálni szeretné az olvasható attribútumokat

Válaszok

A dict JSON-kompatibilis objektum

Visszatérési típus

dict

validate

Ellenőrizze a modellt rekurzív módon, és adja vissza a ValidationError listáját.

validate()

Válaszok

Az érvényesítési hiba listája

Visszatérési típus

list