az iot hub message-endpoint

注意

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

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理 IoT 中樞的自訂端點。

命令

名稱	Description	類型	狀態
az iot hub message-endpoint create	將端點新增至IoT 中樞。	擴充	預覽版
az iot hub message-endpoint create cosmosdb-container	為IoT 中樞新增 Cosmos DB 容器端點。	擴充	預覽版
az iot hub message-endpoint create eventhub	新增IoT 中樞的事件中樞端點。	擴充	預覽版
az iot hub message-endpoint create servicebus-queue	為IoT 中樞新增服務匯流排佇列端點。	擴充	預覽版
az iot hub message-endpoint create servicebus-topic	為IoT 中樞新增服務匯流排主題端點。	擴充	預覽版
az iot hub message-endpoint create storage-container	為IoT 中樞新增儲存體容器端點。	擴充	預覽版
az iot hub message-endpoint delete	刪除IoT 中樞的所有或特定端點。	擴充	預覽版
az iot hub message-endpoint list	取得IoT 中樞所有端點的相關資訊。	擴充	預覽版
az iot hub message-endpoint show	取得IoT 中樞所提及端點的相關資訊。	擴充	預覽版
az iot hub message-endpoint update	更新IoT 中樞之現有端點的屬性。	擴充	預覽版
az iot hub message-endpoint update cosmosdb-container	更新現有 Cosmos DB 容器端點的屬性，以取得IoT 中樞。	擴充	預覽版
az iot hub message-endpoint update eventhub	更新IoT 中樞之現有事件中樞端點的屬性。	擴充	預覽版
az iot hub message-endpoint update servicebus-queue	更新IoT 中樞現有服務匯流排佇列端點的屬性。	擴充	預覽版
az iot hub message-endpoint update servicebus-topic	更新IoT 中樞現有服務匯流排主題端點的屬性。	擴充	預覽版
az iot hub message-endpoint update storage-container	更新IoT 中樞之現有儲存體容器端點的屬性。	擴充	預覽版

az iot hub message-endpoint delete

預覽

命令群組 'iot 中樞訊息端點' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除IoT 中樞的所有或特定端點。

您必須先刪除端點的任何路由和訊息擴充，才能刪除端點。

az iot hub message-endpoint delete --hub-name
                                   [--en]
                                   [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--resource-group]
                                   [--yes {false, true}]

範例

從IoT 中樞刪除端點。

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}

從IoT 中樞中刪除 「EventHub」 類型的所有端點。

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub

從IoT 中樞刪除所有端點。

az iot hub message-endpoint delete -n {iothub_name}

強制從IoT 中樞刪除端點。 這會刪除與此端點相關聯的任何路由和訊息擴充。

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f

強制從IoT 中樞刪除 「EventHub」 類型的所有端點。 這會刪除與此端點相關聯的任何路由和訊息擴充。

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f

必要參數

--hub-name -n

IoT 中樞名稱。

選擇性參數

--en --endpoint --endpoint-name

路由端點的名稱。

--endpoint-type --type -t

路由端點的類型。

接受的值: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

--force -f

強制刪除端點和相關聯的任何路由和訊息擴充。

預設值: False

--resource-group -g

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

--yes -y

略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。

接受的值: false, true

全域參數

--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 hub message-endpoint list

預覽

命令群組 'iot 中樞訊息端點' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得IoT 中樞所有端點的相關資訊。

您也可以指定要取得相關資訊的端點類型。

az iot hub message-endpoint list --hub-name
                                 [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--resource-group]

範例

從IoT 中樞取得所有端點。

az iot hub message-endpoint list -n {iothub_name}

從IoT 中樞取得 「EventHub」 類型的所有端點。

az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub

必要參數

--hub-name -n

IoT 中樞名稱。

選擇性參數

--endpoint-type --type -t

路由端點的類型。

接受的值: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

--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 hub message-endpoint show

預覽

命令群組 'iot 中樞訊息端點' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得IoT 中樞所提及端點的相關資訊。

az iot hub message-endpoint show --en
                                 --hub-name
                                 [--resource-group]

範例

從IoT 中樞取得端點資訊。

az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}

必要參數

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞名稱。

選擇性參數

--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 來取得完整偵錯記錄。