Partager via


Iot Hub Resource - Get Job

Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez 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

Paramètres URI

Nom Dans Obligatoire Type Description
jobId
path True

string

Identificateur du travail.

resourceGroupName
path True

string

Nom du groupe de ressources qui contient le hub IoT.

resourceName
path True

string

Nom du hub IoT.

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Réponses

Nom Type Description
200 OK

JobResponse

Il s’agit d’une opération synchrone. La réponse contient une description sérialisée JSON du travail dans le hub IoT.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_GetJob

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ErrorDetails

Détails de l’erreur.

JobResponse

Propriétés de l’objet Job Response.

JobStatus

État du travail.

JobType

Type du travail.

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

JobResponse

Propriétés de l’objet Job Response.

Nom Type Description
endTimeUtc

string

Heure à laquelle le travail a cessé de traiter.

failureReason

string

Si status == a échoué, cette chaîne contient la raison de l’échec.

jobId

string

Identificateur du travail.

parentJobId

string

Identificateur de travail du travail parent, le cas échéant.

startTimeUtc

string

Heure de début du travail.

status

JobStatus

État du travail.

statusMessage

string

Message status pour le travail.

type

JobType

Type du travail.

JobStatus

État du travail.

Nom Type Description
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Type du travail.

Nom Type Description
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string