JobProperties Osztály
JobProperties.
- Öröklődés
-
JobProperties
Konstruktor
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)
Paraméterek
- start_time_utc
- datetime
Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat kezdési dátuma és időpontja UTC-ben.
- end_time_utc
- datetime
Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezési dátuma és időpontja UTC-ben.
- type
- str vagy <xref:protocol.models.enum>
A feladat típusa. Lehetséges értékek: "ismeretlen", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy"
- status
- str vagy <xref:protocol.models.enum>
Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat állapota. Lehetséges értékek: "ismeretlen", "enqueued", "running", "completed", "failed", "cancelled", "scheduled", "queued"
- progress
- int
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
Az SAS-jogkivonatot tartalmazó URI egy olyan blobtárolóba, amely a szinkronizálandó beállításjegyzék-adatokat tartalmazza.
- output_blob_container_uri
- str
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
A kimeneti blobtárolóban létrejövő blobnév. Ez a blob tartalmazza a IoT Hub exportált eszközregisztrációs adatbázisának adatait.
- exclude_keys_in_export
- bool
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 hamis. Ha hamis, az engedélyezési kulcsok szerepelnek az exportálási kimenetben. A kulcsokat a rendszer null értékűként exportálja.
- storage_authentication_type
- str vagy <xref:protocol.models.enum>
A tárfiókhoz való csatlakozáshoz használt hitelesítési típus. Lehetséges értékek: "keyBased", "identityBased"
- identity
- ManagedIdentity
- failure_reason
- str
Rendszer genereated. A létrehozáskor figyelmen kívül hagyva. A hiba oka, ha hiba történt.
- include_configurations
- bool
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
Alapértelmezés szerint configurations.txt. Megadja a konfigurációk exportálásához/importálásához használni kívánt blob nevét.
Metódusok
as_dict |
A json.dump használatával JSONify formátumú diktált értéket ad vissza. 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 egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. 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 ez hierarchikus eredménydiktátumnak minősül. Tekintse meg a fájl három példáját:
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
deserialize |
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt. |
enable_additional_properties_sending | |
from_dict |
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza. 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 |
Adja vissza a modellből az Azure-ba küldendő JSON-t. Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa. Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
validate |
Ellenőrizze ezt a modellt rekurzív módon, és adja vissza a ValidationError listáját. |
as_dict
A json.dump használatával JSONify formátumú diktált értéket ad vissza.
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 egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. 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 ez hierarchikus eredménydiktátumnak minősül.
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, a kwargs is_xml=True értéket is átadhatja.
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
Válaszok
Diktátum JSON-kompatibilis objektum
Visszatérési típus
deserialize
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.
deserialize(data, content_type=None)
Paraméterek
- content_type
- str
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML.
Válaszok
A modell egy példánya
Kivételek
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza.
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
- content_type
- str
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML.
- key_extractors
Válaszok
A modell egy példánya
Kivételek
is_xml_model
is_xml_model()
serialize
Adja vissza a modellből az Azure-ba küldendő JSON-t.
Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa.
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
serialize(keep_readonly=False, **kwargs)
Paraméterek
- keep_readonly
- bool
Ha szerializálni szeretné az olvasható attribútumokat
Válaszok
Diktátum JSON-kompatibilis objektum
Visszatérési típus
validate
Ellenőrizze ezt 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
Azure SDK for Python
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: