az iot edge

注意

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

在 Edge 上管理 IoT 解決方案。

命令

名稱	Description	類型	狀態
az iot edge deployment	大規模管理 IoT Edge 部署。	副檔名	GA
az iot edge deployment create	在目標 IoT 中樞 中建立IoT Edge部署。	副檔名	GA
az iot edge deployment delete	刪除 IoT Edge 部署。	副檔名	GA
az iot edge deployment list	列出 IoT 中樞 中的IoT Edge部署。	副檔名	GA
az iot edge deployment show	取得IoT Edge部署的詳細數據。	副檔名	GA
az iot edge deployment show-metric	評估IoT Edge部署中定義的目標系統計量。	副檔名	GA
az iot edge deployment update	更新IoT Edge部署的指定屬性。	副檔名	GA
az iot edge devices	管理 IoT Edge 裝置的命令。	副檔名	GA
az iot edge devices create	在 IoT 中樞 中建立及設定多個邊緣裝置。	副檔名	實驗
az iot edge export-modules	在單一邊緣裝置上匯出邊緣模組的組態。	副檔名	GA
az iot edge set-modules	在單一裝置上設定邊緣模組。	副檔名	GA

az iot edge export-modules

在單一邊緣裝置上匯出邊緣模組的組態。

模組對應項組態輸出可以直接作為 「az iot edge set-modules」 的內容。

az iot edge export-modules --device-id
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

範例

匯出目標裝置上的模組對應項組態。

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

必要參數

--device-id -d

目標裝置標識碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--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 edge set-modules

在單一裝置上設定邊緣模組。

模組內容為 json，格式為 {“modulesContent”：{...}} 或 {“content”：{“modulesContent”：{...}}}。

根據預設，系統模組的屬性$edgeAgent和$edgeHub會根據隨 IoT 擴充功能安裝的架構進行驗證。 這可以使用 --no-validation 參數來停用。

注意：執行時，命令會輸出套用至裝置的模組集合。

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

範例

在開發期間測試邊緣模組，方法是在目標裝置上設定模組。

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

必要參數

--content -k

IoT Edge 部署內容。 提供檔案路徑或原始 JSON。

--device-id -d

目標裝置標識碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--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 來取得完整偵錯記錄。