IoTHubJobManager Classe

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

Inicializador para um cliente do Serviço do Gerenciador de Trabalho.

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

Herança

builtins.object

IoTHubJobManager

Construtor

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

Parâmetros

Nome	Description
connection_string	str A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub se estivermos usando connection_str autenticação. Valor padrão: nenhum valor padrão: None
host	str A URL do serviço do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None
auth	str O objeto de autenticação do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None

Métodos

cancel_import_export_job	Cancela um trabalho de importação/exportação em um hub IoT.
cancel_scheduled_job	Cancela um trabalho agendado em um hub IoT.
create_import_export_job	Cria um novo trabalho de importação/exportação em um hub IoT.
create_scheduled_job	Cria um novo trabalho para agendar a atualização de gêmeos ou métodos diretos do dispositivo em um hub IoT.
from_connection_string	Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager da cadeia de conexão. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
from_token_credential	Inicializador classmethod para um cliente do Serviço IoTHubJobManager. Cria a classe IoTHubJobManager com base na URL do nome do host e na credencial de token do Azure. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
get_import_export_job	Recupera o status de um trabalho de importação/exportação em um IoTHub.
get_import_export_jobs	Recupera o status de todos os trabalhos de importação/exportação em um IoTHub.
get_scheduled_job	Recupera os detalhes de um trabalho agendado em um IoTHub.
query_scheduled_jobs	Consulte um hub IoT para recuperar informações sobre trabalhos usando a linguagem de consulta Hub IoT.

cancel_import_export_job

Cancela um trabalho de importação/exportação em um hub IoT.

cancel_import_export_job(job_id)

Parâmetros

Nome	Description
job_id Obrigatório	str A ID do trabalho.

Retornos

Tipo	Description
	Objeção.

Exceções

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

cancel_scheduled_job

Cancela um trabalho agendado em um hub IoT.

cancel_scheduled_job(job_id)

Parâmetros

Nome	Description
job_id Obrigatório	str A ID do trabalho.

Retornos

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contém o trabalho cancelado.

Exceções

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

create_import_export_job

Cria um novo trabalho de importação/exportação em um hub IoT.

create_import_export_job(job_properties)

Parâmetros

Nome	Description
job_properties Obrigatório	<xref:azure.iot.hub.models.JobProperties> Especifica a especificação do trabalho.

Retornos

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	Objeto JobProperties que contém o trabalho criado.

Exceções

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

create_scheduled_job

Cria um novo trabalho para agendar a atualização de gêmeos ou métodos diretos do dispositivo em um hub IoT.

create_scheduled_job(job_id, job_request)

Parâmetros

Nome	Description
job_id Obrigatório	str A ID do trabalho.
job_request Obrigatório	<xref:azure.iot.hub.models.JobRequest> Especifica o trabalho.

Retornos

Tipo	Description
<xref:azure.iot.hub.models.JobResponse>	Objeto JobResponse que contém o trabalho criado.

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 da cadeia de conexão.

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

from_connection_string(connection_string)

Parâmetros

Nome	Description
connection_string Obrigatório	str A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub.

Retornos

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 com base na URL do nome do host e na credencial de token do Azure.

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

from_token_credential(url, token_credential)

Parâmetros

Nome	Description
url Obrigatório	str A URL do serviço do Azure (nome do host).
token_credential Obrigatório	<xref:azure.core.TokenCredential> O objeto de credencial de token do Azure

Retornos

Tipo	Description
IoTHubJobManager

Exceções

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

get_import_export_job

Recupera o status de um trabalho de importação/exportação em um IoTHub.

get_import_export_job(job_id)

Parâmetros

Nome	Description
job_id Obrigatório	str A ID do trabalho.

Retornos

Tipo	Description
<xref:azure.iot.hub.models.JobProperties>	O objeto JobProperties que contém o trabalho solicitado.

Exceções

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

get_import_export_jobs

Recupera o status de todos os trabalhos de importação/exportação em um IoTHub.

get_import_export_jobs()

Retornos

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

Recupera os detalhes de um trabalho agendado em um IoTHub.

get_scheduled_job(job_id)

Parâmetros

Nome	Description
job_id Obrigatório	str A ID do trabalho.

Retornos

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

Exceções

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

query_scheduled_jobs

Consulte um hub IoT para recuperar informações sobre trabalhos usando a linguagem de consulta Hub IoT.

query_scheduled_jobs(job_type, job_status)

Parâmetros

Nome	Description
job_type Obrigatório	str O tipo dos trabalhos.
job_status Obrigatório	str O status dos trabalhos.

Retornos

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

Exceções

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