IoTHubJobManager Klas

Een klasse voor het bieden van handige API's voor IoTHub Job Manager-bewerkingen, op basis van de automatisch gegenereerde IotHub REST API's

Initialisatie voor een Job Manager-serviceclient.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

Overname

builtins.object

IoTHubJobManager

Constructor

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

Parameters

Name	Description
connection_string	str De IoTHub-connection string gebruikt om de verbinding met IoTHub te verifiëren als we connection_str-verificatie gebruiken. Standaardwaarde: Geen standaardwaarde: None
host	str De URL van de Azure-service als we verificatie van tokenreferenties gebruiken. Standaardwaarde: Geen standaardwaarde: None
auth	str Het Azure-verificatieobject als we verificatie van tokenreferenties gebruiken. Standaardwaarde: Geen standaardwaarde: None

Methoden

cancel_import_export_job	Hiermee annuleert u een import-/exporttaak op een IoT-hub.
cancel_scheduled_job	Hiermee annuleert u een geplande taak op een IoT-hub.
create_import_export_job	Hiermee maakt u een nieuwe import-/exporttaak op een IoT-hub.
create_scheduled_job	Hiermee maakt u een nieuwe taak voor het plannen van updatedubbels of apparaatbeheermethoden op een IoT-hub.
from_connection_string	Classmethod initializer voor een IoTHubJobManager-serviceclient. Hiermee maakt u de Klasse IoTHubJobManager op basis van connection string. Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.
from_token_credential	Classmethod initializer voor een IoTHubJobManager-serviceclient. Hiermee maakt u de Klasse IoTHubJobManager op basis van hostnaam-URL en Azure-tokenreferentie. Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.
get_import_export_job	Hiermee wordt de status opgehaald van een import-/exporttaak op een IoTHub.
get_import_export_jobs	Hiermee wordt de status opgehaald van alle import-/exporttaken op een IoTHub.
get_scheduled_job	Hiermee haalt u de details op van een geplande taak op een IoTHub.
query_scheduled_jobs	Voer een query uit op een IoT-hub om informatie over taken op te halen met behulp van de IoT Hub querytaal.

cancel_import_export_job

Hiermee annuleert u een import-/exporttaak op een IoT-hub.

cancel_import_export_job(job_id)

Parameters

Name	Description
job_id Vereist	str De id van de taak.

Retouren

Type	Description
	Object.

Uitzonderingen

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

cancel_scheduled_job

Hiermee annuleert u een geplande taak op een IoT-hub.

cancel_scheduled_job(job_id)

Parameters

Name	Description
job_id Vereist	str De id van de taak.

Retouren

Type	Description
<xref:azure.iot.hub.models.JobResponse>	Object JobResponse met de geannuleerde taak.

Uitzonderingen

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

create_import_export_job

Hiermee maakt u een nieuwe import-/exporttaak op een IoT-hub.

create_import_export_job(job_properties)

Parameters

Name	Description
job_properties Vereist	<xref:azure.iot.hub.models.JobProperties> Hiermee geeft u de taakspecificatie op.

Retouren

Type	Description
<xref:azure.iot.hub.models.JobProperties>	JobProperties-object met de gemaakte taak.

Uitzonderingen

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

create_scheduled_job

Hiermee maakt u een nieuwe taak voor het plannen van updatedubbels of apparaatbeheermethoden op een IoT-hub.

create_scheduled_job(job_id, job_request)

Parameters

Name	Description
job_id Vereist	str De id van de taak.
job_request Vereist	<xref:azure.iot.hub.models.JobRequest> Hiermee geeft u de taak op.

Retouren

Type	Description
<xref:azure.iot.hub.models.JobResponse>	JobResponse-object met de gemaakte taak.

Uitzonderingen

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

from_connection_string

Classmethod initializer voor een IoTHubJobManager-serviceclient. Hiermee maakt u de Klasse IoTHubJobManager op basis van connection string.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

from_connection_string(connection_string)

Parameters

Name	Description
connection_string Vereist	str De IoTHub-connection string gebruikt om de verbinding met IoTHub te verifiëren.

Retouren

Type	Description
IoTHubJobManager

Uitzonderingen

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

from_token_credential

Classmethod initializer voor een IoTHubJobManager-serviceclient. Hiermee maakt u de Klasse IoTHubJobManager op basis van hostnaam-URL en Azure-tokenreferentie.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

from_token_credential(url, token_credential)

Parameters

Name	Description
url Vereist	str De URL van de Azure-service (hostnaam).
token_credential Vereist	<xref:azure.core.TokenCredential> Het Azure-tokenreferentieobject

Retouren

Type	Description
IoTHubJobManager

Uitzonderingen

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

get_import_export_job

Hiermee wordt de status opgehaald van een import-/exporttaak op een IoTHub.

get_import_export_job(job_id)

Parameters

Name	Description
job_id Vereist	str De id van de taak.

Retouren

Type	Description
<xref:azure.iot.hub.models.JobProperties>	Het object JobProperties dat de aangevraagde taak bevat.

Uitzonderingen

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

get_import_export_jobs

Hiermee wordt de status opgehaald van alle import-/exporttaken op een IoTHub.

get_import_export_jobs()

Retouren

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

Uitzonderingen

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

get_scheduled_job

Hiermee haalt u de details op van een geplande taak op een IoTHub.

get_scheduled_job(job_id)

Parameters

Name	Description
job_id Vereist	str De id van de taak.

Retouren

Type	Description
<xref:azure.iot.hub.models.JobResponse>	Het object JobResponse met de aangevraagde details.

Uitzonderingen

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

query_scheduled_jobs

Voer een query uit op een IoT-hub om informatie over taken op te halen met behulp van de IoT Hub querytaal.

query_scheduled_jobs(job_type, job_status)

Parameters

Name	Description
job_type Vereist	str Het type taken.
job_status Vereist	str De status van de taken.

Retouren

Type	Description
<xref:azure.iot.hub.models.QueryResult>	QueryResult-object met de taken.

Uitzonderingen

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