az iot ops asset endpoint

リファレンス

Note

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

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

コマンド

名前	説明	型	状態
az iot ops asset endpoint create	資産エンドポイントプロファイルを作成します。	拡張子	ジョージア州
az iot ops asset endpoint create custom	カスタムコネクタの資産エンドポイントプロファイルを作成します。	拡張子	廃止
az iot ops asset endpoint create onvif	Onvif コネクタの資産エンドポイントプロファイルを作成します。	拡張子	廃止
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 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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

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

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

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

例

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

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

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

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

省略可能のパラメーター

--am --authentication-mode

認証モード。

指定可能な値: 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

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

グローバルパラメーター

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

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

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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

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

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

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

az iot ops asset endpoint update --name
                                 --resource-group
                                 [--am {Anonymous, Certificate, UsernamePassword}]
                                 [--cert-ref]
                                 [--cr]
                                 [--pass-ref]
                                 [--pr]
                                 [--ta]
                                 [--tags]
                                 [--ur]
                                 [--user-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> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--am --authentication-mode

認証モード。

指定可能な値: Anonymous, Certificate, UsernamePassword

--cert-ref --certificate-ref

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

--cr

非推奨

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

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

--pass-ref --password-ref

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

--pr

非推奨

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

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

--ta --target-address

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

--tags

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

--ur --username-reference

非推奨

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

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

--user-ref --username-ref

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

グローバルパラメーター

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

コマンド

az iot ops asset endpoint delete

例

必須のパラメーター

az iot ops asset endpoint query

例

省略可能のパラメーター

az iot ops asset endpoint show

例

必須のパラメーター

az iot ops asset endpoint update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース