az iot hub job
注意
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分(2.46.0 版或更高版本)。 擴充功能會在您第一次執行 az iot hub job 命令時自動安裝。 深入了解擴充功能。
管理 IoT 中樞 作業 (v2)。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az iot hub job cancel |
取消 IoT 中樞作業。 |
副檔名 | GA |
az iot hub job create |
建立並排程執行 IoT 中樞 作業。 |
副檔名 | GA |
az iot hub job list |
列出 IoT 中樞的歷史作業。 |
副檔名 | GA |
az iot hub job show |
顯示現有 IoT 中樞 作業的詳細數據。 |
副檔名 | GA |
az iot hub job cancel
取消 IoT 中樞作業。
az iot hub job cancel --job-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
範例
取消 IoT 中樞作業。
az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}
必要參數
IoT 中樞 作業標識碼。
選擇性參數
指出作業是否應該自動衍生原則密鑰,或使用目前的 Azure AD 工作階段。 如果驗證類型是登入,而且會提供資源主機名,除非需要,否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>
。
IoT 中樞 名稱或主機名。 如果未提供 --login,則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱,則 連接字串 優先。 如果未提供 --hub-name,則為必要專案。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub job create
建立並排程執行 IoT 中樞 作業。
排程對應項更新作業時,對應項修補程式是必要自變數。 排程裝置方法作業時,方法名稱和承載是必要自變數。 請注意:使用過去的自定義開始時間可能會導致作業失敗。
az iot hub job create --job-id
--job-type {scheduleDeviceMethod, scheduleUpdateTwin}
[--auth-type {key, login}]
[--duration]
[--hub-name]
[--interval]
[--login]
[--mct]
[--method-name]
[--method-payload]
[--method-response-timeout]
[--patch]
[--query-condition]
[--resource-group]
[--start]
[--ttl]
[--wait {false, true}]
範例
建立並排程作業以更新所有裝置的對應項標記。
az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'
針對「已完成」、「失敗」或「已取消」的結果排程作業和封鎖。 指定以秒為單位的輪詢間隔。
az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30
建立作業,以在裝置子集上更新所需的對應項屬性,並排定在未來任意時間執行。
az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"
針對符合查詢條件的一組裝置,建立及排程作業以叫用裝置方法。
az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"
建立並排程作業以叫用所有裝置的裝置方法。
az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'
必要參數
IoT 中樞 作業標識碼。
排程工作的類型。
選擇性參數
指出作業是否應該自動衍生原則密鑰,或使用目前的 Azure AD 工作階段。 如果驗證類型是登入,而且會提供資源主機名,除非需要,否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>
。
如果傳入 --wait 旗標,則會檢查作業狀態的秒數總計。
IoT 中樞 名稱或主機名。 如果未提供 --login,則為必要項。
如果傳入 --wait 旗標,則會以秒為單位檢查作業狀態的間隔。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果實體 連接字串 和名稱都提供,則 連接字串 優先。 如果未提供 --hub-name,則為必要專案。
在裝置連線上等候的秒數上限。
叫用的目標方法。
要傳遞至 方法的 Json 承載。 必須是檔案路徑或原始 json。
等候裝置方法結果的秒數上限。
所需的對應項修補程式。 提供檔案路徑或原始 JSON。
要讓裝置執行作業的裝置查詢條件。 如果作業類型為 scheduleDeviceMethod 或 scheduleUpdateTwin,則為必要專案。 注意:服務會在輸入前面加上 “SELECT * FROM devices WHERE”。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
ISO 8601 日期時間格式的排程作業開始。 如果未提供任何開始時間,作業會排入佇列以執行 asap。 使用過去的自定義開始時間可能會導致作業失敗。
在作業終止之前,以秒為單位的運行時間上限。
封鎖,直到建立的作業處於已完成、失敗或取消狀態為止。 會定期輪詢 --poll-interval 所指定的間隔。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub job list
列出 IoT 中樞的歷史作業。
az iot hub job list [--auth-type {key, login}]
[--hub-name]
[--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
[--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
[--login]
[--resource-group]
[--top]
範例
列出保留期間內的所有封存作業(最多 30 天)。
az iot hub job list --hub-name {iothub_name}
列出所有封存的作業投影特定屬性
az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"
僅列出更新對應項類型作業
az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod
列出狀態為「已排程」的裝置方法作業
az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled
列出狀態為「已完成」的裝置導出作業
az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed
選擇性參數
指出作業是否應該自動衍生原則密鑰,或使用目前的 Azure AD 工作階段。 如果驗證類型是登入,而且會提供資源主機名,除非需要,否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>
。
IoT 中樞 名稱或主機名。 如果未提供 --login,則為必要項。
排程工作的狀態。
排程工作的類型。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱,則 連接字串 優先使用。 如果未提供 --hub-name,則為必要專案。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
要傳回的項目數目上限。 針對無限制使用 -1。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub job show
顯示現有 IoT 中樞 作業的詳細數據。
az iot hub job show --job-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
範例
顯示已建立作業的詳細數據。
az iot hub job show --hub-name {iothub_name} --job-id {job_id}
必要參數
IoT 中樞 作業標識碼。
選擇性參數
指出作業是否應該自動衍生原則密鑰,或使用目前的 Azure AD 工作階段。 如果驗證類型是登入,而且會提供資源主機名,除非需要,否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>
。
IoT 中樞 名稱或主機名。 如果未提供 --login,則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果同時提供實體 連接字串 和名稱,則 連接字串 優先。 如果未提供 --hub-name,則為必要專案。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。