Sdílet prostřednictvím

IoTHubJobManager Třída

  • Reference

Třída, která poskytuje rozhraní API pro pohodlí pro operace Správce úloh IoTHubu na základě automaticky vygenerovaných rozhraní REST API iotHubu.

Inicializátor klienta služby Správce úloh.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

Dědičnost
builtins.object
IoTHubJobManager

Konstruktor

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

Parametry

Name Description
connection_string
str

Připojovací řetězec IoTHubu použitý k ověření připojení k IoTHubu, pokud používáme ověřování connection_str. Výchozí hodnota: Žádná

výchozí hodnota: None
host
str

Adresa URL služby Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None
auth
str

Ověřovací objekt Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None

Metody

cancel_import_export_job

Zruší úlohu importu/exportu ve službě IoT Hub.
cancel_scheduled_job

Zruší naplánovanou úlohu ve službě IoT Hub.
create_import_export_job

Vytvoří novou úlohu importu/exportu ve službě IoT Hub.
create_scheduled_job

Vytvoří novou úlohu pro naplánování dvojčat aktualizací nebo metod přímého zařízení ve službě IoT Hub.
from_connection_string

Inicializátor classmethod pro klienta služby IoTHubJobManager Vytvoří třídu IoTHubJobManager z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
from_token_credential

Inicializátor classmethod pro klienta služby IoTHubJobManager Vytvoří třídu IoTHubJobManager z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
get_import_export_job

Načte stav úlohy importu/exportu na IoTHubu.
get_import_export_jobs

Načte stav všech úloh importu/exportu v IoTHubu.
get_scheduled_job

Načte podrobnosti o naplánované úloze na IoTHubu.
query_scheduled_jobs

Dotazem do centra IoT načtěte informace o úlohách pomocí dotazovacího jazyka IoT Hub.

cancel_import_export_job

Zruší úlohu importu/exportu ve službě IoT Hub.

cancel_import_export_job(job_id)

Parametry

Name Description
job_id
Vyžadováno
str

ID úlohy.

Návraty

Typ Description

Objekt.

Výjimky

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

cancel_scheduled_job

Zruší naplánovanou úlohu ve službě IoT Hub.

cancel_scheduled_job(job_id)

Parametry

Name Description
job_id
Vyžadováno
str

ID úlohy.

Návraty

Typ Description
<xref:azure.iot.hub.models.JobResponse>

JobResponse objekt obsahující zrušenou úlohu.

Výjimky

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

create_import_export_job

Vytvoří novou úlohu importu/exportu ve službě IoT Hub.

create_import_export_job(job_properties)

Parametry

Name Description
job_properties
Vyžadováno
<xref:azure.iot.hub.models.JobProperties>

Určuje specifikaci úlohy.

Návraty

Typ Description
<xref:azure.iot.hub.models.JobProperties>

JobProperties objekt obsahující vytvořenou úlohu.

Výjimky

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

create_scheduled_job

Vytvoří novou úlohu pro naplánování dvojčat aktualizací nebo metod přímého zařízení ve službě IoT Hub.

create_scheduled_job(job_id, job_request)

Parametry

Name Description
job_id
Vyžadováno
str

ID úlohy.
job_request
Vyžadováno
<xref:azure.iot.hub.models.JobRequest>

Určuje úlohu.

Návraty

Typ Description
<xref:azure.iot.hub.models.JobResponse>

JobResponse objekt obsahující vytvořenou úlohu.

Výjimky

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

from_connection_string

Inicializátor classmethod pro klienta služby IoTHubJobManager Vytvoří třídu IoTHubJobManager z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_connection_string(connection_string)

Parametry

Name Description
connection_string
Vyžadováno
str

Připojovací řetězec IoTHubu, který slouží k ověření připojení k IoTHubu.

Návraty

Typ Description
IoTHubJobManager

Výjimky

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

from_token_credential

Inicializátor classmethod pro klienta služby IoTHubJobManager Vytvoří třídu IoTHubJobManager z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_token_credential(url, token_credential)

Parametry

Name Description
url
Vyžadováno
str

Adresa URL služby Azure (název hostitele).
token_credential
Vyžadováno
<xref:azure.core.TokenCredential>

Objekt přihlašovacích údajů tokenu Azure

Návraty

Typ Description
IoTHubJobManager

Výjimky

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

get_import_export_job

Načte stav úlohy importu/exportu na IoTHubu.

get_import_export_job(job_id)

Parametry

Name Description
job_id
Vyžadováno
str

ID úlohy.

Návraty

Typ Description
<xref:azure.iot.hub.models.JobProperties>

Objekt JobProperties obsahující požadovanou úlohu.

Výjimky

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

get_import_export_jobs

Načte stav všech úloh importu/exportu v IoTHubu.

get_import_export_jobs()

Návraty

Typ Description
list[<xref:azure.iot.hub.models.JobProperties>]

Objekt list[job_properties].

Výjimky

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

get_scheduled_job

Načte podrobnosti o naplánované úloze na IoTHubu.

get_scheduled_job(job_id)

Parametry

Name Description
job_id
Vyžadováno
str

ID úlohy.

Návraty

Typ Description
<xref:azure.iot.hub.models.JobResponse>

Objekt JobResponse obsahující požadované podrobnosti.

Výjimky

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

query_scheduled_jobs

Dotazem do centra IoT načtěte informace o úlohách pomocí dotazovacího jazyka IoT Hub.

query_scheduled_jobs(job_type, job_status)

Parametry

Name Description
job_type
Vyžadováno
str

Typ úloh.
job_status
Vyžadováno
str

Stav úloh.

Návraty

Typ Description
<xref:azure.iot.hub.models.QueryResult>

QueryResult objekt obsahující úlohy.

Výjimky

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