Condividi tramite


Iot Hub Resource - Get Job

Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}?api-version=2023-06-30

Parametri dell'URI

Nome In Necessario Tipo Descrizione
jobId
path True

string

Identificatore del processo.

resourceGroupName
path True

string

Nome del gruppo di risorse che contiene l'hub IoT.

resourceName
path True

string

Nome dell'hub IoT.

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

JobResponse

Si tratta di un'operazione sincrona. La risposta contiene una descrizione serializzata JSON del processo nell'hub IoT.

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

IotHubResource_GetJob

Esempio di richiesta

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/jobs/test?api-version=2023-06-30

Risposta di esempio

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

Definizioni

Nome Descrizione
ErrorDetails

Dettagli errore.

JobResponse

Proprietà dell'oggetto Job Response.

JobStatus

Stato del processo.

JobType

Tipo del processo.

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

JobResponse

Proprietà dell'oggetto Job Response.

Nome Tipo Descrizione
endTimeUtc

string (date-time-rfc1123)

Ora in cui il processo ha arrestato l'elaborazione.

failureReason

string

Se status == non è riuscito, questa stringa contenente il motivo dell'errore.

jobId

string

Identificatore del processo.

parentJobId

string

Identificatore del processo padre, se presente.

startTimeUtc

string (date-time-rfc1123)

Ora di inizio del processo.

status

JobStatus

Stato del processo.

statusMessage

string

Messaggio di stato per il processo.

type

JobType

Tipo del processo.

JobStatus

Stato del processo.

Valore Descrizione
cancelled
completed
enqueued
failed
running
unknown

JobType

Tipo del processo.

Valore Descrizione
backup
export
factoryResetDevice
firmwareUpdate
import
readDeviceProperties
rebootDevice
unknown
updateDeviceConfiguration
writeDeviceProperties