az iot dps linked-hub

Note

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

管理 Azure IoT 中樞 Device Provisioning Service 實例中的連結物聯網樞紐。

命令

名稱 Description 類型 狀態
az iot dps linked-hub create

在 Azure IoT 中樞 裝置配置服務實例中建立一個連結的物聯網中樞。

Core GA
az iot dps linked-hub create (azure-iot 擴充功能)

在 Azure IoT 中樞 裝置配置服務實例中建立一個連結的物聯網中樞。

Extension GA
az iot dps linked-hub delete

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

Core GA
az iot dps linked-hub delete (azure-iot 擴充功能)

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

Extension GA
az iot dps linked-hub list

列出 Azure IoT 中樞 裝置配置服務實例中所有連結的物聯網樞紐。

Core GA
az iot dps linked-hub list (azure-iot 擴充功能)

列出 Azure IoT 中樞 裝置配置服務實例中所有連結的物聯網樞紐。

Extension GA
az iot dps linked-hub show

顯示 Azure IoT 中樞 Device Provisioning Service 實例中連結物聯網中樞的詳細資料。

Core GA
az iot dps linked-hub show (azure-iot 擴充功能)

顯示 Azure IoT 中樞 Device Provisioning Service 實例中連結物聯網中樞的詳細資料。

Extension GA
az iot dps linked-hub update

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

Core GA
az iot dps linked-hub update (azure-iot 擴充功能)

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

Extension GA

az iot dps linked-hub create

在 Azure IoT 中樞 裝置配置服務實例中建立一個連結的物聯網中樞。

az iot dps linked-hub create --dps-name
                             [--acquire-policy-token]
                             [--allocation-weight]
                             [--apply-allocation-policy {false, true}]
                             [--change-reference]
                             [--connection-string]
                             [--hn --hub-name]
                             [--hrg --hub-resource-group]
                             [--no-wait]
                             [--resource-group]

範例

在 Azure IoT 中樞 Device Provisioning Service 實例中建立連結的 IoT hub

az iot dps linked-hub create --dps-name MyDps --resource-group MyResourceGroup --location westus --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

在 Azure IoT 中樞 裝置配置服務中建立一個連結的物聯網中樞,該服務會套用分配權重,權重為 10

az iot dps linked-hub create --dps-name MyDps --resource-group MyResourceGroup --location westus --allocation-weight 10 --apply-allocation-policy True --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allocation-weight

IoT 中樞的配置權數。

--apply-allocation-policy

布爾值,指出是否要將配置原則套用至IoT中樞。

屬性
接受的值: false, true
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--connection-string

IoT 中樞的連接字串。 如果未使用 --hub-name 提供中樞名稱,則為必要專案。

屬性
參數群組: IoT Hub Identifier Arguments
--hn --hub-name

IoT 中樞 名稱。

屬性
參數群組: IoT Hub Identifier Arguments
--hrg --hub-resource-group

IoT 中樞 資源群組名稱。

屬性
參數群組: IoT Hub Identifier Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub create (azure-iot 擴充功能)

在 Azure IoT 中樞 裝置配置服務實例中建立一個連結的物聯網中樞。

az iot dps linked-hub create --dps-name
                             [--acquire-policy-token]
                             [--allocation-weight]
                             [--apply-allocation-policy {false, true}]
                             [--auth-type --authentication-type {KeyBased, SystemAssigned, UserAssigned}]
                             [--change-reference]
                             [--connection-string --cs]
                             [--hn --hub-name]
                             [--hostname-type --ht {auto, classic, device}]
                             [--hrg --hub-resource-group]
                             [--no-wait]
                             [--resource-group]
                             [--uai --user-assigned-identity]

範例

在 Azure IoT 中樞 Device Provisioning Service 實例中建立連結的 IoT hub

az iot dps linked-hub create --dps-name MyDps --resource-group MyResourceGroup --location westus --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

在 Azure IoT 中樞 裝置配置服務中建立一個連結的物聯網中樞,該服務會套用分配權重,權重為 10

az iot dps linked-hub create --dps-name MyDps --resource-group MyResourceGroup --location westus --allocation-weight 10 --apply-allocation-policy True --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allocation-weight

IoT 中樞的配置權數。

--apply-allocation-policy

布爾值,指出是否要將配置原則套用至IoT中樞。

屬性
接受的值: false, true
--auth-type --authentication-type
預覽

連結 IoT 中樞 的認證類型。 「KeyBased」使用 連接字串。 「SystemAssigned」使用 DPS 系統指派的管理身份。 「UserAssigned」使用使用者指派的管理身份。

屬性
接受的值: KeyBased, SystemAssigned, UserAssigned
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--connection-string --cs

IoT 中樞的連接字串。 如果未使用 --hub-name 提供中樞名稱,則為必要專案。

屬性
參數群組: IoT Hub Identifier Arguments
--hn --hub-name

IoT 中樞 名稱。

屬性
參數群組: IoT Hub Identifier Arguments
--hostname-type --ht
預覽

連結時使用的 IoT 中樞 主機名稱類型。 「自動」會使用TLS 1.3裝置主機名稱(如果有的話),經典版則是其他設定。 「裝置」使用 TLS 1.3 裝置主機名稱(若非 GWv2 則錯誤)。 「經典」使用經典主機名稱(hub.azure-devices.net)。 僅在提供 --hub-name 時適用。

屬性
預設值: auto
接受的值: auto, classic, device
--hrg --hub-resource-group

IoT 中樞 資源群組名稱。

屬性
參數群組: IoT Hub Identifier Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

--uai --user-assigned-identity
預覽

使用者指派的管理身份資源識別碼。 當認證類型為 UserAssigned 時,必須使用。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub delete

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

az iot dps linked-hub delete --dps-name
                             --linked-hub
                             [--acquire-policy-token]
                             [--change-reference]
                             [--no-wait]
                             [--resource-group]

範例

Delete linked IoT hub 'MyLinkedHub' in a Azure IoT 中樞 Device Provisioning Service instance

az iot dps linked-hub delete --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

--linked-hub

連結的 IoT 中樞 主機名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub delete (azure-iot 擴充功能)

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

az iot dps linked-hub delete --dps-name
                             --linked-hub
                             [--acquire-policy-token]
                             [--change-reference]
                             [--no-wait]
                             [--resource-group]

範例

Delete linked IoT hub 'MyLinkedHub' in a Azure IoT 中樞 Device Provisioning Service instance

az iot dps linked-hub delete --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

--linked-hub

連結的 IoT 中樞 主機名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub list

列出 Azure IoT 中樞 裝置配置服務實例中所有連結的物聯網樞紐。

az iot dps linked-hub list --dps-name
                           [--resource-group]

範例

列出 MyDps 中的所有連結 IoT 中樞

az iot dps linked-hub list --dps-name MyDps --resource-group MyResourceGroup

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub list (azure-iot 擴充功能)

列出 Azure IoT 中樞 裝置配置服務實例中所有連結的物聯網樞紐。

az iot dps linked-hub list --dps-name
                           [--resource-group]

範例

列出 MyDps 中的所有連結 IoT 中樞

az iot dps linked-hub list --dps-name MyDps --resource-group MyResourceGroup

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub show

顯示 Azure IoT 中樞 Device Provisioning Service 實例中連結物聯網中樞的詳細資料。

az iot dps linked-hub show --dps-name
                           --linked-hub
                           [--resource-group]

範例

顯示連結物聯網樞紐「MyLinkedHub」的詳細資料,位於 Azure IoT 中樞 裝置配置服務中

az iot dps linked-hub show --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

--linked-hub

連結的 IoT 中樞 主機名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub show (azure-iot 擴充功能)

顯示 Azure IoT 中樞 Device Provisioning Service 實例中連結物聯網中樞的詳細資料。

az iot dps linked-hub show --dps-name
                           --linked-hub
                           [--resource-group]

範例

顯示連結物聯網樞紐「MyLinkedHub」的詳細資料,位於 Azure IoT 中樞 裝置配置服務中

az iot dps linked-hub show --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

--linked-hub

連結的 IoT 中樞 主機名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub update

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

az iot dps linked-hub update --dps-name
                             --linked-hub
                             [--acquire-policy-token]
                             [--allocation-weight]
                             [--apply-allocation-policy {false, true}]
                             [--change-reference]
                             [--no-wait]
                             [--resource-group]

範例

更新Azure IoT 中樞裝置配置服務中連結的物聯網中樞「MyLinkedHub.azure-devices.net」

az iot dps linked-hub update --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub.azure-devices.net --allocation-weight 10 --apply-allocation-policy True

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

--linked-hub

連結的 IoT 中樞 主機名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allocation-weight

IoT 中樞的配置權數。

--apply-allocation-policy

布爾值,指出是否要將配置原則套用至IoT中樞。

屬性
接受的值: false, true
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az iot dps linked-hub update (azure-iot 擴充功能)

更新 Azure IoT 中樞 Device Provisioning Service 實例中連結的 IoT hub。

az iot dps linked-hub update --dps-name
                             [--acquire-policy-token]
                             [--allocation-weight]
                             [--apply-allocation-policy {false, true}]
                             [--auth-type --authentication-type {KeyBased, SystemAssigned, UserAssigned}]
                             [--change-reference]
                             [--connection-string --cs]
                             [--hn --hub-name]
                             [--linked-hub]
                             [--no-wait]
                             [--resource-group]
                             [--uai --user-assigned-identity]

範例

更新Azure IoT 中樞裝置配置服務中連結的物聯網中樞「MyLinkedHub.azure-devices.net」

az iot dps linked-hub update --dps-name MyDps --resource-group MyResourceGroup --linked-hub MyLinkedHub.azure-devices.net --allocation-weight 10 --apply-allocation-policy True

必要參數

--dps-name

IoT 中樞 裝置配置服務名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allocation-weight

IoT 中樞的配置權數。

--apply-allocation-policy

布爾值,指出是否要將配置原則套用至IoT中樞。

屬性
接受的值: false, true
--auth-type --authentication-type
預覽

把連結的中樞切換成不同的認證類型。 「KeyBased」使用一個 連接字串(透過 --connection-string 提供,否則從識別的集線器自動取用)。 「SystemAssigned」使用 DPS 系統指派的管理身份。 「UserAssigned」使用使用者指派的管理身份。

屬性
接受的值: KeyBased, SystemAssigned, UserAssigned
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--connection-string --cs
預覽

IoT 中樞 連接字串切換到 KeyBased 認證時使用的。 若省略,金鑰會自動從識別的集線器取回。

--hn --hub-name
預覽

IoT 中樞 簡稱。 優於 --linked-hub;無論經典主機名稱或裝置名稱為何,都能解析為正確的條目。

屬性
參數群組: Linked Hub Identifier Arguments
--linked-hub

連結的 IoT 中樞 完整主機名稱(例如 myhub.device.azure-devices.net)。 當 --hub-name 解析為多個條目時,請使用此方法來辨識。

屬性
參數群組: Linked Hub Identifier Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
預設值: False
--resource-group -g

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

--uai --user-assigned-identity
預覽

使用者指派的管理身份資源識別碼。 當 --authentication-type 是 UserAssigned 時,必須啟用。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False