az iot hub routing-endpoint

此命令群組已被取代,將在未來的版本中移除。 請改用 'IoT Extension (azure-iot) message-endpoint 命令群組 (az iot hub message-endpoint)'。

管理 IoT 中樞的自訂端點。

命令

名稱 Description 類型 狀態
az iot hub routing-endpoint create

將端點新增至您的IoT 中樞。

核心 已取代
az iot hub routing-endpoint delete

刪除IoT 中樞的所有或提及端點。

核心 已取代
az iot hub routing-endpoint list

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

核心 已取代
az iot hub routing-endpoint show

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

核心 已取代

az iot hub routing-endpoint create

已被取代

此命令已隱含取代,因為命令群組 'iot 中樞路由端點' 已被取代,且將在未來的版本中移除。 請改用 'IoT Extension (azure-iot) message-endpoint 命令群組 (az iot hub message-endpoint)'。

將端點新增至您的IoT 中樞。

在您的IoT 中樞中建立新的自訂端點。

az iot hub routing-endpoint create --endpoint-name
                                   --endpoint-resource-group
                                   --endpoint-subscription-id
                                   --endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}
                                   --hub-name
                                   [--auth-type {identityBased, keyBased}]
                                   [--batch-frequency]
                                   [--chunk-size]
                                   [--connection-string]
                                   [--container]
                                   [--encoding {avro, json}]
                                   [--endpoint-uri]
                                   [--entity-path]
                                   [--ff]
                                   [--identity]
                                   [--resource-group]

範例

將 EventHub 類型的新端點 「E2」 新增至 「MyIotHub」 IoT 中樞。

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString}

將 Azure儲存體Container 類型的新端點 「S1」 新增至端點資源群組 「MyEndpointResourceGroup」 內的 「MyIotHub」 IoT 中樞。

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name S1 --endpoint-type azurestoragecontainer --endpoint-resource-group MyEndpointResourceGroup \
--endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString} \
--container-name {ContainerName} --batch-frequency 100 --chunk-size 100 \
--ff {iothub}-{partition}-{YYYY}-{MM}-{DD}-{HH}-{mm}

新增名為 「EventHubIdentity」 的新身分識別型 EventHub 端點,並使用使用者指派的受控識別進行驗證

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name EventHubIdentity --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --auth-type identityBased --identity {userIdentityResourceId} --endpoint-uri {EventHubEndpointUri} --entity-path {EntityPath}

必要參數

--endpoint-name --name -n

路由端點的名稱。

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

端點的資源群組重新調整。

--endpoint-subscription-id -s

Endpoint 資源的 SubscriptionId。

--endpoint-type --type -t

路由端點的類型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中樞名稱。

選擇性參數

--auth-type

端點的驗證類型。 預設值為 keyBased。

接受的值: identityBased, keyBased
--batch-frequency -b

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

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

要求以 MB 為單位的區塊大小(MB)。 Blob 的大小上限,介於 10 到 500 MB 之間。

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

路由端點的連線字串。

--container --container-name

儲存體容器的名稱。

--encoding

容器的編碼格式。 預設值為 AVRO。 請注意,此欄位僅適用于 Blob 容器端點。

接受的值: avro, json
--endpoint-uri

端點資源的 URI。

--entity-path

端點資源的實體路徑。

--ff --file-name-format

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

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

使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。 如果您使用 --auth-type 而不使用此參數,則會假設系統指派的受控識別。

--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 routing-endpoint delete

已被取代

此命令已隱含取代,因為命令群組 'iot 中樞路由端點' 已被取代,且將在未來的版本中移除。 請改用 'IoT Extension (azure-iot) message-endpoint 命令群組 (az iot hub message-endpoint)'。

刪除IoT 中樞的所有或提及端點。

刪除IoT 中樞的端點。 建議您先刪除端點的任何路由,再刪除端點。

az iot hub routing-endpoint delete [--endpoint-name]
                                   [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]

範例

從 「MyIotHub」 刪除端點 「E2」 IoT 中樞。

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2

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

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

從 「MyIotHub」 IoT 中樞中刪除所有端點。

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub

選擇性參數

--endpoint-name --name -n

路由端點的名稱。

--endpoint-type --type -t

路由端點的類型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中樞名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數
--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 routing-endpoint list

已被取代

此命令已隱含取代,因為命令群組 'iot 中樞路由端點' 已被取代,且將在未來的版本中移除。 請改用 'IoT Extension (azure-iot) message-endpoint 命令群組 (az iot hub message-endpoint)'。

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

取得IoT 中樞中所有端點的相關資訊。 您也可以指定要取得 informaiton 的端點類型。

az iot hub routing-endpoint list [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

範例

從 「MyIotHub」 取得所有端點IoT 中樞。

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub

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

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

選擇性參數

--endpoint-type --type -t

路由端點的類型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中樞名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數
--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 routing-endpoint show

已被取代

此命令已隱含取代,因為命令群組 'iot 中樞路由端點' 已被取代,且將在未來的版本中移除。 請改用 'IoT Extension (azure-iot) message-endpoint 命令群組 (az iot hub message-endpoint)'。

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

取得IoT 中樞中特定端點的相關資訊。

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

範例

從 「MyIotHub」 IoT 中樞取得端點資訊。

az iot hub routing-endpoint show --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name {endpointName}

必要參數

--endpoint-name --name -n

路由端點的名稱。

選擇性參數

--hub-name

IoT 中樞名稱。

--ids

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

--resource-group -g

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

--subscription

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

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