JobProperties Klasa
Właściwości zadań.
- Dziedziczenie
-
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)
Parametry
- start_time_utc
- datetime
Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina rozpoczęcia zadania w formacie UTC.
- end_time_utc
- datetime
Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina zakończenia zadania w formacie UTC.
- type
- str lub <xref:protocol.models.enum>
Typ zadania. Możliwe wartości obejmują: "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy"
- status
- str lub <xref:protocol.models.enum>
Wygenerowany system. Ignorowane podczas tworzenia. Stan zadania. Możliwe wartości to: "unknown", "enqueued", "running", "completed", "failed", "cancelled", "scheduled", "queued"
- progress
- int
Wygenerowany system. Ignorowane podczas tworzenia. Procent ukończenia zadania.
- input_blob_container_uri
- str
Identyfikator URI zawierający token SAS do kontenera obiektów blob, który zawiera dane rejestru do zsynchronizowania.
- input_blob_name
- str
Nazwa obiektu blob do użycia podczas importowania z wejściowego kontenera obiektów blob.
- output_blob_container_uri
- str
Token SYGNATURy dostępu współdzielonego do uzyskiwania dostępu do kontenera obiektów blob. Służy do wyprowadzania stanu i wyników zadania.
- output_blob_name
- str
Nazwa obiektu blob, który zostanie utworzony w wyjściowym kontenerze obiektów blob. Ten obiekt blob będzie zawierać wyeksportowane informacje o rejestrze urządzeń dla IoT Hub.
- exclude_keys_in_export
- bool
Opcjonalne w przypadku zadań eksportu; ignorowane dla innych zadań. Jeśli nie zostanie określony, usługa domyślnie ma wartość false. Jeśli wartość false, klucze autoryzacji są uwzględniane w danych wyjściowych eksportu. Klucze są eksportowane jako null w przeciwnym razie.
- storage_authentication_type
- str lub <xref:protocol.models.enum>
Typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. Możliwe wartości to: "keyBased", "identityBased"
- identity
- ManagedIdentity
- failure_reason
- str
System został wygenerowany. Ignorowane podczas tworzenia. Przyczyna niepowodzenia, jeśli wystąpił błąd.
- include_configurations
- bool
Wartość domyślna to false. Jeśli wartość true, konfiguracje są uwzględniane w eksporcie/importowaniu danych.
- configurations_blob_name
- str
Wartość domyślna to configurations.txt. Określa nazwę obiektu blob do użycia podczas eksportowania/importowania konfiguracji.
Metody
as_dict |
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku. Zobacz trzy przykłady w tym pliku:
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
deserialize |
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu. |
enable_additional_properties_sending | |
from_dict |
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model. Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu. Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
validate |
Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError. |
as_dict
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump.
Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:
Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.
Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.
Zobacz trzy przykłady w tym pliku:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametry
- key_transformer
- <xref:function>
Funkcja transformatora klucza.
- keep_readonly
Zwraca
Obiekt zgodny z dyktacją JSON
Typ zwracany
deserialize
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
deserialize(data, content_type=None)
Parametry
- content_type
- str
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.
Zwraca
Wystąpienie tego modelu
Wyjątki
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.
Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parametry
- content_type
- str
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.
- key_extractors
Zwraca
Wystąpienie tego modelu
Wyjątki
is_xml_model
is_xml_model()
serialize
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu.
Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parametry
Zwraca
Obiekt zgodny z dyktacją JSON
Typ zwracany
validate
Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError.
validate()
Zwraca
Lista błędów walidacji
Typ zwracany
Azure SDK for Python
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla