az iot ops ns asset event

Note

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

IoT Operations 名前空間の資産イベント グループのイベントを管理します。

コネクタの種類は、既存の資産から自動的に検出されます。 コネクタ固有のパラメーターには、--event-config (インライン JSON またはファイル) を使用します。 --show-template を使用して、資産のコネクタの種類でサポートされている構成スキーマを検出します。

コマンド

名前 説明 状態
az iot ops ns asset event add

IoT Operations 名前空間の資産イベント グループにイベントを追加します。

Extension Preview
az iot ops ns asset event export

イベントをファイルにエクスポートします。

Extension Preview
az iot ops ns asset event import

ファイルからイベントをインポートします。

Extension Preview
az iot ops ns asset event list

IoT Operations 名前空間内の資産イベント グループのイベントを一覧表示します。

Extension Preview
az iot ops ns asset event remove

IoT Operations 名前空間の資産イベント グループからイベントを削除します。

Extension Preview

az iot ops ns asset event add

プレビュー

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

IoT Operations 名前空間の資産イベント グループにイベントを追加します。

コネクタの種類は、資産のデバイス エンドポイントから検出されます。 コネクタ固有の構成 (キュー サイズ、サンプリング間隔など) と宛先は、--event-config を使用して指定できます。--show-template を使用して、サポートされている構成スキーマを検出します。 OPC UA 以外のコネクタの場合、コネクタ テンプレートがインスタンスに存在する必要があります。

az iot ops ns asset event add --asset
                              --eg --event-group
                              --instance
                              --name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--data-source --ds]
                              [--ec --event-config]
                              [--replace {false, true}]
                              [--show-template {config, schema}]
                              [--tr --type-ref]

任意の資産の種類に基本的なイベントを追加する

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity"

資産のコネクタの種類のイベント構成テンプレートを表示する

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity" --show-template config

インライン JSON からコネクタ固有の構成でイベントを追加する

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity" --event-config '{"eventConfiguration": {"samplingInterval": 1000, "queueSize": 5}}'

ファイルから構成を含むイベントを追加する

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity" --event-config ./event_config.json

MQTT 宛先を使用してイベントを追加する

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity" --event-config '{"destinations": [{"target": "Mqtt", "configuration": {"topic": "factory/alarms", "retain": "Keep", "qos": "Qos1", "ttl": 3600}}]}'

既存のイベントを置き換える

az iot ops ns asset event add --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity --data-source "alarm.severity.updated" --replace

必須のパラメーター

--asset -a

資産名。

--eg --event-group

イベント グループ名。

--instance -i

Azure IoT Operations インスタンスの名前。

--name -n

イベント名。

--resource-group -g

Azure IoT Operations インスタンスのリソース グループ。

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

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

--acquire-policy-token

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

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

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

プロパティ
パラメーター グループ: Global Policy Arguments
--data-source --ds

イベントのデータ ソース。

--ec --event-config

コネクタ固有のイベント構成や宛先を含む JSON/YAML ファイル (.json、.yaml、.yml) へのインライン JSON 文字列またはパス。 受け入れられるキーは、'eventConfiguration' (コネクタ固有の構成オブジェクト) と 'destinations' (宛先オブジェクトの一覧) です。 --show-template を使用して、資産のコネクタの種類でサポートされているキーとスキーマを検出します。 --show-template と組み合わせることはできません。 OPC UA 以外のコネクタの場合、コネクタ テンプレートがインスタンスに存在する必要があります。

--replace

同じ名前の別のイベントが既に存在する場合は、イベントを置き換えます。

プロパティ
規定値: False
指定可能な値: false, true
--show-template

資産のコネクタの種類のスターター イベント構成テンプレートを表示し、イベントを変更せずに終了します。 コネクタの種類は、既存の資産から読み取られます。 config: 既定値と共に表示されるフィールド (既定値がない場合は null)。出力は、--event-config 入力として直接使用できます。 schema: すべてのフィールドには、型、既定値、制約 (最小、最大、列挙型、パターン) が含まれます。 Draft-07 $ref ポインター (#/definitions/..) は、両方のモードでインラインで解決されます。

プロパティ
指定可能な値: config, schema
--tr --type-ref

型定義 ID または URI。

グローバル パラメーター
--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 ns asset event export

プレビュー

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

イベントをファイルにエクスポートします。

az iot ops ns asset event export --asset
                                 --eg --event-group
                                 --instance
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--format {csv, json, yaml}]
                                 [--od --output-dir]
                                 [--replace {false, true}]

イベントを JSON にエクスポートする

az iot ops ns asset event export --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup

必須のパラメーター

--asset -a

資産名。

--eg --event-group

イベント グループ名。

--instance -i

Azure IoT Operations インスタンスの名前。

--resource-group -g

Azure IoT Operations インスタンスのリソース グループ。

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

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

--acquire-policy-token

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

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

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

プロパティ
パラメーター グループ: Global Policy Arguments
--format -f

ファイル形式をエクスポートします。

プロパティ
規定値: json
指定可能な値: csv, json, yaml
--od --output-dir

エクスポート用の出力ディレクトリ。

プロパティ
規定値: .
--replace

ローカル ファイルが存在する場合は置き換えます。

プロパティ
規定値: False
指定可能な値: 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 ns asset event import

プレビュー

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

ファイルからイベントをインポートします。

az iot ops ns asset event import --asset
                                 --eg --event-group
                                 --if --input-file
                                 --instance
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--replace {false, true}]

JSON ファイルからイベントをインポートする

az iot ops ns asset event import --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --input-file ./events.json

必須のパラメーター

--asset -a

資産名。

--eg --event-group

イベント グループ名。

--if --input-file

インポート ファイル (JSON、YAML、または CSV) へのパス。

--instance -i

Azure IoT Operations インスタンスの名前。

--resource-group -g

Azure IoT Operations インスタンスのリソース グループ。

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

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

--acquire-policy-token

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

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

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

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

名前を共有する既存のイベントをインポートされたイベントに置き換えます。

プロパティ
規定値: False
指定可能な値: 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 ns asset event list

プレビュー

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

IoT Operations 名前空間内の資産イベント グループのイベントを一覧表示します。

az iot ops ns asset event list --asset
                               --eg --event-group
                               --instance
                               --resource-group

イベント グループのすべてのイベントを一覧表示する

az iot ops ns asset event list --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup

必須のパラメーター

--asset -a

資産名。

--eg --event-group

イベント グループ名。

--instance -i

Azure IoT Operations インスタンスの名前。

--resource-group -g

Azure IoT Operations インスタンスのリソース グループ。

グローバル パラメーター
--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 ns asset event remove

プレビュー

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

IoT Operations 名前空間の資産イベント グループからイベントを削除します。

az iot ops ns asset event remove --asset
                                 --eg --event-group
                                 --instance
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]

イベント グループからイベントを削除する

az iot ops ns asset event remove --asset myasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup --name severity

必須のパラメーター

--asset -a

資産名。

--eg --event-group

イベント グループ名。

--instance -i

Azure IoT Operations インスタンスの名前。

--name -n

イベント名。

--resource-group -g

Azure IoT Operations インスタンスのリソース グループ。

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

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

--acquire-policy-token

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

プロパティ
パラメーター グループ: Global Policy Arguments
--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