az iot hub message-endpoint create

プレビュー
リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot hub message-endpoint create コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

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

コマンド

名前	説明	型	状態
az iot hub message-endpoint create cosmosdb-container	IoT Hub の Cosmos DB コンテナーエンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create eventhub	IoT Hub のイベントハブエンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create servicebus-queue	IoT Hub の Service Bus キューエンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create servicebus-topic	IoT Hub の Service Bus トピックエンドポイントを追加します。	拡張子	プレビュー
az iot hub message-endpoint create storage-container	IoT Hub のストレージコンテナーエンドポイントを追加します。	拡張子	プレビュー

az iot hub message-endpoint create cosmosdb-container

プレビュー

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Hub の 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 Hub のキーベースの 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 Hub の 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 Hub の 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}

システム割り当て ID とパーティションキー名を使用して、IoT Hub の 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]

ユーザー割り当て ID、パーティションキー名、パーティションキーテンプレートを使用して、IoT Hub の 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 Hub 名。

省略可能のパラメーター

--connection-string -c

ルーティングエンドポイントの接続文字列。

--endpoint-account

エンドポイントリソースのアカウント名。

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

エンドポイントのリソースグループが再リソース化されます。指定しない場合は、IoT Hub のリソースグループが使用されます。

--endpoint-subscription-id -s

エンドポイントリソースのサブスクリプション ID。指定しない場合は、IoT Hub のサブスクリプションが使用されます。

--endpoint-uri

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

--identity

エンドポイント認証には、システム割り当てマネージド ID またはユーザー割り当てマネージド ID を使用します。 "[system]" を使用して、システム割り当て ID またはリソース ID を参照し、ユーザー割り当て ID を参照します。

--partition-key-name --pkn

この Cosmos DB SQL コンテナーに関連付けられているパーティションキーの名前 (存在する場合)。

--partition-key-template --pkt

この Cosmos DB SQL コンテナーで使用する合成パーティションキー値を生成するためのテンプレート。テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。パーティションキー名が指定されている場合、パーティションキーテンプレートの既定値は {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

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

--verbose

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

az iot hub message-endpoint create eventhub

プレビュー

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Hub のイベントハブエンドポイントを追加します。

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 Hub のキーベースのイベントハブエンドポイントを作成します。

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

接続文字列を使用して IoT Hub のイベントハブエンドポイントを作成します。エンドポイント URI とエンティティパスは省略されます。

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

システム割り当て ID を使用して、IoT Hub のイベントハブエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

ユーザー割り当て ID を使用して、IoT Hub のイベントハブエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

省略可能のパラメーター

--connection-string -c

ルーティングエンドポイントの接続文字列。

--endpoint-namespace-name --namespace

エンドポイントリソースの名前空間名。

--endpoint-policy-name --policy

接続文字列取得のポリシー名。

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

エンドポイントのリソースグループが再リソース化されます。指定しない場合は、IoT Hub のリソースグループが使用されます。

--endpoint-subscription-id -s

エンドポイントリソースのサブスクリプション ID。指定しない場合は、IoT Hub のサブスクリプションが使用されます。

--endpoint-uri

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

--entity-path

エンドポイントリソースのエンティティパス。

--identity

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

プレビュー

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Hub の Service Bus キューエンドポイントを追加します。

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 Hub のキーベースの Service Bus キューエンドポイントを作成します。

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 Hub の Service Bus キューエンドポイントを作成します。エンドポイント URI とエンティティパスは省略されます。

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

システム割り当て ID を使用して、IoT Hub の Service Bus キューエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

ユーザー割り当て ID を使用して、IoT Hub の Service Bus キューエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

省略可能のパラメーター

--connection-string -c

ルーティングエンドポイントの接続文字列。

--endpoint-namespace-name --namespace

エンドポイントリソースの名前空間名。

--endpoint-policy-name --policy

接続文字列取得のポリシー名。

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

エンドポイントのリソースグループが再リソース化されます。指定しない場合は、IoT Hub のリソースグループが使用されます。

--endpoint-subscription-id -s

エンドポイントリソースのサブスクリプション ID。指定しない場合は、IoT Hub のサブスクリプションが使用されます。

--endpoint-uri

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

--entity-path

エンドポイントリソースのエンティティパス。

--identity

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

プレビュー

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Hub の Service Bus トピックエンドポイントを追加します。

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 Hub のキーベースの Service Bus トピックエンドポイントを作成します。

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 Hub の Service Bus トピックエンドポイントを作成します。エンドポイント URI とエンティティパスは省略されます。

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

システム割り当て ID を使用して、IoT Hub の Service Bus トピックエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

ユーザー割り当て ID を使用して、IoT Hub の Service Bus トピックエンドポイントを作成します。エンドポイントとエンティティのパスを指定する必要があります。

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

省略可能のパラメーター

--connection-string -c

ルーティングエンドポイントの接続文字列。

--endpoint-namespace-name --namespace

エンドポイントリソースの名前空間名。

--endpoint-policy-name --policy

接続文字列取得のポリシー名。

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

エンドポイントのリソースグループが再リソース化されます。指定しない場合は、IoT Hub のリソースグループが使用されます。

--endpoint-subscription-id -s

エンドポイントリソースのサブスクリプション ID。指定しない場合は、IoT Hub のサブスクリプションが使用されます。

--endpoint-uri

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

--entity-path

エンドポイントリソースのエンティティパス。

--identity

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

プレビュー

コマンドグループ "iot hub message-endpoint" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Hub のストレージコンテナーエンドポイントを追加します。

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 Hub のキーベースのストレージコンテナーエンドポイントを作成します。

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

接続文字列を使用して IoT Hub のストレージコンテナーエンドポイントを作成します。エンドポイント URI は省略されます。

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

指定されたバッチ頻度、チャンクサイズ、およびファイル名形式でシステム割り当て ID を使用して、IoT Hub のストレージコンテナーエンドポイントを作成します。エンドポイントを指定する必要があります。

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]

ユーザー割り当て ID と json エンコードを使用して、IoT Hub のストレージコンテナーエンドポイントを作成します。エンドポイントを指定する必要があります。

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

省略可能のパラメーター

--batch-frequency -b

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

規定値: 300

--chunk-size -w

要求チャンクサイズ (MB 単位)。 BLOB の最大サイズ (10 ~ 500 MB)。

規定値: 300

--connection-string -c

ルーティングエンドポイントの接続文字列。

--encoding

コンテナーのエンコード形式。

指定可能な値: avro, json

規定値: avro

--endpoint-account

エンドポイントリソースのアカウント名。

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

エンドポイントのリソースグループが再リソース化されます。指定しない場合は、IoT Hub のリソースグループが使用されます。

--endpoint-subscription-id -s

エンドポイントリソースのサブスクリプション ID。指定しない場合は、IoT Hub のサブスクリプションが使用されます。

--endpoint-uri

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

--ff --file-name-format

BLOB のファイル名の形式。ファイル名の形式には、{iothub}、{partition}、{YYYY}、{MM}、{DD}、{HH} および {mm} フィールドが含まれている必要があります。すべてのパラメーターは必須ですが、区切り記号の有無にかかわらず並べ替えることができます。

規定値: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}

--identity

--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 message-endpoint create

コマンド

az iot hub message-endpoint create cosmosdb-container

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint create eventhub

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint create servicebus-queue

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint create servicebus-topic

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint create storage-container

例

必須のパラメーター

省略可能のパラメーター

その他のリソース