az iot dps

參考

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。安裝每個擴充功能以受益於其擴充功能。深入了解擴充功能。

管理 Azure IoT 中樞裝置布建服務。

命令

名稱	Description	類型	狀態
az iot dps certificate	管理 Azure IoT 中樞裝置布建服務實例的憑證。	核心	GA
az iot dps certificate create	建立/上傳 certficate 至 Azure IoT 中樞裝置布建服務實例。	核心	GA
az iot dps certificate delete	刪除 Azure IoT 中樞裝置布建服務實例中的憑證。	核心	GA
az iot dps certificate generate-verification-code	為 Azure IoT 中樞裝置布建服務實例中的憑證產生驗證碼。	核心	GA
az iot dps certificate list	列出包含在 Azure IoT 中樞裝置布建服務實例內的所有憑證。	核心	GA
az iot dps certificate show	顯示 Azure IoT 中樞裝置布建服務實例中特定憑證的相關信息。	核心	GA
az iot dps certificate update	更新 Azure IoT 中樞裝置布建服務實例中的憑證。	核心	GA
az iot dps certificate verify	確認 Azure IoT 中樞裝置布建服務實例中的憑證。	核心	GA
az iot dps compute-device-key	產生衍生裝置 SAS 金鑰。	副檔名	已取代
az iot dps connection-string	管理 Azure IoT 中樞裝置佈建服務實例的連接字串。	副檔名	GA
az iot dps connection-string show	使用指定的原則名稱和索引鍵，顯示指定裝置布建服務的連接字串。	副檔名	GA
az iot dps create	建立 Azure IoT 中樞裝置佈建服務執行個體。	核心	GA
az iot dps delete	刪除 Azure IoT 中樞裝置佈建服務執行個體。	核心	GA
az iot dps enrollment	管理 Azure IoT 中樞裝置布建服務中的個別裝置註冊。	副檔名	GA
az iot dps enrollment-group	管理 Azure IoT 中樞裝置布建服務中的註冊群組。	副檔名	GA
az iot dps enrollment-group compute-device-key	為 Azure IoT 中樞裝置佈建服務中的註冊群組產生衍生裝置 SAS 金鑰。	副檔名	GA
az iot dps enrollment-group create	在 Azure IoT 中樞裝置布建服務中建立註冊群組。	副檔名	GA
az iot dps enrollment-group delete	刪除 Azure IoT 中樞裝置布建服務中的註冊群組。	副檔名	GA
az iot dps enrollment-group list	列出 Azure IoT 中樞裝置布建服務中的註冊群組。	副檔名	GA
az iot dps enrollment-group registration	在 Azure IoT 中樞裝置布建服務中管理註冊群組的服務端裝置註冊。	副檔名	GA
az iot dps enrollment-group registration delete	刪除 Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。	副檔名	GA
az iot dps enrollment-group registration list	列出 Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。	副檔名	GA
az iot dps enrollment-group registration show	取得 Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。	副檔名	GA
az iot dps enrollment-group show	在 Azure IoT 中樞裝置布建服務中取得註冊群組的詳細數據。	副檔名	GA
az iot dps enrollment-group update	更新 Azure IoT 中樞裝置布建服務中的註冊群組。	副檔名	GA
az iot dps enrollment create	在 Azure IoT 中樞裝置布建服務中建立個別裝置註冊。	副檔名	GA
az iot dps enrollment delete	刪除 Azure IoT 中樞裝置布建服務中的個別裝置註冊。	副檔名	GA
az iot dps enrollment list	列出 Azure IoT 中樞裝置布建服務中的個別裝置註冊。	副檔名	GA
az iot dps enrollment registration	在 Azure IoT 中樞裝置布建服務中管理個別註冊的服務端裝置註冊。	副檔名	GA
az iot dps enrollment registration delete	刪除 Azure IoT 中樞裝置布建服務中個別註冊的裝置註冊。	副檔名	GA
az iot dps enrollment registration show	取得 Azure IoT 中樞裝置布建服務中個別註冊的裝置註冊。	副檔名	GA
az iot dps enrollment show	取得 Azure IoT 中樞裝置布建服務中的個別裝置註冊詳細數據。	副檔名	GA
az iot dps enrollment update	更新 Azure IoT 中樞裝置布建服務中的個別裝置註冊。	副檔名	GA
az iot dps linked-hub	管理 Azure IoT 中樞裝置布建服務實例中的連結 IoT 中樞。	核心	GA
az iot dps linked-hub create	在 Azure IoT 中樞裝置佈建服務執行個體中建立連結的 IoT 中樞。	核心	GA
az iot dps linked-hub delete	在 Azure IoT 中樞裝置佈建服務執行個體中更新連結的 IoT 中樞。	核心	GA
az iot dps linked-hub list	在 Azure IoT 中樞裝置佈建服務執行個體中列出所有連結的 IoT 中樞。	核心	GA
az iot dps linked-hub show	在 Azure IoT 中樞裝置佈建服務執行個體中顯示已連結 IoT 中樞的詳細內容。	核心	GA
az iot dps linked-hub update	在 Azure IoT 中樞裝置佈建服務執行個體中更新連結的 IoT 中樞。	核心	GA
az iot dps list	Azure IoT 中樞裝置佈建服務執行個體的清單。	核心	GA
az iot dps policy	管理 Azure IoT 中樞裝置布建服務實例的共用存取原則。	核心	GA
az iot dps policy create	在 Azure IoT 中樞裝置佈建服務執行個體中建立新的共用存取原則。	核心	GA
az iot dps policy delete	在 Azure IoT 中樞裝置佈建服務執行個體中刪除共用存取原則。	核心	GA
az iot dps policy list	在 Azure IoT 中樞裝置佈建服務執行個體中列出所有共用存取原則。	核心	GA
az iot dps policy show	在 Azure IoT 中樞裝置布建服務實例中顯示共用存取原則的詳細數據。	核心	GA
az iot dps policy update	在 Azure IoT 中樞裝置佈建服務執行個體中更新共用存取原則。	核心	GA
az iot dps registration	在 Azure IoT 中樞裝置布建服務中管理註冊群組的裝置註冊。	副檔名	已取代
az iot dps registration delete	刪除 Azure IoT 中樞裝置布建服務中的裝置註冊。	副檔名	已取代
az iot dps registration list	列出 Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。	副檔名	已取代
az iot dps registration show	取得 Azure IoT 中樞裝置布建服務中註冊群組的裝置註冊。	副檔名	已取代
az iot dps show	取得 Azure IoT 中樞裝置佈建服務執行個體的詳細內容。	核心	GA
az iot dps update	更新 Azure IoT 中樞裝置佈建服務執行個體。	核心	GA

az iot dps compute-device-key

已被取代

此命令已被取代，並將在未來版本中移除。請改用 'iot dps enrollment-group compute-device-key'。

產生衍生裝置 SAS 金鑰。

產生 DPS 註冊群組的衍生裝置金鑰。

az iot dps compute-device-key --registration-id
                              [--auth-type {key, login}]
                              [--dps-name]
                              [--eid]
                              [--key]
                              [--login]
                              [--resource-group]

範例

使用指定的對稱金鑰來計算裝置金鑰。

az iot dps compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

使用指定的註冊群組計算裝置密鑰。

az iot dps compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

必要參數

--registration-id

裝置註冊的標識碼。

選擇性參數

--auth-type

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

接受的值: key, login

預設值: key

--dps-name -n

Azure IoT 中樞裝置布建服務的名稱或主機名。如果未提供 --login，則為必要項。

--eid --enrollment-id --gid --group-id

註冊群組標識碼。

--key --symmetric-key

註冊群組的對稱共用存取金鑰。這會略過裝置佈建服務登錄，並直接從提供的對稱密鑰產生 SAS 令牌，而不需進一步驗證。除了註冊標識碼之外，所有其他命令參數都會被忽略。

--login -l

此命令支援具有執行動作許可權的實體連接字串。使用來避免透過「az login」的工作階段登入。如果同時提供實體連接字串和名稱，則連接字串優先。如果未提供 --dps-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 dps create

編輯

建立 Azure IoT 中樞裝置佈建服務執行個體。

如需 Azure IoT 中樞裝置佈建服務的簡介，請參閱 https://docs.microsoft.com/azure/iot-dps/about-iot-dps。

az iot dps create --name
                  --resource-group
                  [--edr {false, true}]
                  [--location]
                  [--sku {S1}]
                  [--tags]
                  [--unit]

範例

在資源群組區域中，使用標準定價層 S1 建立 Azure IoT 中樞裝置布建服務。

az iot dps create --name MyDps --resource-group MyResourceGroup

在 'eastus' 區域中，使用標準定價層 S1 建立 Azure IoT 中樞裝置布建服務。

az iot dps create --name MyDps --resource-group MyResourceGroup --location eastus

使用強制執行數據落地建立 Azure IoT 中樞裝置布建服務。這會停用跨區域災害復原。

az iot dps create --name MyDps --resource-group MyResourceGroup --edr

必要參數

--name -n

IoT 中樞裝置布建服務名稱。

--resource-group -g

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

選擇性參數

--edr --enforce-data-residency

停用跨異地配對災害復原，以強制執行此 IoT 中樞裝置布建服務的數據落地。在資源上設定此屬性后，這個屬性是不可變的。僅適用於選取的區域。請至https://aka.ms/dpsdr，即可深入瞭解。

接受的值: false, true

--location -l

IoT 中樞裝置布建服務的位置。預設值為目標資源群組的位置。

--sku

IoT 中樞裝置布建服務的定價層。

接受的值: S1

預設值: S1

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit

裝置布建服務 IoT 中樞單位。

預設值: 1

全域參數

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

編輯

刪除 Azure IoT 中樞裝置佈建服務執行個體。

az iot dps delete [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

範例

刪除 Azure IoT 中樞裝置布建服務 'MyDps'

az iot dps delete --name MyDps --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

IoT 中樞裝置布建服務名稱。

--resource-group -g

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

--subscription

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

全域參數

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

編輯

Azure IoT 中樞裝置佈建服務執行個體的清單。

az iot dps list [--resource-group]

範例

列出訂用帳戶中的所有 Azure IoT 中樞裝置布建服務。

az iot dps list

列出資源群組『MyResourceGroup』中的所有 Azure IoT 中樞裝置布建服務

az iot dps list --resource-group MyResourceGroup

選擇性參數

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

編輯

取得 Azure IoT 中樞裝置佈建服務執行個體的詳細內容。

az iot dps show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

範例

顯示 Azure IoT 中樞裝置布建服務『MyDps』的詳細數據

az iot dps show --name MyDps --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

IoT 中樞裝置布建服務名稱。

--resource-group -g

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

--subscription

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

全域參數

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

編輯

更新 Azure IoT 中樞裝置佈建服務執行個體。

az iot dps update [--add]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]
                  [--tags]

範例

將配置原則更新為 Azure IoT 中樞裝置布建服務 'MyDps' 的「地理位置」

az iot dps update --name MyDps --resource-group MyResourceGroup --set properties.allocationPolicy="GeoLatency"

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

IoT 中樞裝置布建服務名稱。

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []

--resource-group -g

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

--set

指定要設定的屬性路徑和值，以更新物件。範例：--set property1.property2=<value>。

預設值: []

--subscription

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

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

全域參數

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

命令

az iot dps compute-device-key

範例

必要參數

選擇性參數

az iot dps create

範例

必要參數

選擇性參數

az iot dps delete

範例

選擇性參數

az iot dps list

範例

選擇性參數

az iot dps show

範例

選擇性參數

az iot dps update

範例

選擇性參數

其他資源