JobProperties Classe
JobProperties.
- Héritage
-
JobProperties
Constructeur
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ètres
- start_time_utc
- datetime
Généré par le système. Ignoré lors de la création. Date et heure de début du travail en UTC.
- end_time_utc
- datetime
Généré par le système. Ignoré lors de la création. Date et heure de fin du travail en UTC.
- type
- str ou <xref:protocol.models.enum>
Type de travail. Les valeurs possibles sont les suivantes : 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate', 'scheduleDeviceMethod', 'scheduleUpdateTwin', 'restoreFromBackup', 'failoverDataCopy'
- status
- str ou <xref:protocol.models.enum>
Généré par le système. Ignoré lors de la création. État du travail. Les valeurs possibles sont les suivantes : 'unknown', 'en file d’attente', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'queued'
- progress
- int
Généré par le système. Ignoré lors de la création. Pourcentage d’achèvement du travail.
- input_blob_container_uri
- str
URI contenant le jeton SAP d’un conteneur d’objets blob qui contient des données de Registre à synchroniser.
- input_blob_name
- str
Nom de l’objet blob à utiliser lors de l’importation à partir du conteneur d’objets blob d’entrée.
- output_blob_container_uri
- str
Jeton SAS pour accéder au conteneur d’objets blob. Il est utilisé pour générer le status et les résultats du travail.
- output_blob_name
- str
Nom de l’objet blob qui sera créé dans le conteneur d’objets blob de sortie. Cet objet blob contient les informations de registre d’appareils exportées pour le IoT Hub.
- exclude_keys_in_export
- bool
Facultatif pour les travaux d’exportation ; ignoré pour d’autres travaux. S’il n’est pas spécifié, le service a la valeur par défaut false. Si la valeur est false, les clés d’autorisation sont incluses dans la sortie d’exportation. Dans le cas contraire, les clés sont exportées sous la forme null.
- storage_authentication_type
- str ou <xref:protocol.models.enum>
Type d’authentification utilisé pour la connexion au compte de stockage. Les valeurs possibles sont les suivantes : « keyBased », « identityBased »
- identity
- ManagedIdentity
- failure_reason
- str
Système genereated. Ignoré lors de la création. Raison de l’échec, si un échec s’est produit.
- include_configurations
- bool
La valeur par défaut est false. Si la valeur est true, les configurations sont incluses dans l’exportation/importation des données.
- configurations_blob_name
- str
La valeur par défaut est configurations.txt. Spécifie le nom de l’objet blob à utiliser lors de l’exportation/importation de configurations.
Méthodes
as_dict |
Retourne un dictée qui peut être JSONify à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
deserialize |
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle. |
enable_additional_properties_sending | |
from_dict |
L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Retourne le JSON qui serait envoyé à Azure à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
validate |
Validez ce modèle de manière récursive et retournez une liste de ValidationError. |
as_dict
Retourne un dictée qui peut être JSONify à l’aide de json.dump.
L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :
La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique.
Consultez les trois exemples de ce fichier :
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Paramètres
- key_transformer
- <xref:function>
Fonction de transformateur de clé.
- keep_readonly
Retours
Objet compatible JSON de dict
Type de retour
deserialize
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data, content_type=None)
Paramètres
Retours
Une instance de ce modèle
Exceptions
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle.
Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Paramètres
- key_extractors
Retours
Une instance de ce modèle
Exceptions
is_xml_model
is_xml_model()
serialize
Retourne le JSON qui serait envoyé à Azure à partir de ce modèle.
Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Paramètres
Retours
Objet compatible JSON de dict
Type de retour
validate
Validez ce modèle de manière récursive et retournez une liste de ValidationError.
validate()
Retours
Liste des erreurs de validation
Type de retour
Azure SDK for Python
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour