az iot hub message-endpoint update

プレビュー
リファレンス

Note

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

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

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

コマンド

名前	説明	型	状態
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

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

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

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

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

コマンド

az iot hub message-endpoint update cosmosdb-container

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint update eventhub

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint update servicebus-queue

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint update servicebus-topic

例

必須のパラメーター

省略可能のパラメーター

az iot hub message-endpoint update storage-container

例

必須のパラメーター

省略可能のパラメーター

その他のリソース