az iot ops asset

Note

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

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

資産を管理する。

コマンド

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

プレビュー

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

資産を作成します。

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

資産の作成時に、少なくとも 1 つのデータ ポイントまたはイベントを定義する必要があります。

az iot ops asset create --endpoint
                        --name
                        --resource-group
                        [--asset-type]
                        [--cl]
                        [--clrg]
                        [--cls]
                        [--cluster]
                        [--cluster-resource-group]
                        [--cluster-subscription]
                        [--data]
                        [--data-publish-int]
                        [--data-queue-size]
                        [--data-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]

例

指定されたカスタムの場所を使用して資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data data_source={data_source}

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

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --custom-location-resource-group {custom_location_resource_group} --endpoint {endpoint} --data data_source={data_source}

指定されたクラスター名を使用して資産を作成します。 サブスクリプション内に同じ名前のクラスターが複数存在する場合は、リソース グループを含む必要があります。

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --cluster-resource-group {cluster_resource_group} --endpoint {endpoint} --event event_notifier={event_notifier}

指定されたクラスター名とカスタムの場所を使用して資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --custom-location {custom_location} --endpoint {endpoint} --event event_notifier={event_notifier}

カスタム データ ポイントとイベントの既定値を使用して資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval} --event event_notifier={event_notifier}

カスタム資産の種類、説明、ドキュメント URI、外部資産 ID、ハードウェア リビジョン、製品コード、ソフトウェア リビジョンを含む資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision} --data data_source={data_source}

製造元、製造元 URI、モデル、シリアル番号の 2 つのイベントを含む資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --event capability_id={capability_id} event_notifier={event_notifier} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --event event_notifier={event_notifier} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number}

2 つのデータ ポイントを含む無効な資産を作成します。

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --disable --data capability_id={capability_id} data_source={data_source} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --data data_source={data_source}

指定された事前入力値を使用して資産を作成します。

az iot ops asset create --name MyAsset -g MyRg --custom-location MyLocation --endpoint example.com --data capability_id=myTagId data_source=NodeID1 name=myTagName1 observability_mode=counter sampling_interval=10 queue_size=2 --data data_source=NodeID2 --data-publish-int 1000 --data-queue-size 1 --data-sample-int 30 --asset-type customAsset --description 'Description for a test asset.' --documentation-uri www.help.com --external-asset-id 000-000-0000 --hardware-revision 10.0 --product-code XXX100 --software-revision 0.1 --manufacturer Contoso --manufacturer-uri constoso.com --model AssetModel --serial-number 000-000-ABC10

必須のパラメーター

--endpoint

資産エンドポイント名。

--name -n

資産名。

--resource-group -g

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

省略可能のパラメーター

--asset-type --at

資産の種類。

--cl --custom-location

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

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

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

--cls --custom-location-subscription

カスタムの場所のサブスクリプション ID。 指定しない場合は、資産サブスクリプション ID が使用されます。

--cluster -c

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

--cluster-resource-group --crg

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

--cluster-subscription --cs

クラスターのサブスクリプション ID。 指定しない場合は、資産サブスクリプション ID が使用されます。

--data

作成するデータ ポイントのプロパティに対応するスペース区切りのキーと値のペア。 次のキー値がサポートされています: capability_id、 data_source (必須) name、、( observability_mode なし、ゲージ、カウンター、ヒストグラム、またはログ) sampling_interval 、(int) queue_size 、(int)。 --data は 1 回以上使用できます。 パラメーターの完全な使用方法については、ヘルプの例を参照してください。

--data-publish-int --dpi

データ ポイントの既定の公開間隔。

既定値: 1000

--data-queue-size --dqs

データ ポイントの既定のキュー サイズ。

既定値: 1

--data-sample-int --dsi

データ ポイントの既定のサンプリング間隔 (ミリ秒)。

既定値: 500

--description -d

説明。

--disable

資産を無効にします。

承認された値: false, true

既定値: False

--display-name --dn

表示名。

--documentation-uri --du

ドキュメント URI。

--eai --external-asset-id

外部資産 ID。

--epi --event-publish-int

イベントの既定の公開間隔。

既定値: 1000

--eqs --event-queue-size

イベントの既定のキュー サイズ。

既定値: 1

--esi --event-sample-int

イベントの既定のサンプリング間隔 (ミリ秒)。

既定値: 500

--event

作成するイベントのプロパティに対応するスペース区切りのキーと値のペア。 次のキー値がサポートされています: capability_id、 event_notifier (必須) name、、( observability_mode なし、ゲージ、カウンター、ヒストグラム、またはログ) sampling_interval 、(int) queue_size 、(int)。 --event は 1 回以上使用できます。 パラメーターの完全な使用方法については、ヘルプの例を参照してください。

--hardware-revision --hr

ハードウェアリビジョン。

--location -l

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

--manufacturer

製造元。

--manufacturer-uri --mu

製造元の URI。

--model

モデル。

--pc --product-code

製品コード。

--serial-number --sn

シリアル番号。

--software-revision --sr

ソフトウェアのリビジョン。

--tags

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

グローバル パラメーター

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

プレビュー

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

資産を削除します。

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

例

資産を削除します。

az iot ops asset delete --name {asset_name} -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 query

プレビュー

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

リソース グラフに資産のクエリを実行します。

az iot ops asset query [--asset-type]
                       [--cl]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint]
                       [--hardware-revision]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]

例

特定のリソース グループ内で無効になっている資産を照会します。

az iot ops asset query -g {resource_group} --disabled

特定のモデル、製造元、シリアル番号を持つ資産を照会します。

az iot ops asset query --model {model} --manufacturer {manufacturer} --serial-number {serial_number}

省略可能のパラメーター

--asset-type --at

資産の種類。

--cl --custom-location

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

--description -d

説明。

--disabled

資産の状態。

承認された値: false, true

--display-name --dn

表示名。

--documentation-uri --du

ドキュメント URI。

--eai --external-asset-id

外部資産 ID。

--endpoint

資産エンドポイント名。

--hardware-revision --hr

ハードウェアリビジョン。

--location -l

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

--manufacturer

製造元。

--manufacturer-uri --mu

製造元の URI。

--model

モデル。

--pc --product-code

製品コード。

--resource-group -g

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

--serial-number --sn

シリアル番号。

--software-revision --sr

ソフトウェアのリビジョン。

グローバル パラメーター

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

プレビュー

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

資産を表示します。

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

例

資産の詳細を表示します。

az iot ops asset show --name {asset_name} -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 update

プレビュー

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

資産を更新します。

データ ポイントとイベントを更新するには、コマンド グループ az iot ops asset data-point をそれぞれ az iot ops asset events 使用してください。

az iot ops asset update --name
                        --resource-group
                        [--asset-type]
                        [--data-publish-int]
                        [--data-queue-size]
                        [--data-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--hardware-revision]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]

例

資産のデータ ポイントとイベントの既定値を更新します。

az iot ops asset update --name {asset_name} -g {resource_group} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval}

資産の資産の種類、説明、ドキュメント URI、外部資産 ID、ハードウェアリビジョン、製品コード、ソフトウェアリビジョンを更新します。

az iot ops asset update --name {asset_name} -g {resource_group} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision}

資産の製造元、製造元の URI、モデル、シリアル番号を更新します。

az iot ops asset update --name {asset_name} -g {resource_group} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number}

資産を無効にします。

az iot ops asset update --name {asset_name} -g {resource_group} --disable

必須のパラメーター

--name -n

資産名。

--resource-group -g

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

省略可能のパラメーター

--asset-type --at

資産の種類。

--data-publish-int --dpi

データ ポイントの既定の公開間隔。

--data-queue-size --dqs

データ ポイントの既定のキュー サイズ。

--data-sample-int --dsi

データ ポイントの既定のサンプリング間隔 (ミリ秒)。

--description -d

説明。

--disable

資産を無効にします。

承認された値: false, true

--display-name --dn

表示名。

--documentation-uri --du

ドキュメント URI。

--eai --external-asset-id

外部資産 ID。

--epi --event-publish-int

イベントの既定の公開間隔。

--eqs --event-queue-size

イベントの既定のキュー サイズ。

--esi --event-sample-int

イベントの既定のサンプリング間隔 (ミリ秒)。

--hardware-revision --hr

ハードウェアリビジョン。

--manufacturer

製造元。

--manufacturer-uri --mu

製造元の URI。

--model

モデル。

--pc --product-code

製品コード。

--serial-number --sn

シリアル番号。

--software-revision --sr

ソフトウェアのリビジョン。

--tags

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

グローバル パラメーター

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