az iot central scheduled-job

Note

このリファレンスは、Azure CLI (バージョン 2.37.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot central scheduled-job コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

IoT Central スケジュール ジョブを管理および構成します。

コマンド

名前	説明	型	Status
az iot central scheduled-job create	スケジュールされたジョブを ID で作成します。	拡張	GA
az iot central scheduled-job delete	ID を指定してスケジュールされた既存のジョブを削除します。	拡張	GA
az iot central scheduled-job list	アプリケーションでスケジュールされたジョブ定義の一覧を取得します。	拡張	GA
az iot central scheduled-job list-runs	スケジュールされたジョブ定義のジョブ インスタンスの一覧を取得します。	拡張	GA
az iot central scheduled-job show	スケジュールされたジョブに関する詳細を ID で取得します。	拡張	GA
az iot central scheduled-job update	スケジュールされたジョブを ID で更新します。	拡張	GA

az iot central scheduled-job create

スケジュールされたジョブを ID で作成します。

--schedule と --content には、インライン json またはファイル パスを指定できます。

az iot central scheduled-job create --app-id
                                    --content
                                    --group-id
                                    --id
                                    --schedule
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--batch]
                                    [--batch-type {number, percentage}]
                                    [--cancellation-threshold]
                                    [--cancellation-threshold-batch]
                                    [--cancellation-threshold-type {number, percentage}]
                                    [--central-api-uri]
                                    [--desc]
                                    [--job-name]
                                    [--token]

例

名前を指定してスケジュール ジョブを作成する

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}

名前とバッチ構成を使用してスケジュールされたジョブを作成します。

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

バッチを使用しない名前とキャンセルしきい値の構成を使用して、スケジュールされたジョブを作成します。

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--content -k

ジョブ データ定義。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 要求本文には、JobData の配列が含まれている必要があります。

--group-id -g

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

--id --job-id

スケジュールされたジョブの一意の識別子。

--schedule

ジョブを実行するスケジュール。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--batch -b

バッチ処理を実行するデバイスの数または割合。

--batch-type --bt

バッチ処理を多数のデバイスで実行するか、合計に対する割合で行うかを指定します。

承認された値: number, percentage

既定値: number

--cancellation-threshold --cth

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

--cancellation-threshold-batch --ctb

キャンセルのしきい値をバッチごとに適用するか、ジョブ全体に適用するかを示します。

既定値: number

--cancellation-threshold-type --ctt

取り消ししきい値が多数のデバイスに適用されるか、合計の割合に適用されるかを指定します。

承認された値: number, percentage

既定値: number

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--desc --description

ジョブの詳細な説明。

--job-name

ジョブの表示名。

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central scheduled-job delete

ID を指定してスケジュールされた既存のジョブを削除します。

az iot central scheduled-job delete --app-id
                                    --id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

例

既存のスケジュールされたジョブを ID で削除する

az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--id --job-id

スケジュールされたジョブの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central scheduled-job list

アプリケーションでスケジュールされたジョブ定義の一覧を取得します。

az iot central scheduled-job list --app-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

例

アプリケーションでスケジュールされたジョブ定義の一覧を取得する

az iot central scheduled-job list --app-id {appid}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central scheduled-job list-runs

スケジュールされたジョブ定義のジョブ インスタンスの一覧を取得します。

az iot central scheduled-job list-runs --app-id
                                       --id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

例

スケジュールされたジョブ定義のジョブ インスタンスの一覧を取得する

az iot central scheduled-job list-runs --app-id {appid} --job-id {jobId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--id --job-id

スケジュールされたジョブの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central scheduled-job show

スケジュールされたジョブに関する詳細を ID で取得します。

az iot central scheduled-job show --app-id
                                  --id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

例

スケジュールされたジョブに関する詳細を ID で取得する

az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--id --job-id

スケジュールされたジョブの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central scheduled-job update

スケジュールされたジョブを ID で更新します。

az iot central scheduled-job update --app-id
                                    --id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--batch]
                                    [--batch-type {number, percentage}]
                                    [--cancellation-threshold]
                                    [--cancellation-threshold-batch]
                                    [--cancellation-threshold-type {number, percentage}]
                                    [--central-api-uri]
                                    [--content]
                                    [--desc]
                                    [--group-id]
                                    [--job-name]
                                    [--schedule]
                                    [--token]

例

スケジュール ジョブを名前で更新する

az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--id --job-id

スケジュールされたジョブの一意の識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

--batch -b

バッチ処理を実行するデバイスの数または割合。

--batch-type --bt

バッチ処理を多数のデバイスで実行するか、合計に対する割合で行うかを指定します。

承認された値: number, percentage

既定値: number

--cancellation-threshold --cth

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

--cancellation-threshold-batch --ctb

キャンセルのしきい値をバッチごとに適用するか、ジョブ全体に適用するかを示します。

--cancellation-threshold-type --ctt

取り消ししきい値が多数のデバイスに適用されるか、合計の割合に適用されるかを指定します。

承認された値: number, percentage

既定値: number

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--content -k

ジョブ データ定義。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 要求本文には、JobData の配列が含まれている必要があります。

--desc --description

ジョブの詳細な説明。

--group-id -g

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

--job-name

ジョブの表示名。

--schedule

ジョブを実行するスケジュール。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。