Share via

IoTHubJobManager Klasse

  • Referenz

Eine Klasse zum Bereitstellen von Komfort-APIs für IoTHub Job Manager-Vorgänge, basierend auf den automatisch generierten IotHub-REST-APIs

Initialisierer für einen Job Manager-Dienstclient.

Nach erfolgreicher Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs aufrufen, um mit IoTHub zu kommunizieren.

Vererbung
builtins.object
IoTHubJobManager

Konstruktor

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

Parameter

Name Beschreibung
connection_string
str

Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird, wenn wir connection_str Authentifizierung verwenden. Standardwert: Keiner

Standardwert: None
host
str

Die Azure-Dienst-URL, wenn wir die Tokenanmeldeinformationenauthentifizierung verwenden. Standardwert: Keiner

Standardwert: None
auth
str

Das Azure-Authentifizierungsobjekt, wenn wir die Tokenanmeldeinformationenauthentifizierung verwenden. Standardwert: Keiner

Standardwert: None

Methoden

cancel_import_export_job

Bricht einen Import-/Exportauftrag in einem IoT Hub ab.
cancel_scheduled_job

Bricht einen geplanten Auftrag in einem IoT Hub ab.
create_import_export_job

Erstellt einen neuen Import-/Exportauftrag in einem IoT Hub.
create_scheduled_job

Erstellt einen neuen Auftrag zum Planen von Updatezwillen oder gerätedirekten Methoden in einem IoT Hub.
from_connection_string

Classmethod-Initialisierer für einen IoTHubJobManager-Dienstclient. Erstellt die IoTHubJobManager-Klasse aus der Verbindungszeichenfolge.

Nach erfolgreicher Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs aufrufen, um mit IoTHub zu kommunizieren.
from_token_credential

Classmethod-Initialisierer für einen IoTHubJobManager-Dienstclient. Erstellt die IoTHubJobManager-Klasse aus Hostnamen-URL und Azure-Tokenanmeldeinformationen.

Nach erfolgreicher Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs aufrufen, um mit IoTHub zu kommunizieren.
get_import_export_job

Ruft die status eines Import-/Exportauftrags auf einem IoTHub ab.
get_import_export_jobs

Ruft die status aller Import-/Exportaufträge auf einem IoTHub ab.
get_scheduled_job

Ruft die Details eines geplanten Auftrags auf einem IoTHub ab.
query_scheduled_jobs

Fragen Sie einen IoT Hub ab, um Informationen zu Aufträgen mithilfe der IoT Hub Abfragesprache abzurufen.

cancel_import_export_job

Bricht einen Import-/Exportauftrag in einem IoT Hub ab.

cancel_import_export_job(job_id)

Parameter

Name Beschreibung
job_id
Erforderlich
str

Die ID des Auftrags.

Gibt zurück

Typ Beschreibung

Widerspruchsrecht:

Ausnahmen

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

cancel_scheduled_job

Bricht einen geplanten Auftrag in einem IoT Hub ab.

cancel_scheduled_job(job_id)

Parameter

Name Beschreibung
job_id
Erforderlich
str

Die ID des Auftrags.

Gibt zurück

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

JobResponse-Objekt, das den abgebrochenen Auftrag enthält.

Ausnahmen

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

create_import_export_job

Erstellt einen neuen Import-/Exportauftrag in einem IoT Hub.

create_import_export_job(job_properties)

Parameter

Name Beschreibung
job_properties
Erforderlich
<xref:azure.iot.hub.models.JobProperties>

Gibt die Auftragsspezifikation an.

Gibt zurück

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

JobProperties-Objekt, das den erstellten Auftrag enthält.

Ausnahmen

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

create_scheduled_job

Erstellt einen neuen Auftrag zum Planen von Updatezwillen oder gerätedirekten Methoden in einem IoT Hub.

create_scheduled_job(job_id, job_request)

Parameter

Name Beschreibung
job_id
Erforderlich
str

Die ID des Auftrags.
job_request
Erforderlich
<xref:azure.iot.hub.models.JobRequest>

Gibt den Auftrag an.

Gibt zurück

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

JobResponse-Objekt, das den erstellten Auftrag enthält.

Ausnahmen

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

from_connection_string

Classmethod-Initialisierer für einen IoTHubJobManager-Dienstclient. Erstellt die IoTHubJobManager-Klasse aus der Verbindungszeichenfolge.

Nach erfolgreicher Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs aufrufen, um mit IoTHub zu kommunizieren.

from_connection_string(connection_string)

Parameter

Name Beschreibung
connection_string
Erforderlich
str

Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird.

Gibt zurück

Typ Beschreibung
IoTHubJobManager

Ausnahmen

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

from_token_credential

Classmethod-Initialisierer für einen IoTHubJobManager-Dienstclient. Erstellt die IoTHubJobManager-Klasse aus Hostnamen-URL und Azure-Tokenanmeldeinformationen.

Nach erfolgreicher Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs aufrufen, um mit IoTHub zu kommunizieren.

from_token_credential(url, token_credential)

Parameter

Name Beschreibung
url
Erforderlich
str

Die Azure-Dienst-URL (Hostname).
token_credential
Erforderlich
<xref:azure.core.TokenCredential>

Das Azure-Tokenanmeldeinformationsobjekt

Gibt zurück

Typ Beschreibung
IoTHubJobManager

Ausnahmen

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

get_import_export_job

Ruft die status eines Import-/Exportauftrags auf einem IoTHub ab.

get_import_export_job(job_id)

Parameter

Name Beschreibung
job_id
Erforderlich
str

Die ID des Auftrags.

Gibt zurück

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

Das JobProperties-Objekt, das den angeforderten Auftrag enthält.

Ausnahmen

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

get_import_export_jobs

Ruft die status aller Import-/Exportaufträge auf einem IoTHub ab.

get_import_export_jobs()

Gibt zurück

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

Das list[job_properties]-Objekt.

Ausnahmen

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

get_scheduled_job

Ruft die Details eines geplanten Auftrags auf einem IoTHub ab.

get_scheduled_job(job_id)

Parameter

Name Beschreibung
job_id
Erforderlich
str

Die ID des Auftrags.

Gibt zurück

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

Das JobResponse-Objekt, das die angeforderten Details enthält.

Ausnahmen

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

query_scheduled_jobs

Fragen Sie einen IoT Hub ab, um Informationen zu Aufträgen mithilfe der IoT Hub Abfragesprache abzurufen.

query_scheduled_jobs(job_type, job_status)

Parameter

Name Beschreibung
job_type
Erforderlich
str

Der Typ der Aufträge.
job_status
Erforderlich
str

Die status der Aufträge.

Gibt zurück

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

QueryResult-Objekt, das die Aufträge enthält.

Ausnahmen

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