az iot central scheduled-job
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az iot central scheduled-job command. Learn more about extensions.
Manage and configure IoT Central schedule job.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot central scheduled-job create |
Create a scheduled job by ID. |
Extension | GA |
| az iot central scheduled-job delete |
Delete an existing scheduled job by ID. |
Extension | GA |
| az iot central scheduled-job list |
Get the list of scheduled job definitions in an application. |
Extension | GA |
| az iot central scheduled-job list-runs |
Get the list of job instances for a scheduled job definition. |
Extension | GA |
| az iot central scheduled-job show |
Get details about a scheduled job by ID. |
Extension | GA |
| az iot central scheduled-job update |
Update a scheduled job by ID. |
Extension | GA |
az iot central scheduled-job create
Create a scheduled job by ID.
--schedule and --content can be inline json or file path.
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]Examples
Create a schedule job with name
az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}Create a scheduled job with name and batch configuration.
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}Create a scheduled job with name and cancellation threshold configuration with no batch.
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}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
The job data definition. Provide path to JSON file or raw stringified JSON. The request body must contain array of JobData.
The ID of the device group on which to execute the job.
Unique identifier for the scheduled job.
The schedule at which to execute the job. Provide path to JSON file or raw stringified JSON.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The number or percentage of devices on which batching is done.
Specify if batching is done on a number of devices or a percentage of the total.
The number or percentage of devices on which the cancellation threshold is applied.
Whether the cancellation threshold applies per-batch or to the overall job.
Specify if cancellation threshold applies for a number of devices or a percentage of the total.
The IoT Central DNS suffix associated with your application.
Detailed description of the job.
Display name of the job.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central scheduled-job delete
Delete an existing scheduled job by ID.
az iot central scheduled-job delete --app-id
--id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Delete an existing scheduled job by ID
az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the scheduled job.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central scheduled-job list
Get the list of scheduled job definitions in an application.
az iot central scheduled-job list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Get the list of scheduled job definitions in an application
az iot central scheduled-job list --app-id {appid}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central scheduled-job list-runs
Get the list of job instances for a scheduled job definition.
az iot central scheduled-job list-runs --app-id
--id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Get the list of jobs instances for a scheduled job definition
az iot central scheduled-job list-runs --app-id {appid} --job-id {jobId}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the scheduled job.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central scheduled-job show
Get details about a scheduled job by ID.
az iot central scheduled-job show --app-id
--id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Get details about a scheduled job by ID
az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the scheduled job.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central scheduled-job update
Update a scheduled job by 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]Examples
Update a schedule job with name
az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the scheduled job.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.
The number or percentage of devices on which batching is done.
Specify if batching is done on a number of devices or a percentage of the total.
The number or percentage of devices on which the cancellation threshold is applied.
Whether the cancellation threshold applies per-batch or to the overall job.
Specify if cancellation threshold applies for a number of devices or a percentage of the total.
The IoT Central DNS suffix associated with your application.
The job data definition. Provide path to JSON file or raw stringified JSON. The request body must contain array of JobData.
Detailed description of the job.
The ID of the device group on which to execute the job.
Display name of the job.
The schedule at which to execute the job. Provide path to JSON file or raw stringified JSON.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ