az iot edge devices

參考

注意

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

管理 IoT Edge 裝置的命令。

命令

名稱	Description	類型	狀態
az iot edge devices create	在 IoT 中樞中建立及設定多個邊緣裝置。	副檔名	實驗

az iot edge devices create

實驗

此命令是實驗性且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

在 IoT 中樞中建立及設定多個邊緣裝置。

此作業接受 YAML 或 JSON 格式的內嵌裝置自變數或邊緣裝置組態檔。內嵌命令自變數（例如 '--device-auth'）的優先順序，並在提供組態檔屬性時覆寫。您可以在這裡找到範例組態檔： https://aka.ms/aziotcli-edge-devices-config 檢閱範例和參數描述，以取得如何充分利用這項作業的詳細數據。

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

範例

使用對稱金鑰驗證建立數個邊緣裝置（預設值）

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

使用內嵌自變數，透過各種邊緣屬性組態，使用自我簽署憑證驗證來建立邊緣裝置的一般清單。

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

刪除中樞上所有現有的裝置身分識別，並根據組態檔建立新裝置（進度列和視覺效果輸出）。

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

使用內嵌自變數，建立具有自定義模組部署的巢狀邊緣裝置群組 -- 包含每個具有1個子裝置的2個父裝置。也指定裝置憑證套件組合的輸出路徑。

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

使用 x509 驗證建立具有現有根 CA 的簡單巢狀邊緣裝置元件，並指定自定義裝置套件組合輸出路徑。

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--cfg --config --config-file

裝置組態檔的路徑。範例組態檔： https://aka.ms/aziotcli-edge-devices-config。

--clean -c

先刪除目標中樞中的所有裝置，再建立新的裝置。

接受的值: false, true

預設值: False

--dct --device-config-template

要作為邊緣裝置設定基礎的IoT Edge config.toml檔案路徑。

--dea --default-agent --default-edge-agent

如果未個別指定，則為所建立Edge裝置的預設邊緣代理程式。

--device -d

與要建立之邊緣裝置屬性對應的空格分隔索引鍵=值組。支援下列索引鍵值： id （device_id）、 deployment （內嵌 json 或檔案路徑）、、 hostnameparent （device_id）、 edge_agent （影像 URL）和container_auth（內嵌 json 或檔案路徑）。 --device 可以使用 1 或多次。檢閱完整參數使用方式的說明範例 - 這些參數也會參考範例組態檔中的對應值： https://aka.ms/aziotcli-edge-devices-config。

--device-auth --device-auth-type

裝置到中樞授權機制。

接受的值: shared_private_key, x509_thumbprint

--hub-name -n

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

--login -l

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

--out --output-path

輸出裝置組態配套的目錄路徑。如果未指定此值，將不會建立任何檔案輸出。

--rc --root-cert

用來簽署巢狀邊緣裝置憑證的根公鑰憑證路徑。

--resource-group -g

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

--rk --root-key

用來簽署巢狀邊緣裝置憑證的根私鑰路徑。

--root-pass --rp

根金鑰密碼。

--vis --visualize -v

顯示裝置的視覺效果和各種工作的進度（裝置建立、設定父系、更新設定等）。

接受的值: false, true

預設值: False

--yes -y

使用 --clean 參數刪除現有的中樞裝置時，請勿提示確認。

接受的值: false, true

預設值: False

全域參數

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

命令

az iot edge devices create

範例

選擇性參數

其他資源