IoTHubJobManager Classe

Uma classe para fornecer APIs de conveniência para operações do IoTHub Job Manager, com base nas APIs REST do IotHub geradas automaticamente

Inicializador para um cliente de Serviço do Gestor de Tarefas.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.

Herança

builtins.object

IoTHubJobManager

Construtor

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

Parâmetros

Name	Description
connection_string	str A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub se estivermos a utilizar connection_str autenticação. Valor predefinido: Nenhum valor predefinido: None
host	str O URL do serviço do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum valor predefinido: None
auth	str O objeto de autenticação do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum valor predefinido: None

Métodos

cancel_import_export_job	Cancela uma tarefa de importação/exportação num hub IoT.
cancel_scheduled_job	Cancela uma tarefa agendada num hub IoT.
create_import_export_job	Cria uma nova tarefa de importação/exportação num hub IoT.
create_scheduled_job	Cria uma nova tarefa para agendar a atualização de duplos ou métodos diretos do dispositivo num hub IoT.
from_connection_string	Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager a partir da cadeia de ligação. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.
from_token_credential	Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager a partir do URL do nome do anfitrião e da credencial do token do Azure. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.
get_import_export_job	Obtém o estado de uma tarefa de importação/exportação num IoTHub.
get_import_export_jobs	Obtém o estado de todas as tarefas de importação/exportação num IoTHub.
get_scheduled_job	Obtém os detalhes de uma tarefa agendada num IoTHub.
query_scheduled_jobs	Consulte um hub IoT para obter informações sobre tarefas com a linguagem de consulta Hub IoT.

cancel_import_export_job

Cancela uma tarefa de importação/exportação num hub IoT.

cancel_import_export_job(job_id)

Parâmetros

Name	Description
job_id Necessário	str O ID do trabalho.

Devoluções

Tipo	Description
	Objeto.

Exceções

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

cancel_scheduled_job

Cancela uma tarefa agendada num hub IoT.

cancel_scheduled_job(job_id)

Parâmetros

Name	Description
job_id Necessário	str O ID do trabalho.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contém a tarefa cancelada.

Exceções

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

create_import_export_job

Cria uma nova tarefa de importação/exportação num hub IoT.

create_import_export_job(job_properties)

Parâmetros

Name	Description
job_properties Necessário	<xref:azure.iot.hub.models.JobProperties> Especifica a especificação da tarefa.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	Objeto JobProperties que contém a tarefa criada.

Exceções

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

create_scheduled_job

Cria uma nova tarefa para agendar a atualização de duplos ou métodos diretos do dispositivo num hub IoT.

create_scheduled_job(job_id, job_request)

Parâmetros

Name	Description
job_id Necessário	str O ID do trabalho.
job_request Necessário	<xref:azure.iot.hub.models.JobRequest> Especifica a tarefa.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contém a tarefa criada.

Exceções

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

from_connection_string

Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager a partir da cadeia de ligação.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.

from_connection_string(connection_string)

Parâmetros

Name	Description
connection_string Necessário	str A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub.

Devoluções

Tipo	Description
IoTHubJobManager

Exceções

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

from_token_credential

Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager a partir do URL do nome do anfitrião e da credencial do token do Azure.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.

from_token_credential(url, token_credential)

Parâmetros

Name	Description
url Necessário	str O URL do serviço do Azure (nome do anfitrião).
token_credential Necessário	<xref:azure.core.TokenCredential> O objeto de credencial do token do Azure

Devoluções

Tipo	Description
IoTHubJobManager

Exceções

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

get_import_export_job

Obtém o estado de uma tarefa de importação/exportação num IoTHub.

get_import_export_job(job_id)

Parâmetros

Name	Description
job_id Necessário	str O ID do trabalho.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	O objeto JobProperties que contém a tarefa pedida.

Exceções

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

get_import_export_jobs

Obtém o estado de todas as tarefas de importação/exportação num IoTHub.

get_import_export_jobs()

Devoluções

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

Exceções

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

get_scheduled_job

Obtém os detalhes de uma tarefa agendada num IoTHub.

get_scheduled_job(job_id)

Parâmetros

Name	Description
job_id Necessário	str O ID do trabalho.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	O objeto JobResponse que contém os detalhes pedidos.

Exceções

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

query_scheduled_jobs

Consulte um hub IoT para obter informações sobre tarefas com a linguagem de consulta Hub IoT.

query_scheduled_jobs(job_type, job_status)

Parâmetros

Name	Description
job_type Necessário	str O tipo de tarefas.
job_status Necessário	str O estado das tarefas.

Devoluções

Tipo	Description
<xref:azure.iot.hub.models.QueryResult>	Objeto QueryResult que contém as tarefas.

Exceções

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