az iot ops asset endpoint

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). 拡張機能は、 az iot ops asset endpoint コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

コマンド

名前	説明	型	状態
az iot ops asset endpoint create	資産エンドポイント プロファイルを作成します。	Extension	GA
az iot ops asset endpoint create opcua	OPCUA コネクタの資産エンドポイント プロファイルを作成します。	Extension	GA
az iot ops asset endpoint delete	資産エンドポイント プロファイルを削除します。	Extension	GA
az iot ops asset endpoint query	リソース グラフに対して資産エンドポイント プロファイルのクエリを実行します。	Extension	GA
az iot ops asset endpoint show	資産エンドポイント プロファイルを表示します。	Extension	GA
az iot ops asset endpoint update	資産エンドポイント プロファイルを更新します。	Extension	GA

az iot ops asset endpoint delete

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

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

例

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

az iot ops asset endpoint delete --name myprofile -g myresourcegroup

必須のパラメーター

--name -n

資産エンドポイント プロファイル名。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops asset endpoint query

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

az iot ops asset endpoint query [--am --authentication-mode {Anonymous, Certificate, UsernamePassword}]
                                [--cq --custom-query]
                                [--endpoint-profile-type --ept]
                                [--ig --instance-resource-group]
                                [--instance]
                                [--location]
                                [--name]
                                [--resource-group]
                                [--ta --target-address]

例

匿名認証を持つ資産エンドポイント プロファイルのクエリを実行します。

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

指定されたターゲット アドレスとインスタンス名を持つ資産エンドポイント プロファイルを照会します。

az iot ops asset endpoint query --target-address opc.tcp://opcplc-000000:50000 --instance myinstance

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--am --authentication-mode

Authentication Mode.

プロパティ	値
Parameter group:	Authentication Arguments
指定可能な値:	Anonymous, Certificate, UsernamePassword

--cq --custom-query

使用するカスタム クエリ。 その他のすべてのクエリ引数は無視されます。

--endpoint-profile-type --ept

エンドポイント プロファイルのコネクタの種類。

--ig --instance-resource-group

インスタンス リソース グループ。 指定しない場合は、資産エンドポイント プロファイル リソース グループが使用されます。

--instance

作成された資産を関連付けるインスタンス名。

--location -l

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

--name -n

資産エンドポイント プロファイル名。

--resource-group -g

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

--ta --target-address

Target Address. opc.tcp プロトコルに従う有効なローカル アドレスである必要があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops asset endpoint show

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

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

例

資産エンドポイント プロファイルの詳細を表示します。

az iot ops asset endpoint show --name myprofile -g myresourcegroup

必須のパラメーター

--name -n

資産エンドポイント プロファイル名。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot ops asset endpoint update

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

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

az iot ops asset endpoint update --name
                                 --resource-group
                                 [--am --authentication-mode {Anonymous, Certificate, UsernamePassword}]
                                 [--cert-ref --certificate-ref]
                                 [--cr]
                                 [--pass-ref --password-ref]
                                 [--pr]
                                 [--ta --target-address]
                                 [--tags]
                                 [--ur --username-reference]
                                 [--user-ref --username-ref]

例

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

az iot ops asset endpoint update --name myprofile -g myresourcegroup --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"

必須のパラメーター

--name -n

資産エンドポイント プロファイル名。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--am --authentication-mode

Authentication Mode.

プロパティ	値
Parameter group:	Authentication Arguments
指定可能な値:	Anonymous, Certificate, UsernamePassword

--cert-ref --certificate-ref

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

プロパティ	値
Parameter group:	Authentication Arguments

--cr

非推奨

オプション '--cr' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--cert-ref' を使用してください。

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

プロパティ	値
Parameter group:	Authentication Arguments

--pass-ref --password-ref

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

プロパティ	値
Parameter group:	Authentication Arguments

--pr

非推奨

オプション '--pr' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--pass-ref' を使用してください。

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

プロパティ	値
Parameter group:	Authentication Arguments

--ta --target-address

Target Address. opc.tcp プロトコルに従う有効なローカル アドレスである必要があります。

--tags

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

--ur --username-reference

非推奨

オプション '--username-reference' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--user-ref' を使用してください。

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

プロパティ	値
Parameter group:	Authentication Arguments

--user-ref --username-ref

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

プロパティ	値
Parameter group:	Authentication Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False