Jobs - Cancel Scheduled Job

  • Riferimento
Service:
IoT Hub
API Version:
2021-04-12

Annulla un processo pianificato nel hub IoT. Per altre informazioni, vedere https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}/cancel?api-version=2021-04-12

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
 path True

string

Identificatore univoco del processo.
api-version
 query True

string

Versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

JobResponse

OK.

Definizioni

Nome Descrizione
CloudToDeviceMethod

Parametri da eseguire un metodo diretto nel dispositivo.
DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.
DeviceJobStatistics

Statistiche del processo relative allo stato di esecuzione.
JobResponse
Twin

Informazioni sullo stato per un dispositivo o un modulo. Questa operazione viene creata ed eliminata in modo implicito quando l'identità del dispositivo/modulo corrispondente viene creata o eliminata nella hub IoT.
TwinProperties

Proprietà desiderate e segnalate del gemello. La profondità massima dell'oggetto è 10.
X509Thumbprint

CloudToDeviceMethod

Parametri da eseguire un metodo diretto nel dispositivo.

Nome Tipo Descrizione
connectTimeoutInSeconds

integer

methodName

string

Nome del metodo da eseguire.
payload

object

Payload del metodo diretto formattato in JSON fino a 128 kb di dimensioni.
responseTimeoutInSeconds

integer

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.

Nome Tipo Descrizione
iotEdge

boolean

Proprietà che determina se il dispositivo è un dispositivo perimetrale o meno.

DeviceJobStatistics

Statistiche del processo relative allo stato di esecuzione.

Nome Tipo Descrizione
deviceCount

integer

Numero di dispositivi destinati al processo.
failedCount

integer

Numero di processi non riusciti.
pendingCount

integer

Numero di processi in sospeso (pianificati).
runningCount

integer

Numero di processi in esecuzione.
succeededCount

integer

Numero di processi riusciti.

JobResponse

Nome Tipo Descrizione
cloudToDeviceMethod

CloudToDeviceMethod

Tipo di metodo e parametri. Questa operazione è necessaria se il tipo di processo è cloudToDeviceMethod.
createdTime

string

Sistema generato. Ignorato alla creazione. Data e ora di creazione del processo.
deviceJobStatistics

DeviceJobStatistics

Dettagli relativi allo stato di esecuzione del processo.
endTime

string

Sistema generato. Ignorato alla creazione. Data e ora di fine del processo in formato UTC.
failureReason

string

Motivo dell'errore, se si è verificato un errore.
jobId

string

Sistema generato. Ignorato alla creazione. Identificatore univoco del processo.
maxExecutionTimeInSeconds

integer

Tempo di esecuzione massimo in secound.
queryCondition

string

Condizione di query del dispositivo.
startTime

string

Data e ora di inizio del processo pianificato in FORMATO UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistema generato. Ignorato alla creazione. Stato del processo.
statusMessage

string

Messaggio di stato del processo.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Tipo di processo.
updateTwin

Twin

Informazioni sullo stato per un dispositivo o un modulo. Questa operazione viene creata ed eliminata in modo implicito quando l'identità del dispositivo/modulo corrispondente viene creata o eliminata nella hub IoT.

Twin

Informazioni sullo stato per un dispositivo o un modulo. Questa operazione viene creata ed eliminata in modo implicito quando l'identità del dispositivo/modulo corrispondente viene creata o eliminata nella hub IoT.

Nome Tipo Descrizione
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Tipo di autenticazione usato dal dispositivo.
capabilities

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.
cloudToDeviceMessageCount

integer

Numero di messaggi da cloud a dispositivo inviati.
connectionState enum:
  • Connected
  • Disconnected

Stato della connessione del dispositivo.
deviceEtag

string

Stringa che rappresenta un ETag per il dispositivo, come per RFC7232.
deviceId

string

Identificatore univoco del dispositivo nel Registro identità del hub IoT. È una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri) di caratteri alfanumerici a ASCII a 7 bit, e i caratteri speciali seguenti {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(',', '=', '@', '@', '', '$', ''}.
deviceScope

string

Ambito del dispositivo.
etag

string

Stringa che rappresenta un ETag per il dispositivo gemello, come per RFC7232.
lastActivityTime

string

Data e ora in cui il dispositivo è stato connesso o ricevuto o inviato un messaggio. La data e l'ora vengono specificate in ISO8601 formato datetime in formato UTC, ad esempio 2015-01-28T16:24:48.789Z. Questo valore non viene aggiornato se il dispositivo usa il protocollo HTTP/1 per eseguire operazioni di messaggistica.
moduleId

string

Identificatore univoco del modulo nel Registro di sistema delle identità del hub IoT. È una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri) di caratteri alfanumerici a ASCII a 7 bit, e i caratteri speciali seguenti {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(',', '=', '@', '@', '', '$', ''}.
parentScopes

string[]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Disponibile solo per i dispositivi perimetrali.
properties

TwinProperties

Proprietà desiderate e segnalate del gemello.
status enum:
  • disabled
  • enabled

Stato abilitato del dispositivo. Se disabilitato, il dispositivo non può connettersi al servizio.
statusReason

string

Motivo dello stato corrente del dispositivo, se presente.
statusUpdateTime

string

Data e ora dell'ultimo aggiornamento dello stato del dispositivo.
tags

object

Raccolta di coppie chiave-valore letti e scritti dal back-end della soluzione. Non sono visibili alle app del dispositivo. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori sono oggetti JSON, fino a 4 KB in lunghezza.
version

integer

Versione per il dispositivo gemello, inclusi tag e proprietà desiderate
x509Thumbprint

X509Thumbprint

Identificazione personale X509 del dispositivo.

TwinProperties

Proprietà desiderate e segnalate del gemello. La profondità massima dell'oggetto è 10.

Nome Tipo Descrizione
desired

object

Raccolta di coppie chiave-valore della proprietà desiderate. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori di porperty desiderati sono oggetti JSON, fino a 4 KB di lunghezza.
reported

object

Raccolta di coppie chiave chiave-valore della proprietà segnalate. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori delle proprietà segnalate sono oggetti JSON, fino a 4 KB di lunghezza.

X509Thumbprint

Nome Tipo Descrizione
primaryThumbprint

string

Identificazione personale primaria del certificato client X509.
secondaryThumbprint

string

Identificazione personale secondaria del certificato client X509.