你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az iot central scheduled-job

参考

注意

此参考是 Azure CLI（版本 2.46.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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

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

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

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

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

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

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

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

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 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

全局参数

--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

命令

az iot central scheduled-job create

示例

必需参数

可选参数

az iot central scheduled-job delete

示例

必需参数

可选参数

az iot central scheduled-job list

示例

必需参数

可选参数

az iot central scheduled-job list-runs

示例

必需参数

可选参数

az iot central scheduled-job show

示例

必需参数

可选参数

az iot central scheduled-job update

示例

必需参数

可选参数

其他资源