IoTHubJobManager Classe

Classe pour fournir des API pratiques pour les opérations IoTHub Job Manager, basées sur les API REST IotHub générées automatiquement

Initialiseur pour un client du service Job Manager.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

Héritage

builtins.object

IoTHubJobManager

Constructeur

IoTHubJobManager(connection_string=None, host=None, auth=None)

Paramètres

Nom	Description
connection_string	str Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub si nous utilisons l’authentification connection_str. Valeur par défaut : Aucun valeur par défaut: None
host	str URL du service Azure si nous utilisons l’authentification des informations d’identification de jeton. Valeur par défaut : Aucun valeur par défaut: None
auth	str Objet d’authentification Azure si nous utilisons l’authentification des informations d’identification de jeton. Valeur par défaut : Aucun valeur par défaut: None

Méthodes

cancel_import_export_job	Annule un travail d’importation/exportation sur un hub IoT.
cancel_scheduled_job	Annule un travail planifié sur un hub IoT.
create_import_export_job	Crée un travail d’importation/exportation sur un hub IoT.
create_scheduled_job	Crée un travail pour planifier des jumeaux de mise à jour ou des méthodes directes d’appareil sur un hub IoT.
from_connection_string	Initialiseur classmethod pour un client du service IoTHubJobManager. Crée la classe IoTHubJobManager à partir de la chaîne de connexion. Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
from_token_credential	Initialiseur classmethod pour un client du service IoTHubJobManager. Crée la classe IoTHubJobManager à partir de l’URL du nom d’hôte et des informations d’identification du jeton Azure. Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
get_import_export_job	Récupère les status d’un travail d’importation/exportation sur un IoTHub.
get_import_export_jobs	Récupère le status de tous les travaux d’importation/exportation sur un IoTHub.
get_scheduled_job	Récupère les détails d’un travail planifié sur un IoTHub.
query_scheduled_jobs	Interrogez un hub IoT pour récupérer des informations sur les travaux à l’aide du langage de requête IoT Hub.

cancel_import_export_job

Annule un travail d’importation/exportation sur un hub IoT.

cancel_import_export_job(job_id)

Paramètres

Nom	Description
job_id Obligatoire	str ID du travail.

Retours

Type	Description
	Objet.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

cancel_scheduled_job

Annule un travail planifié sur un hub IoT.

cancel_scheduled_job(job_id)

Paramètres

Nom	Description
job_id Obligatoire	str ID du travail.

Retours

Type	Description
<xref:azure.iot.hub.models.JobResponse>	Objet JobResponse contenant le travail annulé.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_import_export_job

Crée un travail d’importation/exportation sur un hub IoT.

create_import_export_job(job_properties)

Paramètres

Nom	Description
job_properties Obligatoire	<xref:azure.iot.hub.models.JobProperties> Spécifie la spécification du travail.

Retours

Type	Description
<xref:azure.iot.hub.models.JobProperties>	Objet JobProperties contenant le travail créé.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_scheduled_job

Crée un travail pour planifier des jumeaux de mise à jour ou des méthodes directes d’appareil sur un hub IoT.

create_scheduled_job(job_id, job_request)

Paramètres

Nom	Description
job_id Obligatoire	str ID du travail.
job_request Obligatoire	<xref:azure.iot.hub.models.JobRequest> Spécifie le travail.

Retours

Type	Description
<xref:azure.iot.hub.models.JobResponse>	Objet JobResponse contenant le travail créé.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Initialiseur classmethod pour un client du service IoTHubJobManager. Crée la classe IoTHubJobManager à partir de la chaîne de connexion.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

from_connection_string(connection_string)

Paramètres

Nom	Description
connection_string Obligatoire	str Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub.

Retours

Type	Description
IoTHubJobManager

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Initialiseur classmethod pour un client du service IoTHubJobManager. Crée la classe IoTHubJobManager à partir de l’URL du nom d’hôte et des informations d’identification du jeton Azure.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

from_token_credential(url, token_credential)

Paramètres

Nom	Description
url Obligatoire	str URL du service Azure (nom d’hôte).
token_credential Obligatoire	<xref:azure.core.TokenCredential> Objet d’informations d’identification de jeton Azure

Retours

Type	Description
IoTHubJobManager

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_job

Récupère les status d’un travail d’importation/exportation sur un IoTHub.

get_import_export_job(job_id)

Paramètres

Nom	Description
job_id Obligatoire	str ID du travail.

Retours

Type	Description
<xref:azure.iot.hub.models.JobProperties>	Objet JobProperties contenant le travail demandé.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_jobs

Récupère le status de tous les travaux d’importation/exportation sur un IoTHub.

get_import_export_jobs()

Retours

Type	Description
list[<xref:azure.iot.hub.models.JobProperties>]	Objet list[job_properties].

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_scheduled_job

Récupère les détails d’un travail planifié sur un IoTHub.

get_scheduled_job(job_id)

Paramètres

Nom	Description
job_id Obligatoire	str ID du travail.

Retours

Type	Description
<xref:azure.iot.hub.models.JobResponse>	Objet JobResponse contenant les détails demandés.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_scheduled_jobs

Interrogez un hub IoT pour récupérer des informations sur les travaux à l’aide du langage de requête IoT Hub.

query_scheduled_jobs(job_type, job_status)

Paramètres

Nom	Description
job_type Obligatoire	str Type des travaux.
job_status Obligatoire	str Status des travaux.

Retours

Type	Description
<xref:azure.iot.hub.models.QueryResult>	Objet QueryResult contenant les travaux.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>