Share via


IoTHubJobManager Osztály

Az automatikusan létrehozott IotHub REST API-kon alapuló, az IoTHub Job Manager-műveletekhez használható kényelmi API-kat biztosító osztály

A Feladatkezelő szolgáltatásügyfél Inicializálója.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

Öröklődés
builtins.object
IoTHubJobManager

Konstruktor

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

Paraméterek

Name Description
connection_string
str

Az IoTHub kapcsolati sztring az IoTHub-kapcsolat hitelesítésére szolgál, ha connection_str hitelesítést használunk. Alapértelmezett érték: Nincs

alapértelmezett érték: None
host
str

Az Azure-szolgáltatás URL-címe, ha jogkivonat hitelesítő adatait használjuk. Alapértelmezett érték: Nincs

alapértelmezett érték: None
auth
str

Az Azure-hitelesítési objektum, ha jogkivonat hitelesítő adatait használjuk. Alapértelmezett érték: Nincs

alapértelmezett érték: None

Metódusok

cancel_import_export_job

Megszakít egy importálási/exportálási feladatot egy IoT Hubon.

cancel_scheduled_job

Megszakít egy ütemezett feladatot egy IoT Hubon.

create_import_export_job

Új importálási/exportálási feladatot hoz létre egy IoT Hubon.

create_scheduled_job

Létrehoz egy új feladatot az ikerpéldányok vagy közvetlen eszközmetódusok ütemezéséhez egy IoT Hubon.

from_connection_string

Classmethod initializer egy IoTHubJobManager Service-ügyfélhez. Létrehozza az IoTHubJobManager osztályt kapcsolati sztring.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_token_credential

Classmethod initializer egy IoTHubJobManager Service-ügyfélhez. Létrehozza az IoTHubJobManager osztályt a gazdagépnév URL-címéből és az Azure-jogkivonat hitelesítő adataiból.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

get_import_export_job

Lekéri egy importálási/exportálási feladat állapotát egy IoTHubon.

get_import_export_jobs

Lekéri az összes importálási/exportálási feladat állapotát egy IoTHubon.

get_scheduled_job

Lekéri egy ütemezett feladat részleteit egy IoTHubon.

query_scheduled_jobs

Lekérdezhet egy IoT Hubot a feladatokra vonatkozó információk lekéréséhez a IoT Hub lekérdezési nyelv használatával.

cancel_import_export_job

Megszakít egy importálási/exportálási feladatot egy IoT Hubon.

cancel_import_export_job(job_id)

Paraméterek

Name Description
job_id
Kötelező
str

A feladat azonosítója.

Válaszok

Típus Description

Objektum.

Kivételek

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

cancel_scheduled_job

Megszakít egy ütemezett feladatot egy IoT Hubon.

cancel_scheduled_job(job_id)

Paraméterek

Name Description
job_id
Kötelező
str

A feladat azonosítója.

Válaszok

Típus Description
<xref:azure.iot.hub.models.JobResponse>

A megszakított feladatot tartalmazó JobResponse objektum.

Kivételek

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

create_import_export_job

Új importálási/exportálási feladatot hoz létre egy IoT Hubon.

create_import_export_job(job_properties)

Paraméterek

Name Description
job_properties
Kötelező
<xref:azure.iot.hub.models.JobProperties>

Megadja a feladat specifikációját.

Válaszok

Típus Description
<xref:azure.iot.hub.models.JobProperties>

A létrehozott feladatot tartalmazó JobProperties objektum.

Kivételek

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

create_scheduled_job

Létrehoz egy új feladatot az ikerpéldányok vagy közvetlen eszközmetódusok ütemezéséhez egy IoT Hubon.

create_scheduled_job(job_id, job_request)

Paraméterek

Name Description
job_id
Kötelező
str

A feladat azonosítója.

job_request
Kötelező
<xref:azure.iot.hub.models.JobRequest>

Megadja a feladatot.

Válaszok

Típus Description
<xref:azure.iot.hub.models.JobResponse>

JobResponse objektum, amely a létrehozott feladatot tartalmazza.

Kivételek

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

from_connection_string

Classmethod initializer egy IoTHubJobManager Service-ügyfélhez. Létrehozza az IoTHubJobManager osztályt kapcsolati sztring.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_connection_string(connection_string)

Paraméterek

Name Description
connection_string
Kötelező
str

Az IoTHub kapcsolati sztring az IoTHubbal való kapcsolat hitelesítésére szolgál.

Válaszok

Típus Description

Kivételek

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

from_token_credential

Classmethod initializer egy IoTHubJobManager Service-ügyfélhez. Létrehozza az IoTHubJobManager osztályt a gazdagépnév URL-címéből és az Azure-jogkivonat hitelesítő adataiból.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_token_credential(url, token_credential)

Paraméterek

Name Description
url
Kötelező
str

Az Azure-szolgáltatás URL-címe (állomásnév).

token_credential
Kötelező
<xref:azure.core.TokenCredential>

Az Azure-jogkivonat hitelesítőadat-objektuma

Válaszok

Típus Description

Kivételek

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

get_import_export_job

Lekéri egy importálási/exportálási feladat állapotát egy IoTHubon.

get_import_export_job(job_id)

Paraméterek

Name Description
job_id
Kötelező
str

A feladat azonosítója.

Válaszok

Típus Description
<xref:azure.iot.hub.models.JobProperties>

A kért feladatot tartalmazó JobProperties objektum.

Kivételek

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

get_import_export_jobs

Lekéri az összes importálási/exportálási feladat állapotát egy IoTHubon.

get_import_export_jobs()

Válaszok

Típus Description
list[<xref:azure.iot.hub.models.JobProperties>]

A list[job_properties] objektum.

Kivételek

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

get_scheduled_job

Lekéri egy ütemezett feladat részleteit egy IoTHubon.

get_scheduled_job(job_id)

Paraméterek

Name Description
job_id
Kötelező
str

A feladat azonosítója.

Válaszok

Típus Description
<xref:azure.iot.hub.models.JobResponse>

A JobResponse objektum, amely a kért adatokat tartalmazza.

Kivételek

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

query_scheduled_jobs

Lekérdezhet egy IoT Hubot a feladatokra vonatkozó információk lekéréséhez a IoT Hub lekérdezési nyelv használatával.

query_scheduled_jobs(job_type, job_status)

Paraméterek

Name Description
job_type
Kötelező
str

A feladatok típusa.

job_status
Kötelező
str

A feladatok állapota.

Válaszok

Típus Description
<xref:azure.iot.hub.models.QueryResult>

A feladatokat tartalmazó QueryResult objektum.

Kivételek

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