IoTHubJobManager Classe

  • Riferimento

Classe per fornire API utili per le operazioni di Gestione processi IoTHub, in base alle API REST IotHub generate automaticamente

Inizializzatore per un client del servizio Job Manager.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

Ereditarietà
builtins.object
IoTHubJobManager

Costruttore

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

Parametri

Nome Descrizione
connection_string
str

Stringa di connessione IoTHub usata per autenticare la connessione con IoTHub se si usa connection_str'autenticazione. Valore predefinito: Nessuno

valore predefinito: None
host
str

URL del servizio di Azure se si usa l'autenticazione delle credenziali dei token. Valore predefinito: Nessuno

valore predefinito: None
auth
str

Oggetto di autenticazione di Azure se si usa l'autenticazione delle credenziali dei token. Valore predefinito: Nessuno

valore predefinito: None

Metodi

cancel_import_export_job

Annulla un processo di importazione/esportazione in un hub IoT.
cancel_scheduled_job

Annulla un processo pianificato in un hub IoT.
create_import_export_job

Crea un nuovo processo di importazione/esportazione in un hub IoT.
create_scheduled_job

Crea un nuovo processo per pianificare gli aggiornamenti gemelli o i metodi diretti del dispositivo in un hub IoT.
from_connection_string

Inizializzatore classmethod per un client del servizio IoTHubJobManager. Crea la classe IoTHubJobManager dalla stringa di connessione.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
from_token_credential

Inizializzatore classmethod per un client del servizio IoTHubJobManager. Crea la classe IoTHubJobManager dall'URL del nome host e dalle credenziali del token di Azure.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
get_import_export_job

Recupera lo stato di un processo di importazione/esportazione in un IoTHub.
get_import_export_jobs

Recupera lo stato di tutti i processi di importazione/esportazione in un IoTHub.
get_scheduled_job

Recupera i dettagli di un processo pianificato in un IoTHub.
query_scheduled_jobs

Eseguire una query su un hub IoT per recuperare informazioni relative ai processi usando il linguaggio di query hub IoT.

cancel_import_export_job

Annulla un processo di importazione/esportazione in un hub IoT.

cancel_import_export_job(job_id)

Parametri

Nome Descrizione
job_id
Necessario
str

ID del processo.

Restituisce

Tipo Descrizione

Oggetto.

Eccezioni

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

cancel_scheduled_job

Annulla un processo pianificato in un hub IoT.

cancel_scheduled_job(job_id)

Parametri

Nome Descrizione
job_id
Necessario
str

ID del processo.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.JobResponse>

Oggetto JobResponse contenente il processo annullato.

Eccezioni

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

create_import_export_job

Crea un nuovo processo di importazione/esportazione in un hub IoT.

create_import_export_job(job_properties)

Parametri

Nome Descrizione
job_properties
Necessario
<xref:azure.iot.hub.models.JobProperties>

Specifica la specifica del processo.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.JobProperties>

Oggetto JobProperties contenente il processo creato.

Eccezioni

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

create_scheduled_job

Crea un nuovo processo per pianificare gli aggiornamenti gemelli o i metodi diretti del dispositivo in un hub IoT.

create_scheduled_job(job_id, job_request)

Parametri

Nome Descrizione
job_id
Necessario
str

ID del processo.
job_request
Necessario
<xref:azure.iot.hub.models.JobRequest>

Specifica il processo.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.JobResponse>

Oggetto JobResponse contenente il processo creato.

Eccezioni

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

from_connection_string

Inizializzatore classmethod per un client del servizio IoTHubJobManager. Crea la classe IoTHubJobManager dalla stringa di connessione.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_connection_string(connection_string)

Parametri

Nome Descrizione
connection_string
Necessario
str

Stringa di connessione IoTHub usata per autenticare la connessione con IoTHub.

Restituisce

Tipo Descrizione
IoTHubJobManager

Eccezioni

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

from_token_credential

Inizializzatore classmethod per un client del servizio IoTHubJobManager. Crea la classe IoTHubJobManager dall'URL del nome host e dalle credenziali del token di Azure.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_token_credential(url, token_credential)

Parametri

Nome Descrizione
url
Necessario
str

URL del servizio di Azure (nome host).
token_credential
Necessario
<xref:azure.core.TokenCredential>

Oggetto credenziali del token di Azure

Restituisce

Tipo Descrizione
IoTHubJobManager

Eccezioni

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

get_import_export_job

Recupera lo stato di un processo di importazione/esportazione in un IoTHub.

get_import_export_job(job_id)

Parametri

Nome Descrizione
job_id
Necessario
str

ID del processo.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.JobProperties>

Oggetto JobProperties contenente il processo richiesto.

Eccezioni

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

get_import_export_jobs

Recupera lo stato di tutti i processi di importazione/esportazione in un IoTHub.

get_import_export_jobs()

Restituisce

Tipo Descrizione
list[<xref:azure.iot.hub.models.JobProperties>]

Oggetto list[job_properties].

Eccezioni

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

get_scheduled_job

Recupera i dettagli di un processo pianificato in un IoTHub.

get_scheduled_job(job_id)

Parametri

Nome Descrizione
job_id
Necessario
str

ID del processo.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.JobResponse>

Oggetto JobResponse contenente i dettagli richiesti.

Eccezioni

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

query_scheduled_jobs

Eseguire una query su un hub IoT per recuperare informazioni relative ai processi usando il linguaggio di query hub IoT.

query_scheduled_jobs(job_type, job_status)

Parametri

Nome Descrizione
job_type
Necessario
str

Tipo dei processi.
job_status
Necessario
str

Stato dei processi.

Restituisce

Tipo Descrizione
<xref:azure.iot.hub.models.QueryResult>

Oggetto QueryResult contenente i processi.

Eccezioni

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