az iot ops live-data
Note
このリファレンスは、Azure CLI (バージョン 2.70.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops live-data コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Operations インスタンスのライブ データ インフラストラクチャの構成。
プレビュー ランタイムが必要です。 有効にするには、準備完了ランタイムが必要です。表示と無効化は、異常なプレビュー ランタイムの診断とクリーンアップで引き続き使用できます。
コマンド
| Name | 説明 | 型 | 状態 |
|---|---|---|---|
| az iot ops live-data disable |
IoT Operations インスタンスのライブ データを無効にします。 |
拡張機能 | Preview |
| az iot ops live-data enable |
IoT Operations インスタンスのライブ データを有効にします。 |
拡張機能 | Preview |
| az iot ops live-data show |
IoT Operations インスタンスのライブ データ構成を表示します。 |
拡張機能 | Preview |
az iot ops live-data disable
コマンド グループ "iot ops live-data" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Operations インスタンスのライブ データを無効にします。
専用データフロー プロファイル、EG データフロー エンドポイント、および可観測性トピック領域を破棄し、最後に Device Registry 名前空間からこのインスタンスの可観測性エンドポイント エントリを削除して、中断された無効化を安全に再実行できるようにします。 このインスタンスのエントリが最後に削除された場合でも、名前空間全体の可観測性が有効なフラグと、他のインスタンスに属するエンドポイント エントリを保持します。 カスタムの場所のリソース ID は、大文字と小文字が区別されずに照合されます。
ADR 参照または名前空間がない場合、インスタンス所有リソースのクリーンアップは続行されます。 Event Grid 名前空間が見つからない場合は、手動クリーンアップが必要になる可能性があるトピック領域が警告によって識別されます。
Event Grid 名前空間スコープのマネージド ID ロールの割り当ては保持されます。topic-space スコープのマネージド ID の割り当ては、トピック領域と共に削除されます。 --user-object-id に対して作成されたリーダーの割り当ては、常にデバイス レジストリ名前空間にスコープ設定され、--ra-scope の影響を受けず、保持されます。 明示的なクリーンアップが必要な場合は、enable によって返される割り当て ID を使用します。
az iot ops live-data disable --instance
--resource-group
[--acquire-policy-token]
[--change-reference]
[--no-progress {false, true}]
[--yes {false, true}]
例
インスタンスのライブ データを無効にします。
az iot ops live-data disable --instance myinstance -g myresourcegroup
確認プロンプトなしでライブ データを無効にします。
az iot ops live-data disable --instance myinstance -g myresourcegroup --yes
必須パラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
作業の視覚的表現を無効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 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 live-data enable
コマンド グループ "iot ops live-data" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Operations インスタンスのライブ データを有効にします。
次の 3 つのドメインにわたって、Live Data に必要な共有のインスタンス レベルのインフラストラクチャをプロビジョニングして構成します。
- Event Grid 名前空間: 可観測性のトピック空間。
- IoT Operations Instance: 専用のデータフロー プロファイルと EG MQTT データフロー エンドポイント。
- デバイス レジストリ名前空間: 送信 ID とインスタンスごとの監視エンドポイント エントリ (インスタンスのカスタムの場所によってキー付け)。
コマンドはべき等です。 再実行は、関連のないエントリを上書きすることなく、目的の状態に収束します。 名前空間の可観測性を true に設定し、インスタンスの可観測性エンドポイント エントリを追加します。 インスタンスごとの有効化は、名前空間全体のフラグではなく、そのエントリとサポート リソース構成によって決まります。 リソースが作成される前に、ADR の前提条件が検証されます。 既存の Live Data トピック テンプレートとデータフロー プロファイル設定は、再有効化時に調整されます。 ADR 送信 ID は名前空間全体です。 他の可観測性または管理エンドポイントが名前空間を共有する場合は、既存の ID を再利用します。変更は拒否され、これらのエンドポイントが中断されないようにします。
既定では、ロールの割り当て (インスタンス ID の場合は Event Grid TopicSpaces Publisher、ADR 名前空間 ID の場合はサブスクライバー) は Event Grid 名前空間スコープで作成されます。 トピック領域をスコープとする最小特権の割り当てには --ra-scope topic-space を使用し、ロールの割り当ての作成をスキップするには --skip-ra を使用します。
--user-object-ids を使用して、Device Registry 名前空間スコープのリソース テナントから 1 人以上のMicrosoft Entra ユーザーに直接閲覧者を付与します。 これらの割り当ては加法、べき等、--ra スコープの影響を受けず、無効化時に保持されます。 このコマンドは、明示的なクリーンアップのために割り当て ID を返します。 --skip-ra が優先され、これらの割り当てがスキップされます。 グループベースの承認が使用できない場合は、パブリック プレビュー中に個々のユーザー割り当てが必要です。
az iot ops live-data enable --eg-resource-id
--instance
--resource-group
[--acquire-policy-token]
[--adr-role-ids]
[--change-reference]
[--mi-user-assigned]
[--no-progress {false, true}]
[--ops-role-ids]
[--ra-scope {namespace, topic-space}]
[--skip-ra {false, true}]
[--user-object-ids]
例
システム割り当てマネージド ID と既定のロールを使用して Live Data を有効にします。
az iot ops live-data enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID
送信認証に対してユーザー割り当てマネージド ID を使用して Live Data を有効にします。
az iot ops live-data enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --mi-user-assigned $UA_MI_RESOURCE_ID
最小限の特権を持つトピック領域スコープロールの割り当てで Live Data を有効にします。
az iot ops live-data enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --ra-scope topic-space
ライブ データを有効にし、閲覧者に直接Microsoft Entraユーザーに付与します。
az iot ops live-data enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --user-object-ids $USER_OBJECT_ID_1 $USER_OBJECT_ID_2
ライブ データを有効にし、ロールの割り当てをスキップします。
az iot ops live-data enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --skip-ra
必須パラメーター
Event Grid 名前空間 ARM リソース ID。
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
EG 名前空間に対する ADR 名前空間 ID (サブスクライバー) のカスタム ロール ID。 既定値: 'Event Grid TopicSpaces サブスクライバー'。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Role Assignment Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
EG データフロー エンドポイントと ADR 名前空間の送信 ID のユーザー割り当てマネージド ID リソース ID。 既定値: システム割り当てマネージド ID。
作業の視覚的表現を無効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
EG 名前空間に対する AIO インスタンス ID (Publisher) のカスタム ロール ID。 既定値: 'Event Grid TopicSpaces Publisher'。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Role Assignment Arguments |
Event Grid ロールの割り当てのスコープ。 'namespace' (既定値) は EG 名前空間で割り当て、無効化時に保持されます。'topic-space' は、トピック領域リソース (最小特権) で割り当てられ、トピック領域が無効になっている状態で削除されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Role Assignment Arguments |
| 指定可能な値: | namespace, topic-space |
使用すると、操作のロールの割り当て手順がスキップされます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Role Assignment Arguments |
| 指定可能な値: | false, true |
リソース テナントからユーザー オブジェクト ID をMicrosoft Entraして、Device Registry 名前空間に Reader を付与します。 割り当ては加法であり、無効化時に保持されます。 --skip-ra が使用されている場合は無視されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Role Assignment 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 |
az iot ops live-data show
コマンド グループ "iot ops live-data" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Operations インスタンスのライブ データ構成を表示します。
Device Registry 名前空間、Event Grid、IoT Operations データフロー リソース全体のライブ データ構成とリソースの状態を報告します。 最上位レベルの有効フラグは、このインスタンスの可観測性エンドポイント エントリが存在し、すべてのサポート リソースが存在する場合にのみ true です。 名前空間全体の可観測性が有効なフラグは、情報について報告され、インスタンスごとの有効化は決定されません。 トピック テンプレート、専用プロファイル設定、エンドポイントの種類、ホスト、認証、クライアント ID プレフィックス、TLS モードも Live Data 構成と一致する必要があります。 エンドポイントの状態には、構成済みのフラグが含まれます。 ユーザー割り当て認証の場合、検証では、参照されるマネージド ID のクライアント ID とテナント ID も読み取られます。 Device Registry 名前空間の状態には、Live Data Enable の外部で作成された割り当てなど、名前空間スコープでの直接ユーザー 閲覧者割り当てのプリンシパル ID と割り当て ID を持つ userReaderAssignment が含まれます。 継承された割り当てとグループ割り当ては除外されます。 この一覧を読むには、Microsoftが必要です。Authorization/roleAssignments/read;承認エラーまたはサービス エラーは、空のリストとして報告されるのではなく、表示されます。
az iot ops live-data show --instance
--resource-group
[--no-progress {false, true}]
例
インスタンスのライブ データ構成を表示します。
az iot ops live-data show --instance myinstance -g myresourcegroup
必須パラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
作業の視覚的表現を無効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 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 |