az iot ops broker listener

Note

このリファレンスは、Azure CLI (バージョン 2.70.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops ブローカー リスナー コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

Mqtt ブローカー リスナーの管理。

コマンド

名前	説明	型	状態
az iot ops broker listener apply	mqtt ブローカー リスナー サービスを作成または置換します。	Extension	GA
az iot ops broker listener delete	mqtt ブローカー リスナーを削除します。	Extension	GA
az iot ops broker listener list	ブローカーに関連付けられている mqtt ブローカー リスナーを一覧表示します。	Extension	GA
az iot ops broker listener port	Mqtt ブローカー リスナーのポート操作。	Extension	GA
az iot ops broker listener port add	tcp ポート構成を mqtt ブローカー リスナー サービスに追加します。	Extension	GA
az iot ops broker listener port remove	mqtt ブローカー リスナー サービスから tcp ポート構成を削除します。	Extension	GA
az iot ops broker listener show	mqtt ブローカー リスナーの詳細を表示します。	Extension	GA

az iot ops broker listener apply

mqtt ブローカー リスナー サービスを作成または置換します。

構成ファイル形式の例を次に示します。

{
  "serviceType": "LoadBalancer",
  "ports": [
      {
          "port": 1883,
          "protocol": "Mqtt"
      },
      {
          "authenticationRef": "default",
          "port": 8883,
          "protocol": "Mqtt",
          "tls": {
              "mode": "Automatic",
              "certManagerCertificateSpec": {
                  "issuerRef": {
                      "name": "azure-iot-operations-aio-certificate-issuer",
                      "kind": "ClusterIssuer",
                      "group": "cert-manager.io"
                  }
              }
          }
      }
  ]
}

上記のコンテンツを適用して使用すると、ターゲット リスナーが 2 つのポート構成で作成または置き換えられます。

az iot ops broker listener apply --config-file
                                 --instance
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--broker]
                                 [--change-reference]

例

構成ファイルを使用して、既定のブローカーのリスナーを作成または置換します。

az iot ops broker listener apply -n listener --in myinstance -g myresourcegroup --config-file /path/to/listener/config.json

必須のパラメーター

--config-file

json 形式のリソース プロパティを含む構成ファイルへのパス。 構成ファイルには、リソースの ARM 表現と互換性のあるプロパティを持つオブジェクトが含まれている必要があります。 このオブジェクトは、ARM リソースの 'properties:{}' と直接関連付けられます。

プロパティ	値
パラメーター グループ:	Config Arguments

--instance -i

IoT Operations インスタンス名。

--name -n

リスナー名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--broker -b

ブローカー名。

プロパティ	値
規定値:	default

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops broker listener delete

mqtt ブローカー リスナーを削除します。

az iot ops broker listener delete --instance
                                  --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--broker]
                                  [--change-reference]
                                  [--yes {false, true}]

例

既定のブローカーに関連付けられている mqtt ブローカー リスナーを削除します。

az iot ops broker listener delete -n listener --in myinstance -g myresourcegroup

前の例と同じですが、確認プロンプトをスキップします。

az iot ops broker listener delete -n listener --in myinstance -g myresourcegroup -y

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--name -n

リスナー名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--broker -b

ブローカー名。

プロパティ	値
規定値:	default

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--yes -y

プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。

プロパティ	値
指定可能な値:	false, true

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops broker listener list

ブローカーに関連付けられている mqtt ブローカー リスナーを一覧表示します。

az iot ops broker listener list --instance
                                --resource-group
                                [--broker]

例

既定のブローカーに関連付けられているすべての mqtt ブローカー リスナーを列挙します。

az iot ops broker listener list --in myinstance -g myresourcegroup

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--broker -b

ブローカー名。

プロパティ	値
規定値:	default

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops broker listener show

mqtt ブローカー リスナーの詳細を表示します。

az iot ops broker listener show --instance
                                --name
                                --resource-group
                                [--broker]

例

既定のブローカーに関連付けられている既定のリスナーの詳細を表示します。

az iot ops broker listener show -n default --in myinstance -g myresourcegroup

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--name -n

リスナー名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--broker -b

ブローカー名。

プロパティ	値
規定値:	default

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False