az iot hub connection-string

注意

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

管理IoT 中樞 連接字串。

命令

名稱 Description 類型 狀態
az iot hub connection-string show

使用指定的原則名稱和索引鍵,顯示指定IoT 中樞的連接字串。

擴充 GA

az iot hub connection-string show

使用指定的原則名稱和索引鍵,顯示指定IoT 中樞的連接字串。

az iot hub connection-string show [--all]
                                  [--default-eventhub {false, true}]
                                  [--hub-name]
                                  [--key-type {primary, secondary}]
                                  [--pn]
                                  [--resource-group]

範例

使用預設原則和主鍵,顯示訂用帳戶中所有使用中狀態IoT 中樞連接字串。

az iot hub connection-string show

使用預設原則和主鍵,顯示資源群組中所有使用中狀態IoT 中樞連接字串。

az iot hub connection-string show --resource-group MyResourceGroup

使用主鍵顯示指定IoT 中樞的所有連接字串。

az iot hub connection-string show -n MyIotHub --all

使用預設原則和主鍵顯示指定IoT 中樞的連接字串。

az iot hub connection-string show -n MyIotHub

使用原則 'service' 和次要金鑰顯示指定IoT 中樞連接字串。

az iot hub connection-string show -n MyIotHub --policy-name service --key-type secondary

顯示指定IoT 中樞預設 eventhub 的 eventhub 相容連接字串。

az iot hub connection-string show -n MyIotHub --default-eventhub

選擇性參數

--all --show-all

顯示個別IoT 中樞的所有共用存取原則。

預設值: False
--default-eventhub --eh

指出傳回連接字串的旗標是針對預設的 EventHub 端點。 預設:false。

接受的值: false, true
預設值: False
--hub-name -n

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

--key-type --kt

用於驗證的共用存取原則金鑰類型。

接受的值: primary, secondary
預設值: primary
--pn --policy-name

具有目標IoT 中樞實體作業許可權的共用存取原則。

預設值: iothubowner
--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 來取得完整偵錯記錄。