Iot Hub Resource - Get Job

  • Referenz
Service:
IoT Hub
API Version:
2018-04-01

Rufen Sie die Details eines Auftrags aus einem IoT Hub ab. Weitere Informationen finden Sie unter 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=2018-04-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
jobId
 path True

string

Der Auftragsbezeichner.
resourceGroupName
 path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.
resourceName
 path True

string

Der Name des IoT-Hubs.
subscriptionId
 path True

string

Die Abonnement-ID.
api-version
 query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

JobResponse

Dies ist ein synchroner Vorgang. Die Antwort enthält eine JSON-serialisierte Beschreibung des Auftrags im IoT Hub.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_GetJob

Sample Request

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

Sample Response

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

Definitionen

Name Beschreibung
ErrorDetails

Fehlerdetails.
JobResponse

Die Eigenschaften des Auftragsantwortobjekts.
JobStatus

Der Status des Auftrags.
JobType

Der Typ des Auftrags.

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.
details

string

Die Fehlerdetails.
httpStatusCode

string

Der HTTP-Statuscode.
message

string

Die Fehlermeldung.

JobResponse

Die Eigenschaften des Auftragsantwortobjekts.

Name Typ Beschreibung
endTimeUtc

string

Die Zeit, zu der die Verarbeitung des Auftrags beendet wurde.
failureReason

string

Wenn status == fehlgeschlagen ist, enthält diese Zeichenfolge den Grund für den Fehler.
jobId

string

Der Auftragsbezeichner.
parentJobId

string

Der Auftragsbezeichner des übergeordneten Auftrags, falls vorhanden.
startTimeUtc

string

Die Startzeit des Auftrags.
status

JobStatus

Der Status des Auftrags.
statusMessage

string

Die status Meldung für den Auftrag.
type

JobType

Der Typ des Auftrags.

JobStatus

Der Status des Auftrags.

Name Typ Beschreibung
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

Der Typ des Auftrags.

Name Typ Beschreibung
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string