次の方法で共有


Jobs - Get

ID でジョブを取得する
実行中または完了したジョブの詳細をジョブ ID で取得します。

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

URI パラメーター

名前 / 必須 説明
baseDomain
path True

string

すべての Azure IoT Central サービス要求のベース ドメイン。

jobId
path True

string

ジョブの一意の ID。

正規表現パターン: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

アプリケーション サブドメイン。

api-version
query True

string

呼び出される API のバージョン。

応答

名前 説明
200 OK

Job

Success

Other Status Codes

Error

IoT Central サービスから受信したエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

Get a job by ID

要求のサンプル

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

応答のサンプル

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

定義

名前 説明
CloudPropertyJobData

クラウド プロパティ ジョブ データ。

CommandJobData

コマンド ジョブ のデータ定義。

DeviceTemplateMigrationJobData

デバイス テンプレート移行ジョブのデータ定義。

Error

応答エラーの定義。

ErrorDetails

エラーの詳細情報。

Job

ジョブ定義。

JobBatch

ジョブ バッチ定義。

JobBatchType

バッチ処理が指定された数のデバイスで実行されるか、デバイス全体に対する割合で実行されるか。

JobCancellationThreshold

ジョブの取り消ししきい値の定義。

JobCancellationThresholdType

キャンセルのしきい値が、指定した数のデバイスに従っているか、デバイス全体に対する割合であるか。

JobProgress

スケジュールされたジョブの進行状況の概要。

PropertyJobData

プロパティ ジョブ のデータ定義。

CloudPropertyJobData

クラウド プロパティ ジョブ データ。

名前 説明
path

string

デバイス テンプレート内のターゲット機能へのパス。

target

string

ジョブのターゲット機能を定義するデバイス テンプレート。

type string:

cloudProperty

ジョブ データの種類。

value

AnyValue

ターゲット機能の更新に使用される値 (存在する場合)。

CommandJobData

コマンド ジョブ のデータ定義。

名前 説明
path

string

デバイス テンプレート内のターゲット機能へのパス。

target

string

ジョブのターゲット機能を定義するデバイス テンプレート。

type string:

command

ジョブ データの種類。

value

AnyValue

ターゲット機能の更新に使用される値 (存在する場合)。

DeviceTemplateMigrationJobData

デバイス テンプレート移行ジョブのデータ定義。

名前 説明
template

string

デバイスの移行先となるターゲット デバイス テンプレート。

type string:

deviceTemplateMigration

ジョブ データの種類。

Error

応答エラーの定義。

名前 説明
error

ErrorDetails

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

名前 説明
code

string

エラー コード。

message

string

エラー メッセージの詳細。

requestId

string

現在の要求の関連付け ID。

time

string

エラー要求が失敗した時刻。

Job

ジョブ定義。

名前 説明
batch

JobBatch

ジョブのバッチ処理構成。

cancellationThreshold

JobCancellationThreshold

ジョブのキャンセルしきい値。

data JobData[]:

ジョブによって更新される機能と、それらが更新される値。

description

string

ジョブの詳細な説明。

displayName

string

ジョブの表示名。

end

string

ジョブの終了時刻

group

string

ジョブを実行するデバイス グループの ID。

id

string

ジョブの一意の ID。

organizations

string[]

ジョブの組織の一覧。現在サポートされているorganizationは 1 つだけで、複数の組織が間もなくサポートされます。

progress

JobProgress

ジョブの進行状況の統計。

scheduledJobId

string

このジョブを作成したスケジュールされたジョブ定義の ID。

start

string

ジョブの開始時刻

status

string

ジョブが開始中か実行中かなどを示します。

JobBatch

ジョブ バッチ定義。

名前 説明
type

JobBatchType

バッチ処理が指定された数のデバイスで実行されるか、デバイス全体に対する割合で実行されるか。

value

number

バッチ処理が行われるデバイスの数または割合。

JobBatchType

バッチ処理が指定された数のデバイスで実行されるか、デバイス全体に対する割合で実行されるか。

名前 説明
number

string

デバイスの数に基づくジョブ のバッチ処理。

percentage

string

ジョブのバッチ処理に基づく、適用されたデバイスの総数に対する割合。

JobCancellationThreshold

ジョブの取り消ししきい値の定義。

名前 説明
batch

boolean

キャンセルしきい値がバッチごとまたはジョブ全体に適用されるかどうか。

type

JobCancellationThresholdType

キャンセルのしきい値が、指定した数のデバイスに従っているか、デバイス全体に対する割合であるか。

value

number

キャンセルしきい値が適用されるデバイスの数または割合。

JobCancellationThresholdType

キャンセルのしきい値が、指定した数のデバイスに従っているか、デバイス全体に対する割合であるか。

名前 説明
number

string

指定した数のデバイスに基づくジョブの取り消ししきい値。

percentage

string

デバイスの合計数に対する割合に基づくジョブのキャンセルしきい値。

JobProgress

スケジュールされたジョブの進行状況の概要。

名前 説明
completed

integer

ジョブが完了したエンティティの数。

failed

integer

ジョブが失敗したエンティティの数。

pending

integer

ジョブがまだ実行されていないエンティティの数。

total

integer

ジョブの対象となるエンティティの合計数。

PropertyJobData

プロパティ ジョブ のデータ定義。

名前 説明
path

string

デバイス テンプレート内のターゲット機能へのパス。

target

string

ジョブのターゲット機能を定義するデバイス テンプレート。

type string:

property

ジョブ データの種類。

value

AnyValue

ターゲット機能の更新に使用される値 (存在する場合)。