Condividi tramite


Iot Hub Resource - List Jobs

Ottenere un elenco di tutti i processi in 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?api-version=2023-06-30

Parametri dell'URI

Nome In Necessario Tipo Descrizione
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

JobResponseListResult

Si tratta di un'operazione sincrona. La risposta contiene una matrice serializzata JSON di tutti i processi 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_ListJobs

Esempio di richiesta

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

Risposta di esempio

{
  "value": [
    {
      "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.

JobResponseListResult

Matrice serializzata JSON di oggetti JobResponse con un collegamento successivo.

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

Ora in cui il processo ha interrotto l'elaborazione.

failureReason

string

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

jobId

string

Identificatore di processo.

parentJobId

string

Identificatore del processo padre, se presente.

startTimeUtc

string

Ora di inizio del processo.

status

JobStatus

Stato del processo.

statusMessage

string

Messaggio di stato per il processo.

type

JobType

Tipo del processo.

JobResponseListResult

Matrice serializzata JSON di oggetti JobResponse con un collegamento successivo.

Nome Tipo Descrizione
nextLink

string

Collegamento successivo.

value

JobResponse[]

Matrice di oggetti JobResponse.

JobStatus

Stato del processo.

Nome Tipo Descrizione
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Tipo del processo.

Nome Tipo Descrizione
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string