az iot hub routing-endpoint

  • 非推奨
  • リファレンス

このコマンド グループは非推奨となり、今後のリリースで削除される予定です。 代わりに、'IoT Extension (azure-iot) message-endpoint コマンド グループ (az iot hub message-endpoint)' を使用してください。

IoT ハブのカスタム エンドポイントを管理します。

コマンド

名前 説明 型 Status
az iot hub routing-endpoint create

IoT Hub にエンドポイントを追加します。

 コア 非推奨
az iot hub routing-endpoint delete

IoT Hub のすべてのエンドポイントまたはメンションエンドポイントを削除します。

 コア 非推奨
az iot hub routing-endpoint list

IoT Hub のすべてのエンドポイントに関する情報を取得します。

 コア 非推奨
az iot hub routing-endpoint show

IoT Hub のメンションエンドポイントに関する情報を取得します。

 コア 非推奨

az iot hub routing-endpoint create

編集
非推奨

コマンド グループ 'iot hub routing-endpoint' は非推奨となり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-endpoint コマンド グループ (az iot hub message-endpoint)' を使用してください。

IoT Hub にエンドポイントを追加します。

IoT Hub に新しいカスタム エンドポイントを作成します。

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 Hub に追加します。

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}

エンドポイント リソース グループ "MyEndpointResourceGroup" 内の "MyIotHub" IoT Hub に、AzureStorageContainer 型の新しいエンドポイント "S1" を追加します。

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" という名前の新しい ID ベースの EventHub エンドポイントを追加し、ユーザー割り当てマネージド ID を使用して認証する

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

エンドポイント リソースの SubscriptionId。

--endpoint-type --type -t

ルーティング エンドポイントの種類。

承認された値: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT Hub 名。

省略可能のパラメーター

--auth-type

エンドポイントの認証の種類。 既定値は keyBased です。

承認された値: identityBased, keyBased
--batch-frequency -b

バッチの頻度を秒単位で要求します。 データが BLOB に書き込まれるまでの最大時間 (60 ~ 720 秒)。

既定値: 300
--chunk-size -w

要求チャンク サイズ (メガバイト(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

エンドポイント認証には、システム割り当てマネージド ID またはユーザー割り当てマネージド ID を使用します。 "[system]" を使用して、システム割り当て ID またはリソース ID を参照し、ユーザー割り当て ID を参照します。 このパラメーターを指定せずに --auth-type を使用する場合は、システム割り当てマネージド ID が想定されます。

--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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub routing-endpoint delete

編集
非推奨

コマンド グループ 'iot hub routing-endpoint' は非推奨となり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-endpoint コマンド グループ (az iot hub message-endpoint)' を使用してください。

IoT Hub のすべてのエンドポイントまたはメンションエンドポイントを削除します。

IoT Hub のエンドポイントを削除します。 エンドポイントを削除する前に、エンドポイントへのルートを削除することをお勧めします。

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

例

"MyIotHub" IoT Hub からエンドポイント "E2" を削除します。

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

"MyIotHub" IoT Hub から "EventHub" 型のすべてのエンドポイントを削除します。

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

"MyIotHub" IoT Hub からすべてのエンドポイントを削除します。

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 Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub routing-endpoint list

編集
非推奨

コマンド グループ 'iot hub routing-endpoint' は非推奨となり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-endpoint コマンド グループ (az iot hub message-endpoint)' を使用してください。

IoT Hub のすべてのエンドポイントに関する情報を取得します。

IoT Hub 内のすべてのエンドポイントに関する情報を取得します。 また、インフォーマイトンを取得するエンドポイントの種類を指定することもできます。

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

例

"MyIotHub" IoT Hub からすべてのエンドポイントを取得します。

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

"MyIotHub" IoT Hub から"EventHub" 型のすべてのエンドポイントを取得します。

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 Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub routing-endpoint show

編集
非推奨

コマンド グループ 'iot hub routing-endpoint' は非推奨となり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。 代わりに、'IoT Extension (azure-iot) message-endpoint コマンド グループ (az iot hub message-endpoint)' を使用してください。

IoT Hub のメンションエンドポイントに関する情報を取得します。

IoT Hub 内の特定のエンドポイントに関する情報を取得します。

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

例

"MyIotHub" IoT Hub からエンドポイント情報を取得します。

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

必須のパラメーター

--endpoint-name --name -n

ルーティング エンドポイントの名前。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。