Iot Hub Resource - List Jobs
Rufen Sie eine Liste aller Aufträge in 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?api-version=2023-06-30
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die den IoT Hub enthält. |
resource
|
path | True |
string |
Der Name des IoT-Hubs. |
subscription
|
path | True |
string |
Die Abonnement-ID. |
api-version
|
query | True |
string |
Die Version der API. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Dies ist ein synchroner Vorgang. Die Antwort enthält ein JSON-serialisiertes Array aller Aufträge im IoT Hub. |
|
Other Status Codes |
DefaultErrorResponse |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
IotHubResource_ListJobs
Beispielanforderung
Beispiel für eine Antwort
{
"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"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerdetails. |
Job |
Die Eigenschaften des Auftragsantwortobjekts. |
Job |
Das JSON-serialisierte Array von JobResponse-Objekten mit einem nächsten Link. |
Job |
Der Status des Auftrags. |
Job |
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 |
Der Status des Auftrags. |
|
statusMessage |
string |
Die status Meldung für den Auftrag. |
type |
Der Typ des Auftrags. |
JobResponseListResult
Das JSON-serialisierte Array von JobResponse-Objekten mit einem nächsten Link.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der nächste Link. |
value |
Das Array von JobResponse-Objekten. |
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 |