JobProperties Sınıf
JobProperties.
- Devralma
-
JobProperties
Oluşturucu
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)
Parametreler
- start_time_utc
- datetime
Sistem oluşturuldu. Oluşturma sırasında yoksayılır. utc olarak işin başlangıç tarihi ve saati.
- end_time_utc
- datetime
Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin bitiş tarihi ve saati (UTC).
- type
- str veya <xref:protocol.models.enum>
İş türü. Olası değerler şunlardır: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate', 'scheduleDeviceMethod', 'scheduleUpdateTwin', 'restoreFromBackup', 'failoverDataCopy'
- status
- str veya <xref:protocol.models.enum>
Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin durumu. Olası değerler şunlardır: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'queued'
- input_blob_container_uri
- str
Eşitlenecek kayıt defteri verilerini içeren bir blob kapsayıcısına SAS belirteci içeren URI.
- output_blob_container_uri
- str
Blob kapsayıcısına erişmek için SAS belirteci. Bu, işin durumunu ve sonuçlarını çıkarmak için kullanılır.
- output_blob_name
- str
Çıktı blob kapsayıcısında oluşturulacak blob adı. Bu blob, IoT Hub için dışarı aktarılan cihaz kayıt defteri bilgilerini içerir.
- exclude_keys_in_export
- bool
Dışarı aktarma işleri için isteğe bağlı; diğer işler için yoksayılır. Belirtilmezse, hizmet varsayılan olarak false olur. False ise, yetkilendirme anahtarları dışarı aktarma çıkışına eklenir. Aksi takdirde anahtarlar null olarak dışarı aktarılır.
- storage_authentication_type
- str veya <xref:protocol.models.enum>
Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türü. Olası değerler şunlardır: 'keyBased', 'identityBased'
- identity
- ManagedIdentity
- failure_reason
- str
Sistem genrelenmiş. Oluşturma sırasında yoksayılır. Bir hata oluştuysa hatanın nedeni.
- include_configurations
- bool
Varsayılan değer false şeklindedir. True ise yapılandırmalar veri dışarı/içeri aktarma işlemine dahil edilir.
- configurations_blob_name
- str
Varsayılan olarak configurations.txt. Yapılandırmaları dışarı/içeri aktarırken kullanılacak blobun adını belirtir.
Yöntemler
as_dict |
json.dump kullanarak JSONify olabilecek bir dikte döndürebilirsiniz. Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir: Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir. Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir. Bu dosyadaki üç örne bakın:
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz. |
deserialize |
RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün. |
enable_additional_properties_sending | |
from_dict |
Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür. Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun |
is_xml_model | |
serialize |
Bu modelden Azure'a gönderilecek JSON kodunu döndür. Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır. XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz. |
validate |
Bu modeli yinelemeli olarak doğrulayın ve ValidationError listesini döndürür. |
as_dict
json.dump kullanarak JSONify olabilecek bir dikte döndürebilirsiniz.
Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir:
Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir.
Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir.
Bu dosyadaki üç örne bakın:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametreler
- key_transformer
- <xref:function>
Anahtar transformatörü işlevi.
- keep_readonly
Döndürülenler
JSON uyumlu bir dikte nesnesi
Dönüş türü
deserialize
RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.
deserialize(data, content_type=None)
Parametreler
- content_type
- str
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.
Döndürülenler
Bu modelin bir örneği
Özel durumlar
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür.
Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun
from_dict(data, key_extractors=None, content_type=None)
Parametreler
- content_type
- str
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.
- key_extractors
Döndürülenler
Bu modelin bir örneği
Özel durumlar
is_xml_model
is_xml_model()
serialize
Bu modelden Azure'a gönderilecek JSON kodunu döndür.
Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
serialize(keep_readonly=False, **kwargs)
Parametreler
- keep_readonly
- bool
Salt okunur öznitelikleri seri hale getirmek istiyorsanız
Döndürülenler
JSON uyumlu bir dikte nesnesi
Dönüş türü
validate
Bu modeli yinelemeli olarak doğrulayın ve ValidationError listesini döndürür.
validate()
Döndürülenler
Doğrulama hatası listesi
Dönüş türü
Azure SDK for Python