Jobs - Get

Servizio:

IoT Central

Versione API:

2022-07-31

Ottenere un processo in base all'ID
Ottenere informazioni dettagliate su un processo in esecuzione o completato in base all'ID processo.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste del servizio Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	ID univoco del processo.
subdomain	path	True	string	Sottodominio dell'applicazione.
api-version	query	True	string	Versione dell'API chiamata.

Risposte

Nome	Tipo	Descrizione
200 OK	Job	Successo
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get a job by ID

Esempio di richiesta

HTTP

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Risposta di esempio

Codice di stato:

200

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definizioni

Nome	Descrizione
CloudPropertyJobData	Dati del processo delle proprietà cloud.
CommandJobData	Definizione dei dati del processo del comando.
DeviceTemplateMigrationJobData	Definizione dei dati del processo di migrazione del modello di dispositivo.
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.
Job	Definizione del processo.
JobBatch	Definizione del batch del processo.
JobBatchType	Indica se l'invio in batch viene eseguito su un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
JobCancellationThreshold	Definizione della soglia di annullamento del processo.
JobCancellationThresholdType	Indica se la soglia di annullamento è per un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
JobProgress	riepilogo dello stato di avanzamento per un processo pianificato.
PropertyJobData	Definizione dei dati del processo di proprietà.

CloudPropertyJobData

Object

Dati del processo delle proprietà cloud.

Nome	Tipo	Descrizione
path	string	Percorso della funzionalità di destinazione all'interno del modello di dispositivo.
target	string minLength: 1	Modello di dispositivo che definisce la funzionalità di destinazione per il processo.
type	string: cloudProperty	Tipo di dati del processo.
value	AnyValue	Valore usato per aggiornare la funzionalità di destinazione, se presente.

CommandJobData

Object

Definizione dei dati del processo del comando.

Nome	Tipo	Descrizione
path	string	Percorso della funzionalità di destinazione all'interno del modello di dispositivo.
target	string minLength: 1	Modello di dispositivo che definisce la funzionalità di destinazione per il processo.
type	string: command	Tipo di dati del processo.
value	AnyValue	Valore usato per aggiornare la funzionalità di destinazione, se presente.

DeviceTemplateMigrationJobData

Object

Definizione dei dati del processo di migrazione del modello di dispositivo.

Nome	Tipo	Descrizione
template	string minLength: 1	Modello di dispositivo di destinazione a cui verrà eseguita la migrazione dei dispositivi.
type	string: deviceTemplateMigration	Tipo di dati del processo.

Error

Object

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Object

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID correlazione per la richiesta corrente.
time	string (date-time-rfc1123)	Ora in cui la richiesta di errore non è riuscita.

Job

Object

Definizione del processo.

Nome	Tipo	Descrizione
batch	JobBatch	Configurazione di invio in batch per il processo.
cancellationThreshold	JobCancellationThreshold	Soglia di annullamento per il processo.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Le funzionalità aggiornate dal processo e i valori con cui vengono aggiornati.
description	string	Descrizione dettagliata del processo.
displayName	string	Nome visualizzato del processo.
end	string (date-time)	Ora di fine del processo
group	string	ID del gruppo di dispositivi in cui eseguire il processo.
id	string	ID univoco del processo.
organizations	string[]	Elenco di organizzazioni del lavoro, attualmente supportata solo un'organizzazione, più organizzazioni saranno presto supportate.
progress	JobProgress	Statistiche sullo stato di avanzamento del processo.
scheduledJobId	string	ID della definizione del processo pianificata che ha creato questo processo.
start	string (date-time)	Ora di inizio del processo
status	string	Indica se il processo viene avviato, in esecuzione e così via.

JobBatch

Object

Definizione del batch del processo.

Nome	Tipo	Descrizione
type	JobBatchType	Indica se l'invio in batch viene eseguito su un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
value	number	Numero o percentuale di dispositivi in cui viene eseguita l'invio in batch.

JobBatchType

Enumerazione

Indica se l'invio in batch viene eseguito su un numero specificato di dispositivi o una percentuale del totale dei dispositivi.

Valore	Descrizione
number	Batch di processi in base al numero di dispositivi.
percentage	Percentuale basata su batch di processi dei dispositivi applicati totali.

JobCancellationThreshold

Object

Definizione della soglia di annullamento del processo.

Nome	Tipo	Descrizione
batch	boolean	Indica se la soglia di annullamento si applica per batch o al processo complessivo.
type	JobCancellationThresholdType	Indica se la soglia di annullamento è per un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
value	number	Numero o percentuale di dispositivi in cui viene applicata la soglia di annullamento.

JobCancellationThresholdType

Enumerazione

Indica se la soglia di annullamento è per un numero specificato di dispositivi o una percentuale del totale dei dispositivi.

Valore	Descrizione
number	Soglia di annullamento del processo in base al numero specificato di dispositivi.
percentage	Soglia di annullamento del processo in base alla percentuale di dispositivi totali.

JobProgress

Object

riepilogo dello stato di avanzamento per un processo pianificato.

Nome	Tipo	Descrizione
completed	integer (int32)	Numero di entità per cui il processo è stato completato.
failed	integer (int32)	Numero di entità per le quali il processo non è riuscito.
pending	integer (int32)	Numero di entità per le quali il processo non è ancora in esecuzione.
total	integer (int32)	Numero totale di entità di destinazione del processo.

PropertyJobData

Object

Definizione dei dati del processo di proprietà.

Nome	Tipo	Descrizione
path	string	Percorso della funzionalità di destinazione all'interno del modello di dispositivo.
target	string minLength: 1	Modello di dispositivo che definisce la funzionalità di destinazione per il processo.
type	string: property	Tipo di dati del processo.
value	AnyValue	Valore usato per aggiornare la funzionalità di destinazione, se presente.