az iot ops

Note

このリファレンスは、Azure CLI (バージョン 2.53.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で無効にすることができます。

コマンド

名前	説明	型	状態
az iot ops asset	資産管理。	拡張子	プレビュー
az iot ops asset create	資産を作成します。	拡張子	プレビュー
az iot ops asset dataset	資産内のデータセットを管理します。	拡張子	プレビュー
az iot ops asset dataset list	資産内のデータセットを一覧表示します。	拡張子	プレビュー
az iot ops asset dataset point	資産データセット内のデータ ポイントを管理します。	拡張子	プレビュー
az iot ops asset dataset point add	資産データセットにデータ ポイントを追加します。	拡張子	プレビュー
az iot ops asset dataset point export	資産データセット内のデータ ポイントをエクスポートします。	拡張子	プレビュー
az iot ops asset dataset point import	資産データセットにデータ ポイントをインポートします。	拡張子	プレビュー
az iot ops asset dataset point list	資産データセット内のデータ ポイントを一覧表示します。	拡張子	プレビュー
az iot ops asset dataset point remove	資産データセット内のデータ ポイントを削除します。	拡張子	プレビュー
az iot ops asset dataset show	資産内のデータセットを表示します。	拡張子	プレビュー
az iot ops asset delete	資産を削除します。	拡張子	プレビュー
az iot ops asset endpoint	資産エンドポイント プロファイルを管理します。	拡張子	プレビュー
az iot ops asset endpoint create	資産エンドポイント プロファイルを作成します。	拡張子	プレビュー
az iot ops asset endpoint create opcua	OPCUA コネクタを使用して資産エンドポイント プロファイルを作成します。	拡張子	プレビュー
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 broker	Mqtt ブローカーの管理。	拡張子	プレビュー
az iot ops broker authn	ブローカー認証管理。	拡張子	プレビュー
az iot ops broker authn delete	Mqtt ブローカー認証リソースを削除します。	拡張子	プレビュー
az iot ops broker authn list	インスタンスに関連付けられている MQTT ブローカー認証リソースを一覧表示します。	拡張子	プレビュー
az iot ops broker authn show	Mqtt ブローカー認証リソースの詳細を表示します。	拡張子	プレビュー
az iot ops broker authz	ブローカー承認管理。	拡張子	プレビュー
az iot ops broker authz delete	Mqtt ブローカー承認リソースを削除します。	拡張子	プレビュー
az iot ops broker authz list	インスタンスに関連付けられている MQTT ブローカー承認リソースを一覧表示します。	拡張子	プレビュー
az iot ops broker authz show	Mqtt ブローカー承認リソースの詳細を表示します。	拡張子	プレビュー
az iot ops broker delete	mqtt ブローカーを削除します。	拡張子	プレビュー
az iot ops broker list	インスタンスに関連付けられている mqtt ブローカーを一覧表示します。	拡張子	プレビュー
az iot ops broker listener	ブローカー リスナーの管理。	拡張子	プレビュー
az iot ops broker listener delete	mqtt ブローカー リスナーを削除します。	拡張子	プレビュー
az iot ops broker listener list	ブローカーに関連付けられている mqtt ブローカー リスナーを一覧表示します。	拡張子	プレビュー
az iot ops broker listener show	mqtt ブローカー リスナーの詳細を表示します。	拡張子	プレビュー
az iot ops broker show	mqtt ブローカーの詳細を表示します。	拡張子	プレビュー
az iot ops broker stats	dmqtt 実行中の統計を表示します。	拡張子	プレビュー
az iot ops check	デプロイされた IoT Operations サービスのクラスター側の準備とランタイムの正常性を評価します。	拡張子	プレビュー
az iot ops connector	コネクタの管理。	拡張子	プレビュー
az iot ops connector opcua	OPC UA コネクタの管理。	拡張子	プレビュー
az iot ops connector opcua client	OPC UA Broker のエンタープライズ グレードのクライアント アプリケーション インスタンス証明書を管理します。	拡張子	プレビュー
az iot ops connector opcua client add	エンタープライズ グレードのクライアント アプリケーション インスタンス証明書を追加します。	拡張子	プレビュー
az iot ops connector opcua issuer	OPC UA Broker の発行者証明書を管理します。	拡張子	プレビュー
az iot ops connector opcua issuer add	OPC UA Broker の発行者証明書リストに発行者証明書を追加します。	拡張子	プレビュー
az iot ops connector opcua trust	OPC UA Broker の信頼された証明書を管理します。	拡張子	プレビュー
az iot ops connector opcua trust add	信頼された証明書を OPC UA Broker の信頼された証明書の一覧に追加します。	拡張子	プレビュー
az iot ops create	IoT Operations インスタンスを作成します。	拡張子	プレビュー
az iot ops dataflow	データフロー管理。	拡張子	プレビュー
az iot ops dataflow endpoint	データフロー エンドポイントの管理。	拡張子	プレビュー
az iot ops dataflow endpoint list	インスタンスに関連付けられているデータフロー エンドポイント リソースを一覧表示します。	拡張子	プレビュー
az iot ops dataflow endpoint show	データフロー エンドポイント リソースの詳細を表示します。	拡張子	プレビュー
az iot ops dataflow list	データフロー プロファイルに関連付けられているデータフローを一覧表示します。	拡張子	プレビュー
az iot ops dataflow profile	データフロー プロファイルの管理。	拡張子	プレビュー
az iot ops dataflow profile list	インスタンスに関連付けられているデータフロー プロファイルを一覧表示します。	拡張子	プレビュー
az iot ops dataflow profile show	データフロー プロファイルの詳細を表示します。	拡張子	プレビュー
az iot ops dataflow show	データフロー プロファイルに関連付けられているデータフローの詳細を表示します。	拡張子	プレビュー
az iot ops delete	クラスターから IoT 操作を削除します。	拡張子	プレビュー
az iot ops identity	インスタンス ID 管理。	拡張子	プレビュー
az iot ops identity assign	ユーザー割り当てマネージド ID をインスタンスに割り当てます。	拡張子	プレビュー
az iot ops identity remove	インスタンスからユーザー割り当てマネージド ID を削除します。	拡張子	プレビュー
az iot ops identity show	インスタンス ID を表示します。	拡張子	プレビュー
az iot ops init	IoT Operations デプロイ用に Arc 対応クラスターをブートストラップします。	拡張子	プレビュー
az iot ops list	IoT Operations インスタンスを一覧表示します。	拡張子	プレビュー
az iot ops schema	スキーマとレジストリの管理。	拡張子	プレビュー
az iot ops schema create	スキーマ レジストリ内にスキーマを作成します。	拡張子	プレビュー
az iot ops schema delete	スキーマ レジストリ内のターゲット スキーマを削除します。	拡張子	プレビュー
az iot ops schema list	スキーマ レジストリ内のスキーマを一覧表示します。	拡張子	プレビュー
az iot ops schema registry	スキーマ レジストリの管理。	拡張子	プレビュー
az iot ops schema registry create	スキーマ レジストリを作成する。	拡張子	プレビュー
az iot ops schema registry delete	ターゲット スキーマ レジストリを削除します。	拡張子	プレビュー
az iot ops schema registry list	リソース グループまたはサブスクリプション内のスキーマ レジストリを一覧表示します。	拡張子	プレビュー
az iot ops schema registry show	スキーマ レジストリの詳細を表示します。	拡張子	プレビュー
az iot ops schema show	スキーマ レジストリ内のスキーマの詳細を表示します。	拡張子	プレビュー
az iot ops schema show-dataflow-refs	データフローに使用されるスキーマ参照を表示します。	拡張子	プレビュー
az iot ops schema version	スキーマ バージョン管理。	拡張子	プレビュー
az iot ops schema version add	スキーマにスキーマ バージョンを追加します。	拡張子	プレビュー
az iot ops schema version list	特定のスキーマのスキーマ バージョンを一覧表示します。	拡張子	プレビュー
az iot ops schema version remove	ターゲット スキーマ バージョンを削除します。	拡張子	プレビュー
az iot ops schema version show	スキーマ バージョンの詳細を表示します。	拡張子	プレビュー
az iot ops secretsync	インスタンス シークレットの同期管理。	拡張子	プレビュー
az iot ops secretsync disable	インスタンスのシークレット同期を無効にします。	拡張子	プレビュー
az iot ops secretsync enable	インスタンスのシークレット同期を有効にします。	拡張子	プレビュー
az iot ops secretsync list	インスタンスに関連付けられているシークレット同期構成を一覧表示します。	拡張子	プレビュー
az iot ops show	IoT Operations インスタンスを表示します。	拡張子	プレビュー
az iot ops support	IoT Operations は操作をサポートします。	拡張子	プレビュー
az iot ops support create-bundle	トラブルシューティングと診断に使用する標準サポート バンドル zip アーカイブを作成します。	拡張子	プレビュー
az iot ops update	IoT Operations インスタンスを更新します。	拡張子	プレビュー
az iot ops upgrade	IoT Operations インスタンスを最新バージョンにアップグレードします。	拡張子	プレビュー
az iot ops verify-host	IoT Operations デプロイの互換性のためにクラスター ホスト検証のセットを実行します。	拡張子	プレビュー

az iot ops check

プレビュー

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

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

既定では、このコマンドは、すべてのサービスの人間に優しいビューを表示します。 '--svc' オプションを使用して、1 つのサービスのチェックを指定し、 --detail-level 引数を使用して詳細度を構成します。 注: リソースの種類 (--resources) と名前 (--resource-name) のフィルター処理は、'--svc' 引数でのみ使用できます。

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

• deviceregistry.microsoft.com/[v1beta2]
• mqttbroker.iotoperations.azure.com/[v1beta1]
• opcuabroker.iotoperations.azure.com/[v1beta1]
• connectivity.iotoperations.azure.com/[v1beta1]

クラスターの要件の詳細については、 https://aka.ms/iot-ops-cluster-requirementsを確認してください。

az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, broker, dataflow, deviceregistry, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, dataflow, dataflowendpoint, dataflowprofile}]

例

基本的な使用方法。 概要出力を使用して、IoT Operations の全体的な正常性を確認します。

az iot ops check

詳細な出力を使用して、"broker" サービスの正常性と構成を確認します。

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

CI 用に最適化された出力を使用して、"データフロー" サービスのみを評価します。

az iot ops check --svc dataflow --as-object

詳細な出力で 'deviceregistry' の正常性をチェックしますが、結果を "資産" リソースに制限します。

az iot ops check --svc deviceregistry --detail-level 2 --resources asset

リソース名を使用して、'my-asset-' 名プレフィックスを持つ 'asset' リソースに結果を制限する

az iot ops check --svc deviceregistry --resources asset --resource-name 'my-asset-*'

省略可能のパラメーター

--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, broker, dataflow, deviceregistry, opcua

--post

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

指定可能な値: false, true

--pre

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

指定可能な値: false, true

--resource-name --rn

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

--resources

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

指定可能な値: asset, assetendpointprofile, assettype, broker, brokerlistener, dataflow, dataflowendpoint, dataflowprofile

グローバル パラメーター

--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 create

プレビュー

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

IoT Operations インスタンスを作成します。

このコマンドを実行する前に、init を正常に実行する必要があります。

コマンドの結果は、一連の既定のリソースが統合関数用に構成された IoT Operations インスタンスを生成します。

az iot ops create --cluster
                  --name
                  --resource-group
                  --sr-resource-id
                  [--add-insecure-listener {false, true}]
                  [--bp]
                  [--br]
                  [--broker-backend-workers]
                  [--broker-config-file]
                  [--broker-frontend-replicas]
                  [--broker-frontend-workers]
                  [--broker-listener-type {ClusterIp, LoadBalancer, NodePort}]
                  [--broker-mem-profile {High, Low, Medium, Tiny}]
                  [--cluster-namespace]
                  [--custom-location]
                  [--description]
                  [--df-profile-instances]
                  [--enable-rsync {false, true}]
                  [--kubernetes-distro {K3s, K8s, MicroK8s}]
                  [--location]
                  [--no-progress {false, true}]
                  [--ops-config]
                  [--ops-version]
                  [--runtime-socket]
                  [--tags]
                  [--trust-settings]

例

最小入力でターゲット インスタンスを作成します。

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID

次の例では、既定のブローカー インスタンス リソースにカスタマイズを追加し、インスタンスの説明とタグを追加します。

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --broker-mem-profile High --broker-backend-workers 4 --description 'Contoso Factory' --tags tier=testX1

この例では、サービス タイプ ロード バランサーのポート 1883 用に構成されたセキュリティで保護されていない (認証または認証なし) ブローカー リスナーをデプロイする方法を示します。 テストやデモに役立ちます。 運用環境では安全でないオプションを使用しないでください。

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --add-insecure-listener

このフォームでは、インスタンスデプロイのリソース同期を有効にする方法を示します。 リソース同期ロールの割り当てを有効にするには、ターゲット リソース グループに対する書き込みが必要です。

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --enable-rsync

この例では、ユーザーが指定した cert-manager 構成の信頼設定を強調表示します。クラスターは '--user-trust' で初期化されている必要があり、ユーザー証明書マネージャーのデプロイが存在する必要があります。

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --trust-settings configMapName=example-bundle configMapKey=trust-bundle.pem issuerKind=ClusterIssuer issuerName=trust-manager-selfsigned-issuer

必須のパラメーター

--cluster

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

--name -n

IoT Operations インスタンス名。 初期化オーケストレーション中にインスタンスをデプロイするには、インスタンス名を指定する必要があります。

--resource-group -g

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

--sr-resource-id

IoT 操作で使用するスキーマ レジストリ リソース ID。

省略可能のパラメーター

--add-insecure-listener

有効にすると、mqtt ブローカーのデプロイには、サービスの種類 LoadBalancer のリスナーが含まれ、ポート 1883 にバインドされ、authN または authZ はありません。 非運用ワークロードの場合のみ。

指定可能な値: false, true

--bp --broker-backend-part

Mqtt ブローカーのバックエンド パーティション。 最小値: 1、最大値: 16。

規定値: 2

--br --broker-backend-rf

Mqtt ブローカーバックエンド冗長係数。 最小値: 1、最大値: 5。

規定値: 2

--broker-backend-workers --bw

Mqtt ブローカー バックエンド ワーカー。 最小値: 1、最大値: 16。

規定値: 2

--broker-config-file

カスタム ブローカー構成プロパティを持つ json ファイルへのパス。 ファイル構成コンテンツは、個々のブローカー構成パラメーターに対して使用されます。 高度なシナリオに役立ちます。 想定される形式については、 https://aka.ms/aziotops-broker-configで説明します。

--broker-frontend-replicas --fr

Mqtt ブローカー フロントエンド レプリカ。 最小値: 1、最大値: 16。

規定値: 2

--broker-frontend-workers --fw

Mqtt ブローカー フロントエンド ワーカー。 最小値: 1、最大値: 16。

規定値: 2

--broker-listener-type --lt

既定の mqtt ブローカー リスナーに関連付けられているサービスの種類。

指定可能な値: ClusterIp, LoadBalancer, NodePort

規定値: ClusterIp

--broker-mem-profile --mp

Mqtt ブローカーのメモリ プロファイル。

指定可能な値: High, Low, Medium, Tiny

規定値: Medium

--cluster-namespace

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

規定値: azure-iot-operations

--custom-location

IoT Operations デプロイに対応するカスタムの場所の名前。 既定値は 'location-{hash(5)}' の形式です。

--description

IoT Operations インスタンスの説明。

--df-profile-instances

既定のデータフロー プロファイルに関連付けられているインスタンス数。

規定値: 1

--enable-rsync

リソース同期規則は、IoT Operations のデプロイに含まれます。

指定可能な値: false, true

--kubernetes-distro

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

指定可能な値: K3s, K8s, MicroK8s

規定値: K8s

--location

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

--no-progress

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

指定可能な値: false, true

--ops-config

IoT Operations Arc 拡張機能のカスタム構成。 形式はスペース区切りのキーと値のペアです。 --ops-config は 1 回以上使用できます。 高度なユース ケースの場合。

--ops-version

非推奨

引数 'ops_version' は非推奨となり、今後のリリースで削除される予定です。

組み込みの IoT Operations Arc 拡張機能のバージョンをオーバーライドするために使用します。

--runtime-socket

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

--tags

インスタンス タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。 --tags "" を使用して、すべてのタグを削除します。

--trust-settings

ユーザーが指定した信頼バンドルの設定。 コンポーネント TLS に使用されます。 形式はスペース区切りのキーと値のペアです。 次のキーが必要です: configMapKey、 configMapName、 issuerName、 issuerKind。 使用しない場合は、システム提供の自己署名信頼バンドルが構成されます。

グローバル パラメーター

--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 delete

プレビュー

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

クラスターから IoT 操作を削除します。

インスタンスまたはクラスターの名前を指定する必要があります。

この操作では、Azure Resource Graph を使用して、関連付けられたリソースを決定します。 リソース グラフの最終的な整合性は、実行時の同期状態を保証するものではありません。

az iot ops delete --resource-group
                  [--cluster]
                  [--force {false, true}]
                  [--include-deps {false, true}]
                  [--name]
                  [--no-progress {false, true}]
                  [--yes {false, true}]

例

完全な削除のための最小入力。

az iot ops delete -n myinstance -g myresourcegroup

確認プロンプトをスキップし、削除プロセスに進みます。 CI シナリオに役立ちます。

az iot ops delete -n myinstance -g myresourcegroup -y

警告に関係なく強制的に削除します。 エラーが発生する可能性があります。

az iot ops delete -n myinstance -g myresourcegroup --force

参照にはインスタンスの代わりにクラスター名を使用します。

az iot ops delete --cluster mycluster -g myresourcegroup

init の逆アプリケーション。

az iot ops delete -n myinstance -g myresourcegroup --include-deps

必須のパラメーター

--resource-group -g

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

省略可能のパラメーター

--cluster

IoT 操作の削除のターゲット クラスター名。

--force

操作を強制的に実行します。

指定可能な値: false, true

--include-deps

コマンドが IoT 操作の依存関係を削除する必要があることを示します。 このオプションは、init の適用を元に戻すことを目的としています。

指定可能な値: false, true

--name -n

IoT Operations インスタンス名。

--no-progress

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

指定可能な値: false, true

--yes -y

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

指定可能な値: 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 を使います。

az iot ops init

プレビュー

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

IoT Operations デプロイ用に Arc 対応クラスターをブートストラップします。

IoT 操作をデプロイするには、Arc 対応クラスターが必要です。 https://aka.ms/aziotops-arcconnectの詳細については、次のリソースを参照してください。

init 操作は、IoT Operations のデプロイに必要なエッジ サービスの基盤レイヤーのインストールと構成で機能します。

基盤レイヤーがインストールされたら、 az iot ops create コマンドを使用してインスタンスをデプロイする必要があります。

az iot ops init --cluster
                --resource-group
                [--enable-fault-tolerance {false, true}]
                [--ensure-latest {false, true}]
                [--no-progress {false, true}]
                [--user-trust {false, true}]

例

最小入力での使用法。 このフォームでは、IoT Operations 基盤レイヤーがデプロイされます。

az iot ops init --cluster mycluster -g myresourcegroup

前の例と同様ですが、Arc Container Storage のフォールト トレランスが有効になっています (少なくとも 3 つのノードが必要)。

az iot ops init --cluster mycluster -g myresourcegroup --enable-fault-tolerance

この例では、カスタム cert-manager 構成でユーザー信頼設定を有効にする方法について説明します。これにより、システム証明書マネージャーと trust-manager の展開はスキップされます。

az iot ops init --cluster mycluster -g myresourcegroup --user-trust

必須のパラメーター

--cluster

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

--resource-group -g

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

省略可能のパラメーター

--enable-fault-tolerance

Azure Arc コンテナー ストレージのフォールト トレランスを有効にします。 少なくとも 3 つのクラスター ノードが必要です。

指定可能な値: false, true

--ensure-latest

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

指定可能な値: false, true

--no-progress

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

指定可能な値: false, true

--user-trust --ut

ユーザー指定の構成を優先して、システム証明書マネージャーと trust-manager の展開をスキップします。

指定可能な値: 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 を使います。

az iot ops list

プレビュー

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

IoT Operations インスタンスを一覧表示します。

目的の JMESPath 構文で --query を使用して結果を照会します。

az iot ops list [--resource-group]

例

サブスクリプション内のすべてのインスタンスを一覧表示します。

az iot ops list

特定のリソース グループのすべてのインスタンスを一覧表示します。

az iot ops list -g myresourcegroup

特定のタグ値を持つサブスクリプション内のインスタンスを一覧表示します。

az iot ops list -g myresourcegroup --query "[?tags.env == 'prod']"

省略可能のパラメーター

--resource-group -g

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

グローバル パラメーター

--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 show

プレビュー

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

IoT Operations インスタンスを表示します。

必要に応じて、このコマンドは、バッキング クラスターに対する IoT 操作のデプロイを表す関連付けられたリソースのツリー構造を出力できます。 このコマンドが失敗した場合は、 az iot ops upgrade を使用してインスタンスを最新バージョンにアップグレードしてから続行してください。

az iot ops show --name
                --resource-group
                [--tree {false, true}]

例

インスタンスを表示するための基本的な使用方法。

az iot ops show --name myinstance -g myresourcegroup

IoT Operations デプロイを表す関連リソースのツリー構造を出力します。

az iot ops show --name myinstance -g myresourcegroup --tree

必須のパラメーター

--name -n

IoT Operations インスタンス名。

--resource-group -g

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

省略可能のパラメーター

--tree

バッキング クラスターに対する IoT 操作のデプロイを視覚化するために使用します。

指定可能な値: 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 を使います。

az iot ops update

プレビュー

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

IoT Operations インスタンスを更新します。

現在、インスタンスのタグと説明は更新できます。 インスタンスを新しいバージョンにアップグレードする場合は、代わりに az iot ops upgrade を使用してください。

az iot ops update --name
                  --resource-group
                  [--description]
                  [--tags]

例

インスタンス タグを更新します。 これは置換と同じです。

az iot ops update --name myinstance -g myresourcegroup --tags a=b c=d

インスタンス タグを削除します。

az iot ops update --name myinstance -g myresourcegroup --tags ""

インスタンスの説明を更新します。

az iot ops update --name myinstance -g myresourcegroup --desc "Fabrikam Widget Factory B42"

必須のパラメーター

--name -n

IoT Operations インスタンス名。

--resource-group -g

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

省略可能のパラメーター

--description

IoT Operations インスタンスの説明。

--tags

インスタンス タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。 --tags "" を使用して、すべてのタグを削除します。

グローバル パラメーター

--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 upgrade

プレビュー

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

IoT Operations インスタンスを最新バージョンにアップグレードします。

警告: このコマンドは失敗する可能性があり、クラスターとインスタンスを削除して再作成する必要があります。

拡張機能を最新バージョンに更新するなど、IoT Operations インスタンスをアップグレードします。 az iot ops showまたは同様のコマンドが失敗した場合は、このコマンドを使用します。

スキーマ レジストリ リソース ID は省略可能なパラメーターであり、特定のシナリオで必要になる場合があります。

az iot ops upgrade --name
                   --resource-group
                   [--no-progress {false, true}]
                   [--sr-resource-id]
                   [--yes {false, true}]

例

最小限の入力でインスタンスをアップグレードします。

az iot ops upgrade --name myinstance -g myresourcegroup

インスタンスのアップグレード中に、準拠プロンプトをスキップします。

az iot ops upgrade --name myinstance -g myresourcegroup -y

インスタンスをアップグレードし、スキーマ レジストリ リソース ID を指定します。

az iot ops upgrade --name myinstance -g myresourcegroup --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID

必須のパラメーター

--name -n

IoT Operations インスタンス名。

--resource-group -g

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

省略可能のパラメーター

--no-progress

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

指定可能な値: false, true

--sr-resource-id

IoT 操作で使用するスキーマ レジストリ リソース ID。 IoT 操作内でスキーマ レジストリ リソース ID が見つからない場合に必要です。

--yes -y

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

指定可能な値: 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 を使います。

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