Dela via


Iot Hub Resource - List Jobs

Hämta en lista över alla jobb i en IoT-hubb. Mer information finns i: 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-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen som innehåller IoT-hubben.

resourceName
path True

string

Namnet på IoT-hubben.

subscriptionId
path True

string

Prenumerationsidentifieraren.

api-version
query True

string

Versionen av API:et.

Svar

Name Typ Description
200 OK

JobResponseListResult

Det här är en synkron åtgärd. Svaret innehåller en JSON-serialiserad matris med alla jobb i IoT-hubben.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

IotHubResource_ListJobs

Exempelbegäran

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

Exempelsvar

{
  "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"
    }
  ]
}

Definitioner

Name Description
ErrorDetails

Felinformation.

JobResponse

Egenskaperna för jobbsvarsobjektet.

JobResponseListResult

Den JSON-serialiserade matrisen med JobResponse-objekt med en nästa länk.

JobStatus

Jobbets status.

JobType

Typen av jobb.

ErrorDetails

Felinformation.

Name Typ Description
code

string

Felkoden.

details

string

Felinformationen.

httpStatusCode

string

HTTP-statuskoden.

message

string

Felmeddelandet.

JobResponse

Egenskaperna för jobbsvarsobjektet.

Name Typ Description
endTimeUtc

string (date-time-rfc1123)

Den tid då jobbet slutade bearbetas.

failureReason

string

Om status == misslyckades, innehåller den här strängen orsaken till felet.

jobId

string

Jobbidentifieraren.

parentJobId

string

Jobbidentifieraren för det överordnade jobbet, om det finns.

startTimeUtc

string (date-time-rfc1123)

Starttiden för jobbet.

status

JobStatus

Jobbets status.

statusMessage

string

Statusmeddelandet för jobbet.

type

JobType

Typen av jobb.

JobResponseListResult

Den JSON-serialiserade matrisen med JobResponse-objekt med en nästa länk.

Name Typ Description
nextLink

string

Nästa länk.

value

JobResponse[]

Matrisen med JobResponse-objekt.

JobStatus

Jobbets status.

Värde Description
cancelled
completed
enqueued
failed
running
unknown

JobType

Typen av jobb.

Värde Description
backup
export
factoryResetDevice
firmwareUpdate
import
readDeviceProperties
rebootDevice
unknown
updateDeviceConfiguration
writeDeviceProperties