az iot hub message-endpoint

Note

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

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

管理 IoT 中樞的自訂端點。

命令

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

az iot hub message-endpoint delete

預覽

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

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

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

az iot hub message-endpoint delete [--en --endpoint --endpoint-name]
                                   [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--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

選擇性參數

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

--en --endpoint --endpoint-name

路由端點的名稱。

--endpoint-type --type -t

路由端點的類型。

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

--force -f

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

屬性	值
預設值:	False

--hub-name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--yes -y

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

屬性	值
接受的值:	false, true

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub message-endpoint list

預覽

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

取得 IoT 中樞 所有端點的相關信息。

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

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

範例

從 IoT 中樞取得所有端點。

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

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

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

選擇性參數

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

--endpoint-type --type -t

路由端點的類型。

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

--hub-name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub message-endpoint show

預覽

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

取得 IoT 中樞 所提及端點的相關信息。

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

範例

從IoT中樞取得端點資訊。

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

必要參數

--en --endpoint --endpoint-name

路由端點的名稱。

選擇性參數

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

--hub-name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False