Jobs - Create Scheduled Job

  • リファレンス
サービス:
IoT Hub
API バージョン:
2021-04-12

スケジュールされた時刻にIoT Hubのツイン更新またはダイレクト メソッドをスケジュールする新しいジョブを作成します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

PUT https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12

URI パラメーター

名前 / 必須 型 説明
id
 path True

string

ジョブの一意識別子。
api-version
 query True

string

Api のバージョン。

要求本文

名前 型 説明
cloudToDeviceMethod

CloudToDeviceMethod

メソッドの型とパラメーター。 これは、ジョブの種類が cloudToDeviceMethod の場合に必要です。
jobId

string

ジョブの一意識別子。
maxExecutionTimeInSeconds

integer

秒単位の最大実行時間。
queryCondition

string

デバイスがジョブを実行するための条件。 これは、ジョブの種類が updateTwin または cloudToDeviceMethod の場合に必要です。
startTime

string

ISO 8601 標準のジョブの開始日時。
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

ジョブの種類。
updateTwin

Twin

デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。

応答

名前 型 説明
200 OK

JobResponse

OK です。

定義

名前 説明
CloudToDeviceMethod

デバイスでダイレクト メソッドを実行するパラメーター。
DeviceCapabilities

デバイスで有効になっている機能の状態。
DeviceJobStatistics

実行状態に関するジョブ統計。
JobRequest
JobResponse
Twin

デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。
TwinProperties

ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。
X509Thumbprint

CloudToDeviceMethod

デバイスでダイレクト メソッドを実行するパラメーター。

名前 型 説明
connectTimeoutInSeconds

integer

methodName

string

実行するメソッドの名前。
payload

object

JSON 形式のダイレクト メソッド ペイロード。最大 128 kb のサイズ。
responseTimeoutInSeconds

integer

DeviceCapabilities

デバイスで有効になっている機能の状態。

名前 型 説明
iotEdge

boolean

デバイスがエッジ デバイスかどうかを決定する プロパティ。

DeviceJobStatistics

実行状態に関するジョブ統計。

名前 型 説明
deviceCount

integer

ジョブの対象となるデバイスの数。
failedCount

integer

失敗したジョブの数。
pendingCount

integer

保留中 (スケジュールされた) ジョブの数。
runningCount

integer

実行中のジョブの数。
succeededCount

integer

成功したジョブの数。

JobRequest

名前 型 説明
cloudToDeviceMethod

CloudToDeviceMethod

メソッドの型とパラメーター。 これは、ジョブの種類が cloudToDeviceMethod の場合に必要です。
jobId

string

ジョブの一意識別子。
maxExecutionTimeInSeconds

integer

秒単位の最大実行時間。
queryCondition

string

デバイスがジョブを実行するための条件。 これは、ジョブの種類が updateTwin または cloudToDeviceMethod の場合に必要です。
startTime

string

ISO 8601 標準のジョブの開始日時。
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

ジョブの種類。
updateTwin

Twin

デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。

JobResponse

名前 型 説明
cloudToDeviceMethod

CloudToDeviceMethod

メソッドの型とパラメーター。 これは、ジョブの種類が cloudToDeviceMethod の場合に必要です。
createdTime

string

システムが生成されました。 作成時に無視されます。 ジョブの作成日時。
deviceJobStatistics

DeviceJobStatistics

ジョブの実行状態に関する詳細。
endTime

string

システムが生成されました。 作成時に無視されます。 ジョブの終了日時 (UTC)。
failureReason

string

エラーが発生した場合のエラーの理由。
jobId

string

システムが生成されました。 作成時に無視されます。 ジョブの一意識別子。
maxExecutionTimeInSeconds

integer

秒単位の最大実行時間。
queryCondition

string

デバイス クエリ条件。
startTime

string

スケジュールされたジョブの開始日時 (UTC)。
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

システムが生成されました。 作成時に無視されます。 ジョブの状態。
statusMessage

string

ジョブのステータス メッセージ。
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

ジョブの種類。
updateTwin

Twin

デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。

Twin

デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。

名前 型 説明
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

デバイスで使用される認証の種類。
capabilities

DeviceCapabilities

デバイスで有効になっている機能の状態。
cloudToDeviceMessageCount

integer

送信されたクラウドからデバイスへのメッセージの数。
connectionState enum:
  • Connected
  • Disconnected

デバイスの接続状態。
deviceEtag

string

RFC7232に従って、デバイスの ETag を表す文字列。
deviceId

string

IoT Hubの ID レジストリ内のデバイスの一意識別子。 ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字)、次の特殊文字 {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')'、'、'='、'@'、';'、'$'、''} です。
deviceScope

string

デバイスのスコープ。
etag

string

RFC7232に従って、デバイス ツインの ETag を表す文字列。
lastActivityTime

string

デバイスが最後に接続されたか、メッセージを受信または送信した日時。 日付と時刻は、UTC ISO8601 datetime 形式で区切られ、たとえば、2015-01-28T16:24:48.789Z になります。 デバイスが HTTP/1 プロトコルを使用してメッセージング操作を実行する場合、この値は更新されません。
moduleId

string

IoT Hubの ID レジストリ内のモジュールの一意識別子。 ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字)、次の特殊文字 {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')'、'、'='、'@'、';'、'$'、''} です。
parentScopes

string[]

該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。
properties

TwinProperties

ツインの必要なプロパティと報告されるプロパティ。
status enum:
  • disabled
  • enabled

デバイスの有効な状態。 無効にした場合、デバイスはサービスに接続できません。
statusReason

string

デバイスの現在の状態の理由 (存在する場合)。
statusUpdateTime

string

デバイスの状態が最後に更新された日時。
tags

object

ソリューション バックエンドによって読み書きされるキーと値のペアのコレクション。 デバイス アプリには表示されません。 これらのキーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 値は JSON オブジェクトで、最大 4 KB の長さです。
version

integer

タグと必要なプロパティを含むデバイス ツインのバージョン
x509Thumbprint

X509Thumbprint

デバイスの X509 拇印。

TwinProperties

ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。

名前 型 説明
desired

object

目的のプロパティ キーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 必要な値は JSON オブジェクトで、最大 4 KB の長さです。
reported

object

報告されたプロパティのキーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 報告されるプロパティ値は、最大 4 KB の長さの JSON オブジェクトです。

X509Thumbprint

名前 型 説明
primaryThumbprint

string

X509 クライアント証明書のプライマリ拇印。
secondaryThumbprint

string

X509 クライアント証明書のセカンダリ拇印。