次の方法で共有


Iot Hub Resource - Get Job

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/{jobId}?api-version=2023-06-30

URI パラメーター

名前 / 必須 説明
jobId
path True

string

ジョブ識別子です。

resourceGroupName
path True

string

IoT ハブを含むリソース グループの名前。

resourceName
path True

string

IoT ハブの名前。

subscriptionId
path True

string

サブスクリプションの識別子です。

api-version
query True

string

API のバージョン。

応答

名前 説明
200 OK

JobResponse

これは同期操作です。 応答には、IoT ハブ内のジョブの JSON でシリアル化された説明が含まれています。

Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

IotHubResource_GetJob

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
ErrorDetails

エラーの詳細。

JobResponse

ジョブ応答オブジェクトのプロパティ。

JobStatus

ジョブの状態。

JobType

ジョブの種類。

ErrorDetails

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。

JobResponse

ジョブ応答オブジェクトのプロパティ。

名前 説明
endTimeUtc

string

ジョブが処理を停止した時刻。

failureReason

string

status == failed の場合、エラーの理由を含むこの文字列。

jobId

string

ジョブ識別子です。

parentJobId

string

親ジョブのジョブ識別子 (存在する場合)。

startTimeUtc

string

ジョブの開始時刻。

status

JobStatus

ジョブの状態。

statusMessage

string

ジョブのステータス メッセージ。

type

JobType

ジョブの種類。

JobStatus

ジョブの状態。

名前 説明
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

ジョブの種類。

名前 説明
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string