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
必須のパラメーター
資産名。
イベント グループ名。
Azure IoT Operations インスタンスの名前。
イベント名。
Azure IoT Operations インスタンスのリソース グループ。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
イベントのデータ ソース。
コネクタ固有のイベント構成や宛先を含む JSON/YAML ファイル (.json、.yaml、.yml) へのインライン JSON 文字列またはパス。 受け入れられるキーは、'eventConfiguration' (コネクタ固有の構成オブジェクト) と 'destinations' (宛先オブジェクトの一覧) です。 --show-template を使用して、資産のコネクタの種類でサポートされているキーとスキーマを検出します。 --show-template と組み合わせることはできません。 OPC UA 以外のコネクタの場合、コネクタ テンプレートがインスタンスに存在する必要があります。
同じ名前の別のイベントが既に存在する場合は、イベントを置き換えます。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
資産のコネクタの種類のスターター イベント構成テンプレートを表示し、イベントを変更せずに終了します。 コネクタの種類は、既存の資産から読み取られます。 config: 既定値と共に表示されるフィールド (既定値がない場合は null)。出力は、--event-config 入力として直接使用できます。 schema: すべてのフィールドには、型、既定値、制約 (最小、最大、列挙型、パターン) が含まれます。 Draft-07 $ref ポインター (#/definitions/..) は、両方のモードでインラインで解決されます。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | config, schema |
型定義 ID または URI。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
資産名。
イベント グループ名。
Azure IoT Operations インスタンスの名前。
Azure IoT Operations インスタンスのリソース グループ。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
ファイル形式をエクスポートします。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | csv, json, yaml |
エクスポート用の出力ディレクトリ。
| プロパティ | 値 |
|---|---|
| 規定値: | . |
ローカル ファイルが存在する場合は置き換えます。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
資産名。
イベント グループ名。
インポート ファイル (JSON、YAML、または CSV) へのパス。
Azure IoT Operations インスタンスの名前。
Azure IoT Operations インスタンスのリソース グループ。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
名前を共有する既存のイベントをインポートされたイベントに置き換えます。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
資産名。
イベント グループ名。
Azure IoT Operations インスタンスの名前。
Azure IoT Operations インスタンスのリソース グループ。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
資産名。
イベント グループ名。
Azure IoT Operations インスタンスの名前。
イベント名。
Azure IoT Operations インスタンスのリソース グループ。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |