Udostępnij za pośrednictwem

IoTHubJobManager Klasa

  • Odwołanie

Klasa zapewniająca wygodne interfejsy API dla operacji usługi IoTHub Job Manager na podstawie automatycznie generowanych interfejsów API REST usługi IotHub

Inicjator klienta usługi Menedżera zadań.

Po pomyślnym utworzeniu klasy została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

Dziedziczenie
builtins.object
IoTHubJobManager

Konstruktor

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

Parametry

Nazwa Opis
connection_string
str

Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub, jeśli używamy connection_str uwierzytelniania. Wartość domyślna: Brak

wartość domyślna: None
host
str

Adres URL usługi platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak

wartość domyślna: None
auth
str

Obiekt uwierzytelniania platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak

wartość domyślna: None

Metody

cancel_import_export_job

Anuluje zadanie importu/eksportu w centrum IoT.
cancel_scheduled_job

Anuluje zaplanowane zadanie w centrum IoT.
create_import_export_job

Tworzy nowe zadanie importowania/eksportowania w centrum IoT.
create_scheduled_job

Tworzy nowe zadanie umożliwiające zaplanowanie aktualizacji bliźniaczych reprezentacji bliźniaczych lub metod bezpośrednich urządzeń w centrum IoT.
from_connection_string

Inicjator klasymethod dla klienta usługi IoTHubJobManager. Tworzy klasę IoTHubJobManager na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasy została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
from_token_credential

Inicjator klasymethod dla klienta usługi IoTHubJobManager. Tworzy klasę IoTHubJobManager na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasy została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
get_import_export_job

Pobiera stan zadania importu/eksportu w usłudze IoTHub.
get_import_export_jobs

Pobiera stan wszystkich zadań importu/eksportu w usłudze IoTHub.
get_scheduled_job

Pobiera szczegóły zaplanowanego zadania w usłudze IoTHub.
query_scheduled_jobs

Wykonaj zapytanie względem centrum IoT, aby pobrać informacje dotyczące zadań przy użyciu języka zapytań IoT Hub.

cancel_import_export_job

Anuluje zadanie importu/eksportu w centrum IoT.

cancel_import_export_job(job_id)

Parametry

Nazwa Opis
job_id
Wymagane
str

Identyfikator zadania.

Zwraca

Typ Opis

Obiektu.

Wyjątki

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

cancel_scheduled_job

Anuluje zaplanowane zadanie w centrum IoT.

cancel_scheduled_job(job_id)

Parametry

Nazwa Opis
job_id
Wymagane
str

Identyfikator zadania.

Zwraca

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

Obiekt JobResponse zawierający anulowane zadanie.

Wyjątki

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

create_import_export_job

Tworzy nowe zadanie importowania/eksportowania w centrum IoT.

create_import_export_job(job_properties)

Parametry

Nazwa Opis
job_properties
Wymagane
<xref:azure.iot.hub.models.JobProperties>

Określa specyfikację zadania.

Zwraca

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

Obiekt JobProperties zawierający utworzone zadanie.

Wyjątki

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

create_scheduled_job

Tworzy nowe zadanie umożliwiające zaplanowanie aktualizacji bliźniaczych reprezentacji bliźniaczych lub metod bezpośrednich urządzeń w centrum IoT.

create_scheduled_job(job_id, job_request)

Parametry

Nazwa Opis
job_id
Wymagane
str

Identyfikator zadania.
job_request
Wymagane
<xref:azure.iot.hub.models.JobRequest>

Określa zadanie.

Zwraca

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

Obiekt JobResponse zawierający utworzone zadanie.

Wyjątki

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

from_connection_string

Inicjator klasymethod dla klienta usługi IoTHubJobManager. Tworzy klasę IoTHubJobManager na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasy została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_connection_string(connection_string)

Parametry

Nazwa Opis
connection_string
Wymagane
str

Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub.

Zwraca

Typ Opis
IoTHubJobManager

Wyjątki

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

from_token_credential

Inicjator klasymethod dla klienta usługi IoTHubJobManager. Tworzy klasę IoTHubJobManager na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasy została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_token_credential(url, token_credential)

Parametry

Nazwa Opis
url
Wymagane
str

Adres URL usługi platformy Azure (nazwa hosta).
token_credential
Wymagane
<xref:azure.core.TokenCredential>

Obiekt poświadczeń tokenu platformy Azure

Zwraca

Typ Opis
IoTHubJobManager

Wyjątki

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

get_import_export_job

Pobiera stan zadania importu/eksportu w usłudze IoTHub.

get_import_export_job(job_id)

Parametry

Nazwa Opis
job_id
Wymagane
str

Identyfikator zadania.

Zwraca

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

Obiekt JobProperties zawierający żądane zadanie.

Wyjątki

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

get_import_export_jobs

Pobiera stan wszystkich zadań importu/eksportu w usłudze IoTHub.

get_import_export_jobs()

Zwraca

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

Obiekt list[job_properties].

Wyjątki

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

get_scheduled_job

Pobiera szczegóły zaplanowanego zadania w usłudze IoTHub.

get_scheduled_job(job_id)

Parametry

Nazwa Opis
job_id
Wymagane
str

Identyfikator zadania.

Zwraca

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

Obiekt JobResponse zawierający żądane szczegóły.

Wyjątki

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

query_scheduled_jobs

Wykonaj zapytanie względem centrum IoT, aby pobrać informacje dotyczące zadań przy użyciu języka zapytań IoT Hub.

query_scheduled_jobs(job_type, job_status)

Parametry

Nazwa Opis
job_type
Wymagane
str

Typ zadań.
job_status
Wymagane
str

Stan zadań.

Zwraca

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

Obiekt QueryResult zawierający zadania.

Wyjątki

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