az iot hub message-endpoint update

Note

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

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

IoT Hub の既存のエンドポイントのプロパティを更新します。

コマンド

名前	説明	型	Status
az iot hub message-endpoint update cosmosdb-container	IoT Hub の既存の Cosmos DB コンテナー エンドポイントのプロパティを更新します。	拡張	プレビュー
az iot hub message-endpoint update eventhub	IoT Hub の既存のイベント ハブ エンドポイントのプロパティを更新します。	拡張	プレビュー
az iot hub message-endpoint update servicebus-queue	IoT Hub の既存の Service Bus キュー エンドポイントのプロパティを更新します。	拡張	プレビュー
az iot hub message-endpoint update servicebus-topic	IoT Hub の既存の Service Bus トピック エンドポイントのプロパティを更新します。	拡張	プレビュー
az iot hub message-endpoint update storage-container	IoT Hub の既存のストレージ コンテナー エンドポイントのプロパティを更新します。	拡張	プレビュー

az iot hub message-endpoint update cosmosdb-container

プレビュー

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

IoT Hub の既存の Cosmos DB コンテナー エンドポイントのプロパティを更新します。

認証の種類をキーベースから ID ベースの Cosmos DB コンテナー エンドポイントに更新する場合は、ID (--identity 経由) とエンドポイント URI (--endpoint-uri 経由) を指定する必要があります。 古い主キーとセカンダリ キーは null になります。

認証の種類を ID ベースからキーベースの Cosmos DB コンテナー エンドポイントに更新する場合は、接続文字列 (--connection-string 経由)、主キー (--主キー経由)、またはセカンダリ キー (--secondary-key 経由) を指定する必要があります。

エンドポイントのコンテナー名は変更できません。 アカウント名は、同じ名前のコンテナーが両方のアカウントに存在する場合にのみ変更できます。

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

例

新しい指定された接続文字列を使用するように、IoT Hub のキーベースまたは ID ベースの Cosmos DB コンテナー エンドポイントを更新します。

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}

指定した主キーとセカンダリ キーを使用するように、IoT Hub の Cosmos DB コンテナー エンドポイントを更新します。

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}

システム割り当て ID とパーティション キー名を使用するように、IoT Hub の Cosmos DB コンテナー エンドポイントを更新します。 パーティション キー テンプレートが既定になります。

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]

ユーザー割り当て ID を使用するように IoT Hub のキーベースの Cosmos DB コンテナー エンドポイントを更新します (エンドポイントが既に ID ベースの場合は--endpoint-uri を省略できます)。

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--connection-string -c

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

--database-name --db

Cosmos DB アカウント内の Cosmos DB データベースの名前。

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

プレビュー

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

IoT Hub の既存のイベント ハブ エンドポイントのプロパティを更新します。

認証の種類をキーベースから ID ベースの Event Hub エンドポイントに更新する場合は、ID (--identity 経由)、エンドポイント URI (--endpoint-uri 経由)、エンティティ パス (--entity-path 経由) を指定する必要があります。 古い接続文字列は null 出力されます。

認証の種類を ID ベースからキーベースの Event Hub エンドポイントに更新する場合は、(--connection-string を使用して) 接続文字列を指定する必要があります。 古いエンドポイント URI とエンティティ パスは null になります。

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

例

新しい指定された接続文字列を使用するように、IoT Hub のキーベースまたは ID ベースのイベント ハブ エンドポイントを更新します。

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

システム割り当て ID と別のエンティティ パスを使用するように、IoT Hub のイベント ハブ エンドポイントを更新します。

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

ユーザー割り当て ID を使用するように IoT Hub のキーベースのイベント ハブ エンドポイントを更新します (エンドポイントが既に ID ベースの場合は--endpoint-uri を省略できます)。

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

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--connection-string -c

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

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

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

--endpoint-subscription-id -s

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

--endpoint-uri

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

--entity-path

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

--identity

エンドポイント認証には、システム割り当てマネージド ID またはユーザー割り当てマネージド ID を使用します。 "[system]" を使用して、システム割り当て ID またはリソース ID を参照し、ユーザー割り当て 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 message-endpoint update servicebus-queue

プレビュー

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

IoT Hub の既存の Service Bus キュー エンドポイントのプロパティを更新します。

認証の種類をキーベースから ID ベースの Service Bus キュー エンドポイントに更新する場合は、ID (--identity 経由)、エンドポイント URI (--endpoint-uri 経由)、エンティティ パス (--entity-path 経由) を指定する必要があります。 古い接続文字列は null 出力されます。

認証の種類を ID ベースからキーベースの Service Bus キュー エンドポイントに更新する場合は、(-connection-string を使用して) 接続文字列を指定する必要があります。 古いエンドポイント URI とエンティティ パスは null になります。

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

例

新しい指定された接続文字列を使用するように、IoT Hub のキーベースまたは ID ベースの Service Bus キュー エンドポイントを更新します。

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

システム割り当て ID と別のエンティティ パスを使用するように、IoT Hub の Service Bus キュー エンドポイントを更新します。

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

ユーザー割り当て ID を使用するように、IoT Hub のキーベースの Service Bus キュー エンドポイントを更新します (エンドポイントが既に ID ベースの場合は、--endpoint-uri を省略できます)。

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

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--connection-string -c

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

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

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

--endpoint-subscription-id -s

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

--endpoint-uri

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

--entity-path

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

--identity

エンドポイント認証には、システム割り当てマネージド ID またはユーザー割り当てマネージド ID を使用します。 "[system]" を使用して、システム割り当て ID またはリソース ID を参照し、ユーザー割り当て 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 message-endpoint update servicebus-topic

プレビュー

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

IoT Hub の既存の Service Bus トピック エンドポイントのプロパティを更新します。

認証の種類をキーベースから ID ベースの Service Bus トピック エンドポイントに更新する場合は、ID (--identity 経由)、エンドポイント URI (--endpoint-uri 経由)、エンティティ パス (--entity-path 経由) を指定する必要があります。 古い接続文字列は null 出力されます。

ID ベースからキーベースの Service Bus トピック エンドポイントに認証の種類を更新する場合は、(--connection-string を使用して) 接続文字列を指定する必要があります。 古いエンドポイント URI とエンティティ パスは null になります。

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

例

IoT Hub のキーベースまたは ID ベースの Service Bus トピック エンドポイントを更新して、指定した新しい接続文字列を使用します。

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

システム割り当て ID と別のエンティティ パスを使用するように、IoT Hub の Service Bus トピック エンドポイントを更新します。

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

ユーザー割り当て ID を使用するように IoT Hub のキーベースの Service Bus トピック エンドポイントを更新します (エンドポイントが既に ID ベースの場合は、--endpoint-uri を省略できます)。

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

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--connection-string -c

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

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

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

--endpoint-subscription-id -s

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

--endpoint-uri

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

--entity-path

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

--identity

エンドポイント認証には、システム割り当てマネージド ID またはユーザー割り当てマネージド ID を使用します。 "[system]" を使用して、システム割り当て ID またはリソース ID を参照し、ユーザー割り当て 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 message-endpoint update storage-container

プレビュー

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

IoT Hub の既存のストレージ コンテナー エンドポイントのプロパティを更新します。

認証の種類をキーベースから ID ベースのストレージ コンテナー エンドポイントに更新する場合は、ID (--identity 経由) とエンドポイント URI (--endpoint-uri 経由) を指定する必要があります。 古い接続文字列は null 出力されます。

ID ベースからキーベースのストレージ コンテナー エンドポイントに認証の種類を更新する場合は、(--connection-string を使用して) 接続文字列を指定する必要があります。

エンドポイントのコンテナー名とエンコードは変更できません。 アカウント名は、同じ名前のコンテナーが両方のアカウントに存在する場合にのみ変更できます。

az iot hub message-endpoint update storage-container --en
                                                     --hub-name
                                                     [--batch-frequency]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--endpoint-resource-group]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff]
                                                     [--identity]
                                                     [--resource-group]

例

新しい指定された接続文字列を使用するように、IoT Hub のキーベースまたは ID ベースのストレージ コンテナー エンドポイントを更新します。

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

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

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

ユーザー割り当て ID を使用するように IoT Hub のキーベースのストレージ コンテナー エンドポイントを更新します (エンドポイントが既に ID ベースである場合は、--endpoint-uri を省略できます)。

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

必須のパラメーター

--en --endpoint --endpoint-name

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

--hub-name -n

IoT Hub 名。

省略可能のパラメーター

--batch-frequency -b

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

--chunk-size -w

要求チャンク サイズ (メガバイト(MB (メガバイト))。 BLOB の最大サイズ (10 ~ 500 MB (メガバイト))。

--connection-string -c

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

--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} フィールドが含まれている必要があります。 すべてのパラメーターは必須ですが、区切り記号の有無にかかわらず並べ替えることができます。

--identity

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