az iot central scheduled-job

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot central scheduled-job 命令時自動安裝。 深入了解擴充功能。

管理和設定 IoT Central 排程工作。

命令

名稱	Description	類型	狀態
az iot central scheduled-job create	依識別碼建立排程工作。	擴充	GA
az iot central scheduled-job delete	依識別碼刪除現有的排程工作。	擴充	GA
az iot central scheduled-job list	取得應用程式中排程的作業定義清單。	擴充	GA
az iot central scheduled-job list-runs	取得排程作業定義的作業實例清單。	擴充	GA
az iot central scheduled-job show	依識別碼取得排程工作的詳細資料。	擴充	GA
az iot central scheduled-job update	依識別碼更新排程的工作。	擴充	GA

az iot central scheduled-job create

依識別碼建立排程工作。

--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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--content -k

作業資料定義。 提供 JSON 檔案或原始字串化 JSON 的路徑。 要求主體必須包含 JobData 的陣列。

--group-id -g

要在其中執行作業之裝置群組的識別碼。

--id --job-id

排程工作的唯一識別碼。

--schedule

要執行作業的排程。 提供 JSON 檔案或原始字串化 JSON 的路徑。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central scheduled-job delete

依識別碼刪除現有的排程工作。

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

範例

依識別碼刪除現有的排程工作

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--id --job-id

排程工作的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 --job-id

排程工作的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central scheduled-job show

依識別碼取得排程工作的詳細資料。

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

範例

依識別碼取得排程工作的詳細資料

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--id --job-id

排程工作的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

如果您想要提交要求而不向 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central scheduled-job update

依識別碼更新排程的工作。

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

排程工作的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

要在其中執行作業之裝置群組的識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。