az iot hub connection-string
Note
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 (2.67.0 版或更新版本)。 擴充功能會在您第一次執行 az iot hub connection-string 命令時自動安裝。 深入了解擴充功能。
管理 IoT 中樞 連接字串。
命令
| 名稱 | Description | 類型 | 狀態 |
|---|---|---|---|
| az iot hub connection-string show |
使用指定的原則名稱和索引鍵,顯示指定 IoT 中樞 的 連接字串。 |
Extension | GA |
az iot hub connection-string show
使用指定的原則名稱和索引鍵,顯示指定 IoT 中樞 的 連接字串。
az iot hub connection-string show [--all --show-all]
[--default-eventhub --eh {false, true}]
[--hub-name]
[--key-type --kt {primary, secondary}]
[--pn --policy-name]
[--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
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
顯示個別IoT中樞的所有共用存取原則。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
指出傳回之連接字串的旗標是針對預設 EventHub 端點。 預設:false。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
| 接受的值: | false, true |
IoT 中樞 名稱或主機名。 如果未提供 --login,則為必要項。
| 屬性 | 值 |
|---|---|
| 參數群組: | IoT Hub Identifier Arguments |
用於驗證的共用存取原則金鑰類型。
| 屬性 | 值 |
|---|---|
| 預設值: | primary |
| 接受的值: | primary, secondary |
具有目標 IoT 中樞 實體作業許可權的共用存取原則。
| 屬性 | 值 |
|---|---|
| 預設值: | iothubowner |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |