你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az iot ops asset

注意

此参考是 Azure CLI(版本 2.53.0 或更高版本)的 azure-iot-ops 扩展的一部分。 该扩展将在首次运行 az iot ops asset 命令时自动安装。 详细了解扩展。

资产管理。

有关资产管理的详细信息,请参阅 aka.ms/asset-overview。

命令

名称 说明 类型 Status
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 asset create

创建资源。

有关文件格式的示例,请参阅 aka.ms/aziotops-assets。

az iot ops asset create --endpoint-profile
                        --instance
                        --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--ef]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--ig]
                        [--instance-subscription]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

示例

在同一资源组中使用给定实例创建资产。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance

使用不同资源组中的给定实例创建资产,但订阅相同。 请注意,如果资产位于与实例不同的订阅中,则数字操作体验可能不会显示该资产。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --instance-resource-group myinstanceresourcegroup

使用包含事件的文件创建禁用的资产。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event-file /path/to/myasset_events.csv --disable

使用给定的预填充值创建资产。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event event_notifier=EventNotifier1 name=myEvent1 observability_mode=log sampling_interval=10 queue_size=2 --event event_notifier=EventNotifier2 name=myEvent2 --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50 --description 'Description for a test asset.' --documentation-uri www.contoso.com --external-asset-id 000-000-1234 --hardware-revision 10.0 --product-code XXX100 --software-revision 0.1 --manufacturer Contoso --manufacturer-uri constoso.com --model AssetModel --serial-number 000-000-ABC10 --custom-attribute work_location=factory

必需参数

--endpoint-profile --ep

资产终结点配置文件名称。

--instance

要与所创建资产关联的实例名称。

--name -n

资产名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--attr --custom-attribute

与资产的其他自定义属性对应的空格分隔键=值对。 此参数可以多次使用。

--dataset-publish-int --dpi

数据集的默认发布间隔。

默认值: 1000
--dataset-queue-size --dqs

数据集的默认队列大小。

默认值: 1
--dataset-sample-int --dsi

数据集的默认采样间隔(以毫秒为单位)。

默认值: 500
--description -d

说明。

--disable

禁用资产。

接受的值: false, true
默认值: False
--display-name --dn

显示名称。

--documentation-uri --du

文档 URI。

--eai --external-asset-id

外部资产 ID。

--ef --event-file

包含事件的文件的文件路径。 支持以下文件类型:json、csv、yaml。

--epi --event-publish-int

事件的默认发布间隔。

默认值: 1000
--eqs --event-queue-size

事件的默认队列大小。

默认值: 1
--esi --event-sample-int

事件的默认采样间隔(以毫秒为单位)。

默认值: 500
--event

与要创建的事件的属性对应的空格分隔键=值对。 支持以下键值: event_notifier (必需)、 name (必需)、 observability_mode (无或日志)、 sampling_interval (int)、 queue_size (int)。 --event 可以使用 1 次或多次。 查看有关完整参数用法的帮助示例。

--hardware-revision --hr

硬件修订。

--ig --instance-resource-group

实例资源组。 如果未提供,将使用资产资源组。

--instance-subscription --is
已放弃

参数“instance_subscription”已弃用,将在将来的版本中删除。

实例订阅 ID。如果未提供,将使用资产订阅 ID。

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

--topic-path --tp

默认主题路径。

--topic-retain --tr

默认主题保留策略。

接受的值: Keep, Never
全局参数
--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

删除资产。

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

示例

删除资产。

az iot ops asset delete --name myasset -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 query

查询资源图中的资产。

az iot ops asset query [--cq]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint-profile]
                       [--hardware-revision]
                       [--ig]
                       [--instance]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--name]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]
                       [--topic-path]
                       [--topic-retain {Keep, Never}]

示例

查询在给定资源组中禁用的资产。

az iot ops asset query -g myresourcegroup --disabled

查询具有给定型号、制造商和序列号的资产。

az iot ops asset query --model model1 --manufacturer contoso --serial-number 000-000-ABC10

可选参数

--cq --custom-query

要使用的自定义查询。 将忽略所有其他查询参数。

--description -d

说明。

--disabled

资产状态。

接受的值: false, true
--display-name --dn

显示名称。

--documentation-uri --du

文档 URI。

--eai --external-asset-id

外部资产 ID。

--endpoint-profile --ep

资产终结点配置文件名称。

--hardware-revision --hr

硬件修订。

--ig --instance-resource-group

实例资源组。 如果未提供,将使用资产资源组。

--instance

要与所创建资产关联的实例名称。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--manufacturer

制造商。

--manufacturer-uri --mu

制造商 URI。

--model

模型。

--name -n

资产名称。

--pc --product-code

产品代码。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--serial-number --sn

序列号。

--software-revision --sr

软件修订。

--topic-path --tp

默认主题路径。

--topic-retain --tr

默认主题保留策略。

接受的值: Keep, Never
全局参数
--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

显示资产。

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

示例

显示资产的详细信息。

az iot ops asset show --name myasset -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 update

更新资产。

若要更新数据集和事件,请分别使用命令组az iot ops asset datasetaz iot ops asset event

az iot ops asset update --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--hardware-revision]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

示例

更新资产的数据集和事件默认值。

az iot ops asset update --name myasset -g myresourcegroup --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50

更新资产的说明、文档 URI、硬件修订、代码示例和软件修订版。

az iot ops asset update --name myasset -g myresourcegroup --description "Updated test asset description." --documentation-uri www.contoso.com --hardware-revision 11.0 --product-code XXX102 --software-revision 0.2

更新资产的制造商、制造商 URI、型号、序列号和自定义属性。

az iot ops asset update --name myasset -g myresourcegroup --manufacturer Contoso --manufacturer-uri constoso2.com --model NewAssetModel --serial-number 000-000-ABC11 --custom-attribute work_location=new_factory --custom-attribute secondary_work_location=factory

禁用资产并删除名为“work_site”的自定义属性。

az iot ops asset update --name myasset -g myresourcegroup --disable --custom-attribute work_site=""

必需参数

--name -n

资产名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--attr --custom-attribute

与资产的其他自定义属性对应的空格分隔键=值对。 此参数可以多次使用。若要删除自定义属性,请将特性的值设置为“”。

--dataset-publish-int --dpi

数据集的默认发布间隔。

--dataset-queue-size --dqs

数据集的默认队列大小。

--dataset-sample-int --dsi

数据集的默认采样间隔(以毫秒为单位)。

--description -d

说明。

--disable

禁用资产。

接受的值: false, true
--display-name --dn

显示名称。

--documentation-uri --du

文档 URI。

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

--topic-path --tp

默认主题路径。

--topic-retain --tr

默认主题保留策略。

接受的值: Keep, Never
全局参数
--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 获取完整的调试日志。