共用方式為


Iot Hub Resource - List Jobs

取得IoT中樞內所有作業的清單。 如需詳細資訊,請參閱: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 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

包含IoT中樞的資源組名。

resourceName
path True

string

IoT 中樞的名稱。

subscriptionId
path True

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

回應

名稱 類型 Description
200 OK

JobResponseListResult

這是同步作業。 回應包含IoT中樞中所有作業的 JSON 串行化陣列。

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

IotHubResource_ListJobs

範例要求

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

範例回覆

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

定義

名稱 Description
ErrorDetails

錯誤詳細數據。

JobResponse

Job Response 對象的屬性。

JobResponseListResult

具有下一個連結之 JobResponse 物件的 JSON 串行化陣列。

JobStatus

工作的狀態。

JobType

作業的類型。

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

JobResponse

Job Response 對象的屬性。

名稱 類型 Description
endTimeUtc

string

作業停止處理的時間。

failureReason

string

如果 status == 失敗,則此字串包含失敗的原因。

jobId

string

作業識別碼。

parentJobId

string

父作業的作業標識碼,如果有的話。

startTimeUtc

string

工作的開始時間。

status

JobStatus

工作的狀態。

statusMessage

string

作業的狀態消息。

type

JobType

作業的類型。

JobResponseListResult

具有下一個連結之 JobResponse 物件的 JSON 串行化陣列。

名稱 類型 Description
nextLink

string

下一個連結。

value

JobResponse[]

JobResponse 對象的陣列。

JobStatus

工作的狀態。

名稱 類型 Description
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

作業的類型。

名稱 類型 Description
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string