az iot ops asset endpoint

Note

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

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

資産エンドポイント プロファイルを管理します。

コマンド

名前	説明	型	Status
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 endpoint create

プレビュー

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

資産エンドポイントを作成します。

カスタムの場所またはクラスター名を指定する必要があります。 このコマンドは、関連付けられたカスタムの場所とクラスターの存在をチェックし、両方が microsoft.deviceregistry.assets 拡張機能で正しく設定されていることを確認します。

Azure IoT OPC UA Broker (プレビュー) では、それ自体と接続先の OPC UA サーバーとの間にあるセキュリティで保護されたすべてのチャネルに対して、同じクライアント証明書を使用します。

az iot ops asset endpoint create --name
                                 --resource-group
                                 --ta
                                 [--ac]
                                 [--cert]
                                 [--cert-ref]
                                 [--cl]
                                 [--clrg]
                                 [--cls]
                                 [--cluster]
                                 [--cluster-resource-group]
                                 [--cluster-subscription]
                                 [--location]
                                 [--password-ref]
                                 [--tags]
                                 [--ur]

例

指定されたカスタムの場所を使用して、匿名ユーザー認証を使用して資産エンドポイントを作成します。

az iot ops asset endpoint create --name {asset_endpoint} -g {resource_group} --custom-location {custom_location} --target-address {target_address}

指定されたカスタムの場所とカスタムの場所のリソース グループを使用して、匿名ユーザー認証を使用して資産エンドポイントを作成します。 サブスクリプション内に同じ名前のカスタムの場所が複数存在する場合は、リソース グループを含む必要があります。

az iot ops asset endpoint create --name {asset_endpoint} -g {resource_group} --custom-location {custom_location} --custom-location-resource-group {custom_location_resource_group} --target-address {target_address}

ユーザー名とパスワードのユーザー認証を使用して資産エンドポイントを作成し、事前に入力された値を持つ事前構成済みの所有証明書を作成します。ユーザー名とパスワードの参照は、Azure Keyvault Container Storage Interface ドライバーを使用して設定されます。

az iot ops asset endpoint create --name myAssetEndpoint -g myRG --cluster myCluster --target-address "opc.tcp://opcplc-000000:50000" --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password" --cert secret=aio-opc-ua-broker-client-certificate thumbprint=000000000000000000 password=aio-opc-ua-broker-client-certificate-password

ユーザー名とパスワードのユーザー認証と、事前入力された値を使用した追加の構成を使用して資産エンドポイントを作成します (PowerShell 構文の例)。

az iot ops asset endpoint create --name myAssetEndpoint -g myRG --cluster myCluster --target-address "opc.tcp://opcplc-000000:50000" --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password" --additional-config '{\"applicationName\": \"opcua-connector\", \"defaults\": { \"publishingIntervalMilliseconds\": 100,  \"samplingIntervalMilliseconds\": 500,  \"queueSize\": 15,}, \"session\": {\"timeout\": 60000}, \"subscription\": {\"maxItems\": 1000}, \"security\": { \"autoAcceptUntrustedServerCertificates\": true}}'

ユーザー名とパスワードのユーザー認証を使用して資産エンドポイントを作成し、事前入力された値を持つ追加の構成を作成します (cmd 構文の例)。

az iot ops asset endpoint create --name myAssetEndpoint -g myRG --cluster myCluster --target-address "opc.tcp://opcplc-000000:50000" --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password" --additional-config "{\"applicationName\": \"opcua-connector\", \"defaults\": { \"publishingIntervalMilliseconds\": 100,  \"samplingIntervalMilliseconds\": 500,  \"queueSize\": 15,}, \"session\": {\"timeout\": 60000}, \"subscription\": {\"maxItems\": 1000}, \"security\": { \"autoAcceptUntrustedServerCertificates\": true}}"

ユーザー名とパスワードのユーザー認証と、事前入力された値を使用した追加の構成を使用して資産エンドポイントを作成します (bash 構文の例)。

az iot ops asset endpoint create --name myAssetEndpoint -g myRG --cluster myCluster --target-address "opc.tcp://opcplc-000000:50000" --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password" --additional-config '{"applicationName": "opcua-connector", "defaults": { "publishingIntervalMilliseconds": 100,  "samplingIntervalMilliseconds": 500,  "queueSize": 15,}, "session": {"timeout": 60000}, "subscription": {"maxItems": 1000}, "security": { "autoAcceptUntrustedServerCertificates": true}}'

必須のパラメーター

--name -n

資産エンドポイント名。

--resource-group -g

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

--ta --target-address

ターゲット アドレス。 有効なローカル アドレスである必要があります。

省略可能のパラメーター

--ac --additional-config

接続の種類の追加構成 (OPC UA、Modbus、ONVIF など)。

--cert

エンドポイントに関連付けられている証明書に対応するスペース区切りのキーと値のペア。 次のキー値がサポートされています。 secret (必須)、 thumbprint (必須)、 password.--cert は 1 回以上使用できます。 パラメーターの完全な使用方法については、ヘルプの例を参照してください。

--cert-ref --certificate-ref --cr

認証で使用される証明書のリファレンス。 このユーザー認証方法はまだサポートされていません。

--cl --custom-location

資産エンドポイントをクラスターに関連付けるために使用されるカスタムの場所。

--clrg --custom-location-resource-group

カスタムの場所のリソース グループ。

--cls --custom-location-subscription

カスタムの場所のサブスクリプション ID。

--cluster -c

資産を関連付けるクラスター。

--cluster-resource-group --crg

クラスターのリソース グループ。

--cluster-subscription --cs

クラスターのサブスクリプション ID。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--password-ref --pr

認証で使用されるパスワードのリファレンス。

--tags

資産エンドポイント リソース タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。

--ur --username-reference

認証で使用されるユーザー名のリファレンス。

グローバル パラメーター

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

プレビュー

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

資産エンドポイントを削除します。

az iot ops asset endpoint delete --name
                                 --resource-group

例

資産エンドポイントを削除します。

az iot ops asset endpoint delete --name {asset_endpoint} -g {resource_group}

必須のパラメーター

--name -n

資産エンドポイント名。

--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 asset endpoint query

プレビュー

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

リソース グラフに対して資産エンドポイントのクエリを実行します。

az iot ops asset endpoint query [--ac]
                                [--am]
                                [--cl]
                                [--location]
                                [--resource-group]
                                [--ta]

例

匿名認証を行う資産エンドポイントのクエリを実行します。

az iot ops asset endpoint query --authentication-mode Anonymous

指定されたターゲット アドレスとカスタムの場所を持つ資産エンドポイントを照会します。

az iot ops asset endpoint query --target-address {target_address} --custom-location {custom_location}

省略可能のパラメーター

--ac --additional-config

接続の種類の追加構成 (OPC UA、Modbus、ONVIF など)。

--am --authentication-mode

認証モード。

--cl --custom-location

資産エンドポイントをクラスターに関連付けるために使用されるカスタムの場所。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--resource-group -g

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

--ta --target-address

ターゲット アドレス。 有効なローカル アドレスである必要があります。

グローバル パラメーター

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

プレビュー

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

資産エンドポイントを表示します。

az iot ops asset endpoint show --name
                               --resource-group

例

資産エンドポイントの詳細を表示します。

az iot ops asset endpoint show --name {asset_endpoint} -g {resource_group}

必須のパラメーター

--name -n

資産エンドポイント名。

--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 asset endpoint update

プレビュー

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

資産エンドポイントを更新します。

所有する証明書を更新するには、コマンド グループ az iot ops asset endpoint certificateを使用してください。

az iot ops asset endpoint update --name
                                 --resource-group
                                 [--ac]
                                 [--am]
                                 [--cert-ref]
                                 [--password-ref]
                                 [--ta]
                                 [--tags]
                                 [--ur]

例

匿名ユーザー認証を使用するように資産エンドポイントの認証モードを更新します。

az iot ops asset endpoint update --name {asset_endpoint} -g {resource_group} --authentication-mode Anonymous

資産エンドポイントのユーザー名とパスワードの参照を事前入力された値で更新します。 これにより、認証モードがまだない場合は、ユーザー名パスワードに変換されます。

az iot ops asset endpoint update --name myAssetEndpoint -g myRG --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password"

事前入力された値を使用して、資産エンドポイントのターゲット アドレスと追加の構成を更新します (powershell 構文の例)。

az iot ops asset endpoint update --name myAssetEndpoint -g myRG --target-address "opc.tcp://opcplc-000000:50000" --additional-config '{\"applicationName\": \"opcua-connector\", \"defaults\": { \"publishingIntervalMilliseconds\": 100,  \"samplingIntervalMilliseconds\": 500,  \"queueSize\": 15,}, \"session\": {\"timeout\": 60000}, \"subscription\": {\"maxItems\": 1000}, \"security\": { \"autoAcceptUntrustedServerCertificates\": true}}'

資産エンドポイントのターゲット アドレスと追加の構成を事前入力された値で更新します (cmd 構文の例)。

az iot ops asset endpoint update --name myAssetEndpoint -g myRG --target-address "opc.tcp://opcplc-000000:50000" --additional-config "{\"applicationName\": \"opcua-connector\", \"defaults\": { \"publishingIntervalMilliseconds\": 100,  \"samplingIntervalMilliseconds\": 500,  \"queueSize\": 15,}, \"session\": {\"timeout\": 60000}, \"subscription\": {\"maxItems\": 1000}, \"security\": { \"autoAcceptUntrustedServerCertificates\": true}}"

資産エンドポイントのターゲット アドレスと追加の構成を事前入力された値で更新します (bash 構文の例)。

az iot ops asset endpoint update --name myAssetEndpoint -g myRG --target-address "opc.tcp://opcplc-000000:50000" --additional-config '{"applicationName": "opcua-connector", "defaults": { "publishingIntervalMilliseconds": 100,  "samplingIntervalMilliseconds": 500,  "queueSize": 15,}, "session": {"timeout": 60000}, "subscription": {"maxItems": 1000}, "security": { "autoAcceptUntrustedServerCertificates": true}}'

必須のパラメーター

--name -n

資産エンドポイント名。

--resource-group -g

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

省略可能のパラメーター

--ac --additional-config

接続の種類の追加構成 (OPC UA、Modbus、ONVIF など)。

--am --authentication-mode

認証モード。

--cert-ref --certificate-ref --cr

認証で使用される証明書のリファレンス。 このユーザー認証方法はまだサポートされていません。

--password-ref --pr

認証で使用されるパスワードのリファレンス。

--ta --target-address

ターゲット アドレス。 有効なローカル アドレスである必要があります。

--tags

資産エンドポイント リソース タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。

--ur --username-reference

認証で使用されるユーザー名のリファレンス。

グローバル パラメーター

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