az iot central job

注意

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

管理及設定IoT Central 應用程式的作業。

命令

名稱	Description	類型	狀態
az iot central job create	透過作業定義建立和執行作業。	副檔名	GA
az iot central job get-devices	取得作業裝置狀態。	副檔名	GA
az iot central job list	取得IoT Central 應用程式的作業清單。	副檔名	GA
az iot central job rerun	在所有失敗的裝置上重新執行作業。	副檔名	GA
az iot central job resume	繼續停止的工作。	副檔名	GA
az iot central job show	依標識元取得作業的詳細數據。	副檔名	GA
az iot central job stop	停止執行中的作業。	副檔名	GA

az iot central job create

透過作業定義建立和執行作業。

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version {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 job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath}

建立具有名稱和批次組態的作業。

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

建立沒有批次的名稱和取消閾值設定的作業。

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

必要參數

--app-id -n

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

--content -k

作業數據定義。 提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化 JSON：[]{} 的範例。 要求主體必須包含JobData的陣列。

--group-id -g

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

--job-id -j

作業的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

取得作業裝置狀態。

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--token]

範例

依作業標識碼取得個別裝置狀態的清單

az iot central job get-devices --app-id {appid} --job-id {jobId}

必要參數

--app-id -n

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

--job-id -j

作業的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

取得IoT Central 應用程式的作業清單。

az iot central job list --app-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

範例

列出應用程式中的作業

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

必要參數

--app-id -n

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

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

在所有失敗的裝置上重新執行作業。

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--api-version {2022-07-31}]
                         [--central-api-uri]
                         [--token]

範例

重新執行作業

az iot central job rerun --app-id {appid} --job-id {jobId} --rerun-id {rerunId}

必要參數

--app-id -n

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

--job-id -j

作業的唯一標識碼。

--rerun-id

重新執行的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

繼續停止的工作。

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--token]

範例

繼續作業

az iot central job resume --app-id {appid} --job-id {jobId}

必要參數

--app-id -n

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

--job-id -j

作業的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

依標識元取得作業的詳細數據。

az iot central job show --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

範例

取得作業的詳細數據

az iot central job show --app-id {appid} --job-id {jobId}

必要參數

--app-id -n

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

--job-id -j

作業的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

停止執行中的作業。

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

範例

停止作業

az iot central job stop --app-id {appid} --job-id {jobId}

必要參數

--app-id -n

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

--job-id -j

作業的唯一標識碼。

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

接受的值: 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 來取得完整偵錯記錄。