az iot ops

プレビュー
リファレンス

Note

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

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

Azure IoT 操作を管理します。

Azure IoT Operations は、オンプレミスの資産から産業グレードの MQTT ブローカーにデータを集計し、エッジコンピューティングを追加し、クラウドのさまざまなサービスを使用して双方向データフローを設定できるようにする、高度に調整された疎結合のファーストパーティ Kubernetes サービスのセットです。

既定では、IoT Operations CLI コマンドは定期的にチェックされ、新しい拡張機能バージョンが使用可能かどうかを確認します。この動作は az config set iotops.check_latest=false、

コマンド

名前	説明	型	Status
az iot ops asset	資産を管理する。	拡張子	プレビュー
az iot ops asset create	資産を作成します。	拡張子	プレビュー
az iot ops asset data-point	資産内のデータポイントを管理します。	拡張子	プレビュー
az iot ops asset data-point add	資産にデータポイントを追加します。	拡張子	プレビュー
az iot ops asset data-point export	資産内のデータポイントをエクスポートします。	拡張子	プレビュー
az iot ops asset data-point import	資産内のデータポイントをインポートします。	拡張子	プレビュー
az iot ops asset data-point list	資産内のデータポイントを一覧表示します。	拡張子	プレビュー
az iot ops asset data-point remove	資産内のデータポイントを削除します。	拡張子	プレビュー
az iot ops asset delete	資産を削除します。	拡張子	プレビュー
az iot ops asset endpoint	資産エンドポイントプロファイルを管理します。	拡張子	プレビュー
az iot ops asset endpoint certificate	資産エンドポイントで所有されている証明書を管理します。	拡張子	プレビュー
az iot ops asset endpoint certificate add	資産エンドポイントに所有証明書を追加します。	拡張子	プレビュー
az iot ops asset endpoint certificate list	資産エンドポイント内の所有証明書を一覧表示します。	拡張子	プレビュー
az iot ops asset endpoint certificate remove	資産エンドポイント内の所有証明書を削除します。	拡張子	プレビュー
az iot ops asset endpoint create	資産エンドポイントを作成します。	拡張子	プレビュー
az iot ops asset endpoint delete	資産エンドポイントを削除します。	拡張子	プレビュー
az iot ops asset endpoint query	リソースグラフに対して資産エンドポイントのクエリを実行します。	拡張子	プレビュー
az iot ops asset endpoint show	資産エンドポイントを表示します。	拡張子	プレビュー
az iot ops asset endpoint update	資産エンドポイントを更新します。	拡張子	プレビュー
az iot ops asset event	資産内のイベントを管理します。	拡張子	プレビュー
az iot ops asset event add	資産にイベントを追加します。	拡張子	プレビュー
az iot ops asset event export	資産内のイベントをエクスポートします。	拡張子	プレビュー
az iot ops asset event import	資産にイベントをインポートします。	拡張子	プレビュー
az iot ops asset event list	資産内のイベントを一覧表示します。	拡張子	プレビュー
az iot ops asset event remove	資産内のイベントを削除します。	拡張子	プレビュー
az iot ops asset query	リソースグラフに資産のクエリを実行します。	拡張子	プレビュー
az iot ops asset show	資産を表示します。	拡張子	プレビュー
az iot ops asset update	資産を更新します。	拡張子	プレビュー
az iot ops check	デプロイされた IoT Operations サービスのクラスター側ランタイムの正常性を評価します。	拡張子	プレビュー
az iot ops init	ターゲットのアーク対応クラスターに IoT 操作をブートストラップ、構成、デプロイします。	拡張子	プレビュー
az iot ops mq	MQ 固有のツール。	拡張子	プレビュー
az iot ops mq get-password-hash	PBKDF2-HMAC-SHA512 を適用するパスフレーズの PBKDF2 ハッシュを生成します。 os.urandom から 128 ビットのソルトが使用されます。	拡張子	プレビュー
az iot ops mq stats	dmqtt 実行中の統計を表示します。	拡張子	プレビュー
az iot ops support	IoT 操作では、コマンド領域がサポートされます。	拡張子	プレビュー
az iot ops support create-bundle	トラブルシューティングと診断に使用する標準サポートバンドル zip アーカイブを作成します。	拡張子	プレビュー
az iot ops verify-host	IoT Operations デプロイの互換性のためにクラスターホスト検証のセットを実行します。	拡張子	プレビュー

az iot ops check

プレビュー

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

デプロイされた IoT Operations サービスのクラスター側ランタイムの正常性を評価します。

既定では、このコマンドは、選択したサービスのわかりやすい概要ビューを表示します。詳細は、経由で --detail-level要求することができます.

{サポートされているサービス API}

akri.sh/[v0]
dataprocessor.iotoperations.azure.com/[v1]
deviceregistry.microsoft.com/[v1beta1]
layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
mq.iotoperations.azure.com/[v1beta1]
opcuabroker.iotoperations.azure.com/[v1beta1]。

az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, dataprocessor, deviceregistry, lnm, mq, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline}]

例

基本的な使用方法。要約出力で 'mq' の正常性をチェックします。

az iot ops check

前の例と同様に 'mq' を評価しますが、出力は CI 用に最適化されています。

az iot ops check --as-object

"dataprocessor" の正常性と構成を詳細な出力で確認します。

az iot ops check --svc dataprocessor --detail-level 1

前の例と同じですが、結果を "パイプライン" リソースに制限する点が異なります。

az iot ops check --svc dataprocessor --detail-level 1 --resources pipeline

リソース名を使用して、結果を "パイプライン" リソースと正確に一致する名前 'pipeline' に制限します。

az iot ops check --svc dataprocessor  --resources pipeline --resource-name pipeline

リソース名を使用して、'pipeline-name' で始まるリソース名に結果を制限します。

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline-name*

'?' glob パターンを使用して、結果を 'pipeline' を含み、1 文字で終わるリソース名に制約します。

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline?

省略可能のパラメーター

--as-object

CI フレンドリデータ構造チェックコンテンツと検証を出力します。

承認された値: false, true

--context

k8s クラスター通信に使用する Kubeconfig コンテキスト名。コンテキストが指定されていない場合は、current_contextが使用されます。

--detail-level

チェック出力に表示される詳細レベルを制御します。概要ビュー (最小出力) には 0、詳細ビュー (より包括的な情報) には 1、詳細ビュー (使用可能なすべての情報) には 2 を選択します。

承認された値: 0, 1, 2

既定値: 0

--ops-service --svc

評価される IoT Operations サービスのデプロイ。

承認された値: akri, dataprocessor, deviceregistry, lnm, mq, opcua

既定値: mq

--post

デプロイ後のチェックを実行します。

承認された値: false, true

--pre

前提条件のチェックを実行して、サービスデプロイの最小要件が満たされているかどうかを判断します。

承認された値: false, true

--resource-name --rn

特定のリソース名に対してのみチェックを実行します。名前の大文字と小文字は区別されます。 Glob パターン '' と '?' がサポートされています。注: 英数字、ハイフン、'?' および '' のみを使用できます。

--resources

特定のリソースの種類に対してのみチェックを実行します。スペース区切りの値を使用します。

承認された値: asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline

グローバルパラメーター

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

プレビュー

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

ターゲットのアーク対応クラスターに IoT 操作をブートストラップ、構成、デプロイします。

クラスターをアーク有効化する方法を含むその他のリソースについては、次を参照してください https://learn.microsoft.com/en-us/azure/iot-operations/deploy-iot-ops/howto-prepare-cluster。

az iot ops init --cluster
                --resource-group
                [--ca-dir]
                [--ca-file]
                [--ca-key-file]
                [--ca-valid-days]
                [--cluster-namespace]
                [--context]
                [--csi-driver-ver]
                [--custom-location]
                [--disable-rotation {false, true}]
                [--disable-rsync-rules {false, true}]
                [--dp-instance]
                [--ensure-latest {false, true}]
                [--kubernetes-distro {k3s, k8s, microk8s}]
                [--kv-id]
                [--kv-spc-secret-name]
                [--location]
                [--mq-authn]
                [--mq-backend-part]
                [--mq-backend-rf]
                [--mq-backend-workers]
                [--mq-broker]
                [--mq-frontend-replicas]
                [--mq-frontend-server]
                [--mq-frontend-workers]
                [--mq-insecure {false, true}]
                [--mq-instance]
                [--mq-listener]
                [--mq-mem-profile {high, low, medium, tiny}]
                [--mq-mode {auto, distributed}]
                [--mq-service-type {clusterIp, loadBalancer, nodePort}]
                [--no-block {false, true}]
                [--no-deploy {false, true}]
                [--no-progress {false, true}]
                [--no-tls {false, true}]
                [--opcua-discovery-url]
                [--rotation-int]
                [--runtime-socket]
                [--show-template {false, true}]
                [--simulate-plc {false, true}]
                [--sp-app-id]
                [--sp-object-id]
                [--sp-secret]
                [--sp-secret-valid-days]
                [--target]

例

セットアップを完了するための最小入力。これには、Key Vault の構成、CSI ドライバーのデプロイ、TLS 構成、IoT 操作のデプロイが含まれます。

az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvault

デプロイの一部としてシミュレートされた PLC サーバーを含める既存のアプリ ID とフラグの使用を除き、前の例と同じセットアップ。アプリ ID を含めると、'init' がアプリ登録を作成できなくなります。

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --simulate-plc

デプロイをスキップし、Key Vault CSI ドライバーと TLS 構成ワークフローのみに焦点を当てるには、'--no-deploy' で単純なパスを渡します。これは、ポータルなどの別のツールからデプロイする場合に便利です。

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-deploy

既に準備されているクラスターにのみ IoT Operations をデプロイするには、'--kv-id' を省略し、'--no-tls' を含めます。

az iot ops init --cluster mycluster -g myresourcegroup --no-tls

'--no-block' を使用して、デプロイが進行中の間に他の作業を行い、デプロイが完了するのを待ってから他の作業を開始します。

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-block

AZ cli サービスプリンシパルへのログインアクセス許可が制限されている、または既存のサービスプリンシパルを再利用する必要がある CI シナリオなど、MS Graph の呼び出しを回避するには、すべての '--sp-app-id'、'--sp-object-id'、'--sp-secret' を指定します。これらの値には、Key Vault CSI ドライバーのセットアップに使用される目的のサービスプリンシパルが反映されている必要があります。

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --sp-object-id 224a7a3f-c63d-4923-8950-c4a85f0d2f29 --sp-secret $SP_SECRET

必須のパラメーター

--cluster

IoT Operations デプロイのターゲットクラスター名。

--resource-group -g

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

省略可能のパラメーター

--ca-dir

生成されたテスト CA と秘密キーが配置されるローカルディレクトリ。ディレクトリが指定されていない場合、ファイルはディスクに書き込まれなくなります。 --ca-file と --ca-key-file が指定されていない場合に適用されます。

--ca-file

PEM 形式の目的の CA ファイルへのパス。

--ca-key-file

PEM 形式の CA 秘密キーファイルへのパス。 !必須！ --ca-file が指定されている場合。

--ca-valid-days

init によって生成された x509 CA の期間を日数で制御するオプション。 --ca-file と --ca-key-file が指定されていない場合に適用されます。

既定値: 365

--cluster-namespace

クラスター名前空間 IoT Operations インフラストラクチャがデプロイされます。小文字にする必要があります。

既定値: azure-iot-operations

--context

k8s クラスター通信に使用する Kubeconfig コンテキスト名。コンテキストが指定されていない場合は、current_contextが使用されます。

--csi-driver-ver

CSI ドライバーのバージョン。

既定値: 1.5.2

--custom-location

IoT Operations デプロイに対応するカスタムの場所の名前。既定値は '{cluster_name}-ops-init-cl' の形式です。

--disable-rotation

シークレットローテーションを無効にするフラグ。

承認された値: false, true

--disable-rsync-rules

リソース同期規則はデプロイに含まれません。

承認された値: false, true

--dp-instance

データプロセッサのインスタンス名。既定値は '{cluster_name}-ops-init-processor' の形式です。

--ensure-latest

最新の IoT Ops CLI がインストールされていることを確認し、アップグレードが使用可能な場合はエラーが発生します。

承認された値: false, true

--kubernetes-distro

Akri 構成に使用する Kubernetes ディストリビューション。選択したディストリビューションは、--runtime-socket 値が指定されていない場合の既定のコンテナーランタイムソケットパスを意味します。

承認された値: k3s, k8s, microk8s

既定値: k8s

--kv-id

Key Vault ARM リソース ID。このリソース ID を指定すると、クライアントは必要なすべてのリソースとクラスター側の構成を設定して、IoT 操作用の Key Vault CSI ドライバーを有効にすることができます。

--kv-spc-secret-name

既定の SPC シークレット として使用する Key Vault シークレット名 。シークレットが存在しない場合は、暗号化によってセキュリティで保護されたプレースホルダー値を使用して作成されます。

既定値: azure-iot-operations

--location

プロビジョニングされた RPSaaS 担保に使用される ARM の場所。指定しない場合は、接続されたクラスターの場所が使用されます。

--mq-authn

mq authN 名。既定値は "authn" です。

--mq-backend-part

MQ バックエンドパーティション。

既定値: 2

--mq-backend-rf

MQ バックエンド冗長係数。

既定値: 2

--mq-backend-workers

MQ バックエンドワーカー。

既定値: 2

--mq-broker

mq ブローカー名。既定値は 'broker' です。

--mq-frontend-replicas

MQ フロントエンドレプリカ。

既定値: 2

--mq-frontend-server

mq フロントエンドサーバー名。既定値は 'mq-dmqtt-frontend' です。

--mq-frontend-workers

MQ フロントエンドワーカー。

既定値: 2

--mq-insecure

有効にすると、mq デプロイには、authN または authZ のないポート 1883 にバインドされたリスナーが含まれます。ブローカーの encryptInternalTraffic 設定は false に設定されます。非運用ワークロードの場合のみ。

承認された値: false, true

--mq-instance

mq インスタンス名。既定値は 'init-{hash}-mq-instance' の形式です。

--mq-listener

mq リスナー名。既定値は 'listener' です。

--mq-mem-profile

MQ メモリプロファイル。

承認された値: high, low, medium, tiny

既定値: medium

--mq-mode

MQ モードの操作。

承認された値: auto, distributed

既定値: distributed

--mq-service-type

MQ サービスの種類。

承認された値: clusterIp, loadBalancer, nodePort

既定値: clusterIp

--no-block

IoT Operations のデプロイが開始された直後に戻ります。

承認された値: false, true

--no-deploy

IoT Operations デプロイワークフローはスキップされます。

承認された値: false, true

--no-progress

init 進行状況バーを無効にします。

承認された値: false, true

--no-tls

TLS 構成ワークフローはスキップされます。

承認された値: false, true

--opcua-discovery-url

Akri 検出ハンドラーの OPC-UA サーバーエンドポイントを構成します。指定されず、--simulate-plc が設定されている場合、この値は "opc.tcp://opcplc-000000" になります。{cluster_namespace}:50000'.

--rotation-int

回転ポーリング間隔。

既定値: 1h

--runtime-socket

コンテナーランタイムソケットの既定のノードパス。指定しない場合 (既定)、ソケットパスは --kubernetes-distro によって決定されます。

--show-template

設定時にフラグを設定すると、デプロイを目的としたテンプレートが出力されます。

承認された値: false, true

--simulate-plc

設定時にフラグを設定すると、PLC サーバーを起動するように OPC-UA ブローカーインストーラーが構成されます。

承認された値: false, true

--sp-app-id

サービスプリンシパルアプリ ID。指定された場合は、CSI ドライバーのセットアップに使用されます。それ以外の場合は、アプリの登録が作成されます。 ログに記録されたプリンシパルにグラフを照会するためのアクセス許可がない場合に必要 です。

--sp-object-id

サービスプリンシパル (sp) オブジェクト ID。指定された場合は、CSI ドライバーのセットアップに使用されます。それ以外の場合、オブジェクト ID はアプリ ID から照会されます。sp が存在しない場合は sp を作成します。 ログに記録されたプリンシパルにグラフを照会するためのアクセス許可がない場合に必要 です。適切なオブジェクト ID を生成するために使用 az ad sp show --id <app Id> --query id -o tsv します。または、ポータルを使用して、Entra Id テナントのエンタープライズアプリケーションに移動することもできます。

--sp-secret

指定されたサービスプリンシパルアプリ ID に対応するシークレット。指定された場合は、CSI ドライバーのセットアップに使用されます。それ以外の場合は、新しいシークレットが作成されます。 ログに記録されたプリンシパルにグラフを照会するためのアクセス許可がない場合に必要 です。

--sp-secret-valid-days

初期化によって生成されたサービスプリンシパルシークレットの期間を日数で制御するオプション。 --sp-secret が指定されていない場合に適用されます。

既定値: 365

--target

ops オーケストレーターのターゲット名。既定値は '{cluster_name}-ops-init-target' の形式です。

グローバルパラメーター

--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 ops verify-host

プレビュー

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

IoT Operations デプロイの互換性のためにクラスターホスト検証のセットを実行します。

ターゲットクラスターホストで直接実行することを目的としています。このコマンドでは、依存関係のインストールなどの一連の特権アクションの適用を求めるメッセージが表示される場合があります。この場合、CLI は管理者特権で実行する必要があります。たとえば、「 sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host 」のように指定します。

az iot ops verify-host [--no-progress {false, true}]

省略可能のパラメーター

--no-progress

作業の視覚的表現を無効にします。

承認された値: false, true

グローバルパラメーター

--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 を使います。

Share via

az iot ops

コマンド

az iot ops check

例

省略可能のパラメーター

az iot ops init

例

必須のパラメーター

省略可能のパラメーター

az iot ops verify-host

省略可能のパラメーター

フィードバック

その他のリソース