IoTHubJobManager Clase

Una clase para proporcionar API útiles para las operaciones del Administrador de trabajos de IoTHub, en función de las API REST de IotHub generadas automáticamente.

Inicializador para un cliente de servicio del Administrador de trabajos.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

Herencia

builtins.object

IoTHubJobManager

Constructor

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

Parámetros

Nombre	Description
connection_string	str La cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub si se usa connection_str autenticación. Valor predeterminado: ninguno valor predeterminado: None
host	str La dirección URL del servicio de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno valor predeterminado: None
auth	str El objeto de autenticación de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno valor predeterminado: None

Métodos

cancel_import_export_job	Cancela un trabajo de importación y exportación en un centro de IoT.
cancel_scheduled_job	Cancela un trabajo programado en un centro de IoT.
create_import_export_job	Crea un nuevo trabajo de importación y exportación en un centro de IoT.
create_scheduled_job	Crea un nuevo trabajo para programar la actualización de gemelos o métodos directos de dispositivo en un centro de IoT.
from_connection_string	Inicializador classmethod para un cliente del servicio IoTHubJobManager. Crea la clase IoTHubJobManager a partir de la cadena de conexión. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
from_token_credential	Inicializador classmethod para un cliente del servicio IoTHubJobManager. Crea la clase IoTHubJobManager a partir de la dirección URL del nombre de host y la credencial del token de Azure. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
get_import_export_job	Recupera el estado de un trabajo de importación y exportación en ioTHub.
get_import_export_jobs	Recupera el estado de todos los trabajos de importación y exportación en ioTHub.
get_scheduled_job	Recupera los detalles de un trabajo programado en ioTHub.
query_scheduled_jobs	Consulte un centro de IoT para recuperar información sobre los trabajos mediante el lenguaje de consulta IoT Hub.

cancel_import_export_job

Cancela un trabajo de importación y exportación en un centro de IoT.

cancel_import_export_job(job_id)

Parámetros

Nombre	Description
job_id Requerido	str Id. del trabajo.

Devoluciones

Tipo	Description
	Oposición.

Excepciones

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

cancel_scheduled_job

Cancela un trabajo programado en un centro de IoT.

cancel_scheduled_job(job_id)

Parámetros

Nombre	Description
job_id Requerido	str Id. del trabajo.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contiene el trabajo cancelado.

Excepciones

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

create_import_export_job

Crea un nuevo trabajo de importación y exportación en un centro de IoT.

create_import_export_job(job_properties)

Parámetros

Nombre	Description
job_properties Requerido	<xref:azure.iot.hub.models.JobProperties> Especifica la especificación del trabajo.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	Objeto JobProperties que contiene el trabajo creado.

Excepciones

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

create_scheduled_job

Crea un nuevo trabajo para programar la actualización de gemelos o métodos directos de dispositivo en un centro de IoT.

create_scheduled_job(job_id, job_request)

Parámetros

Nombre	Description
job_id Requerido	str Id. del trabajo.
job_request Requerido	<xref:azure.iot.hub.models.JobRequest> Especifica el trabajo.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contiene el trabajo creado.

Excepciones

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

from_connection_string

Inicializador classmethod para un cliente del servicio IoTHubJobManager. Crea la clase IoTHubJobManager a partir de la cadena de conexión.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_connection_string(connection_string)

Parámetros

Nombre	Description
connection_string Requerido	str Cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub.

Devoluciones

Tipo	Description
IoTHubJobManager

Excepciones

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

from_token_credential

Inicializador classmethod para un cliente del servicio IoTHubJobManager. Crea la clase IoTHubJobManager a partir de la dirección URL del nombre de host y la credencial del token de Azure.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_token_credential(url, token_credential)

Parámetros

Nombre	Description
url Requerido	str La dirección URL del servicio de Azure (nombre de host).
token_credential Requerido	<xref:azure.core.TokenCredential> El objeto de credencial de token de Azure

Devoluciones

Tipo	Description
IoTHubJobManager

Excepciones

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

get_import_export_job

Recupera el estado de un trabajo de importación y exportación en ioTHub.

get_import_export_job(job_id)

Parámetros

Nombre	Description
job_id Requerido	str Id. del trabajo.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	Objeto JobProperties que contiene el trabajo solicitado.

Excepciones

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

get_import_export_jobs

Recupera el estado de todos los trabajos de importación y exportación en ioTHub.

get_import_export_jobs()

Devoluciones

Tipo	Description
list[<xref:azure.iot.hub.models.JobProperties>]	Objeto list[job_properties].

Excepciones

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

get_scheduled_job

Recupera los detalles de un trabajo programado en ioTHub.

get_scheduled_job(job_id)

Parámetros

Nombre	Description
job_id Requerido	str Id. del trabajo.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contiene los detalles solicitados.

Excepciones

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

query_scheduled_jobs

Consulte un centro de IoT para recuperar información sobre los trabajos mediante el lenguaje de consulta IoT Hub.

query_scheduled_jobs(job_type, job_status)

Parámetros

Nombre	Description
job_type Requerido	str Tipo de los trabajos.
job_status Requerido	str Estado de los trabajos.

Devoluciones

Tipo	Description
<xref:azure.iot.hub.models.QueryResult>	Objeto QueryResult que contiene los trabajos.

Excepciones

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