共用方式為

az iot hub message-endpoint create

  • 預覽
  • 參考

注意

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

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

將端點新增至 IoT 中樞。

命令

名稱 Description 類型 狀態
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 create cosmosdb-container

預覽

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

為 IoT 中樞 新增 Cosmos DB 容器端點。

az iot hub message-endpoint create cosmosdb-container --container
                                                      --database-name
                                                      --en
                                                      --hub-name
                                                      [--connection-string]
                                                      [--endpoint-account]
                                                      [--endpoint-resource-group]
                                                      [--endpoint-subscription-id]
                                                      [--endpoint-uri]
                                                      [--identity]
                                                      [--partition-key-name]
                                                      [--partition-key-template]
                                                      [--pk]
                                                      [--resource-group]
                                                      [--secondary-key]

範例

為 IoT 中樞 建立金鑰型 Cosmos DB 容器端點。

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --container {container} --db {database} --endpoint-account {account_name}

使用 連接字串 建立 IoT 中樞 的 Cosmos DB 容器端點。

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} -c {connection_string} --container {container} --db {database}

使用指定的主鍵和端點 URI，為 IoT 中樞 建立 Cosmos DB 容器端點。

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --endpoint-uri {endpoint_uri} --container {container} --db {database}

使用系統指派的身分識別和數據分割索引鍵名稱，為 IoT 中樞 建立 Cosmos DB 容器端點。 分割區索引鍵範本將是預設值。

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container} --db {database} --pkn {partition_key_name} --identity [system]

使用使用者指派的身分識別、分割區索引鍵名稱和分割區索引鍵範本，為 IoT 中樞 建立 Cosmos DB 容器端點。

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container} --db {database} --pkn {partition_key_name} --pkt {partition_key_template} --identity {user_identity_resource_id}

必要參數

--container --container-name

Cosmos DB 資料庫中 Cosmos DB SQL 容器的名稱。

--database-name --db

cosmos DB 帳戶中 cosmos DB 資料庫的名稱。

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞 名稱。

選擇性參數

--connection-string -c

路由端點的連接字串。

--endpoint-account

端點資源的帳戶名稱。

--endpoint-resource-group --erg -r

端點的資源群組重新調整。 如果未提供，則會使用 IoT 中樞 的資源群組。

--endpoint-subscription-id -s

端點資源的訂用帳戶標識碼。 如果未提供，則會使用 IoT 中樞 的訂用帳戶。

--endpoint-uri

端點資源的 URI。

--identity

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼，以參考使用者指派的身分識別。

--partition-key-name --pkn

如果存在，則為與此 Cosmos DB SQL 容器相關聯的分割區索引鍵名稱。

--partition-key-template --pkt

用來產生綜合分割區索引鍵值的範本，以便與這個 Cosmos DB SQL 容器搭配使用。 範本至少必須包含下列其中一個佔位元：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個佔位元最多可以指定一次，但順序和非佔位元元元件都是任意的。 如果提供分割區索引鍵名稱，分割區索引鍵範本預設為 {deviceid}-{YYYY}-{MM}。

--pk --primary-key

cosmos DB 帳戶的主鍵。

--resource-group -g

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

--secondary-key --sk

cosmos DB 帳戶的次要密鑰。

全域參數
--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 create eventhub

預覽

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

新增 IoT 中樞的事件中樞端點。

az iot hub message-endpoint create eventhub --en
                                            --hub-name
                                            [--connection-string]
                                            [--endpoint-namespace-name]
                                            [--endpoint-policy-name]
                                            [--endpoint-resource-group]
                                            [--endpoint-subscription-id]
                                            [--endpoint-uri]
                                            [--entity-path]
                                            [--identity]
                                            [--resource-group]

範例

為 IoT 中樞 建立金鑰型事件中樞端點。

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

使用 連接字串 建立 IoT 中樞 的事件中樞端點。 省略端點 URI 和實體路徑。

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}

使用系統指派的身分識別，為 IoT 中樞 建立事件中樞端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity [system]

使用使用者指派的身分識別，為 IoT 中樞 建立事件中樞端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

必要參數

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞 名稱。

選擇性參數

--connection-string -c

路由端點的連接字串。

--endpoint-namespace-name --namespace

端點資源的命名空間名稱。

--endpoint-policy-name --policy

連接字串 擷取的原則名稱。

--endpoint-resource-group --erg -r

端點的資源群組重新調整。 如果未提供，則會使用 IoT 中樞 的資源群組。

--endpoint-subscription-id -s

端點資源的訂用帳戶標識碼。 如果未提供，則會使用 IoT 中樞 的訂用帳戶。

--endpoint-uri

端點資源的 URI。

--entity-path

端點資源的實體路徑。

--identity

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼，以參考使用者指派的身分識別。

--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 create servicebus-queue

預覽

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

為 IoT 中樞 新增 服務匯流排 佇列端點。

az iot hub message-endpoint create servicebus-queue --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-namespace-name]
                                                    [--endpoint-policy-name]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

範例

為 IoT 中樞 建立金鑰型 服務匯流排 仱列端點。

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

使用 連接字串 建立 IoT 中樞 的 服務匯流排 佇列端點。 省略端點 URI 和實體路徑。

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}

使用系統指派的身分識別，為 IoT 中樞 建立 服務匯流排 佇列端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity [system]

使用使用者指派的身分識別，為 IoT 中樞 建立 服務匯流排 佇列端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

必要參數

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞 名稱。

選擇性參數

--connection-string -c

路由端點的連接字串。

--endpoint-namespace-name --namespace

端點資源的命名空間名稱。

--endpoint-policy-name --policy

連接字串 擷取的原則名稱。

--endpoint-resource-group --erg -r

端點的資源群組重新調整。 如果未提供，則會使用 IoT 中樞 的資源群組。

--endpoint-subscription-id -s

端點資源的訂用帳戶標識碼。 如果未提供，則會使用 IoT 中樞 的訂用帳戶。

--endpoint-uri

端點資源的 URI。

--entity-path

端點資源的實體路徑。

--identity

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼，以參考使用者指派的身分識別。

--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 create servicebus-topic

預覽

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

為 IoT 中樞 新增 服務匯流排 主題端點。

az iot hub message-endpoint create servicebus-topic --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-namespace-name]
                                                    [--endpoint-policy-name]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

範例

為 IoT 中樞 建立以金鑰為基礎的 服務匯流排 主題端點。

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

使用 連接字串 建立 IoT 中樞 服務匯流排 主題端點。 省略端點 URI 和實體路徑。

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}

使用系統指派的身分識別，為 IoT 中樞 建立 服務匯流排 主題端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity [system]

使用使用者指派的身分識別，為 IoT 中樞 建立 服務匯流排 主題端點。 必須指定端點和實體路徑。

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

必要參數

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞 名稱。

選擇性參數

--connection-string -c

路由端點的連接字串。

--endpoint-namespace-name --namespace

端點資源的命名空間名稱。

--endpoint-policy-name --policy

連接字串 擷取的原則名稱。

--endpoint-resource-group --erg -r

端點的資源群組重新調整。 如果未提供，則會使用 IoT 中樞 的資源群組。

--endpoint-subscription-id -s

端點資源的訂用帳戶標識碼。 如果未提供，則會使用 IoT 中樞 的訂用帳戶。

--endpoint-uri

端點資源的 URI。

--entity-path

端點資源的實體路徑。

--identity

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼，以參考使用者指派的身分識別。

--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 create storage-container

預覽

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

為 IoT 中樞 新增記憶體容器端點。

az iot hub message-endpoint create storage-container --container
                                                     --en
                                                     --hub-name
                                                     [--batch-frequency]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--encoding {avro, json}]
                                                     [--endpoint-account]
                                                     [--endpoint-resource-group]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff]
                                                     [--identity]
                                                     [--resource-group]

範例

為 IoT 中樞 建立金鑰型記憶體容器端點。

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --container {container_name} --endpoint-account {account_name}

使用 連接字串 建立 IoT 中樞 的記憶體容器端點。 省略端點 URI。

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string} --container {container_name}

使用具有指定批次頻率、區塊大小和檔名格式的系統指派身分識別，為 IoT 中樞 建立記憶體容器端點。 必須指定端點。

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container_name} -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]

使用使用者指派的身分識別搭配 json 編碼，為 IoT 中樞 建立記憶體容器端點。 必須指定端點。

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container_name} --encoding json --identity {user_identity_resource_id}

必要參數

--container --container-name

記憶體容器的名稱。

--en --endpoint --endpoint-name

路由端點的名稱。

--hub-name -n

IoT 中樞 名稱。

選擇性參數

--batch-frequency -b

以秒為單位要求批次頻率。 數據寫入 Blob 之前可以經過的時間上限，介於 60 到 720 秒之間。

預設值: 300
--chunk-size -w

要求以 MB 為單位的區塊大小（MB）。 Blob 的大小上限，介於 10 到 500 MB 之間。

預設值: 300
--connection-string -c

路由端點的連接字串。

--encoding

容器的編碼格式。

接受的值: avro, json
預設值: avro
--endpoint-account

端點資源的帳戶名稱。

--endpoint-resource-group --erg -r

端點的資源群組重新調整。 如果未提供，則會使用 IoT 中樞 的資源群組。

--endpoint-subscription-id -s

端點資源的訂用帳戶標識碼。 如果未提供，則會使用 IoT 中樞 的訂用帳戶。

--endpoint-uri

端點資源的 URI。

--ff --file-name-format

Blob 的檔名格式。 文件名格式必須包含 {iothub}、{partition}、{YYYY}、{MM}、{DD}、{HH} 和 {mm} 字段。 所有參數都是必要參數，但可以使用或不使用分隔符重新排序。

預設值: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}
--identity

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼，以參考使用者指派的身分識別。

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