az iot ops asset data-point

  • Preview
  • Reference

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot ops asset data-point command. Learn more about extensions.

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage data points in an asset.

Commands

Name Description Type Status
az iot ops asset data-point add

Add a data point to an asset.

 Extension Preview
az iot ops asset data-point list

List data points in an asset.

 Extension Preview
az iot ops asset data-point remove

Remove a data point in an asset.

 Extension Preview

az iot ops asset data-point add

Preview

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a data point to an asset.

az iot ops asset data-point add --asset
                                --data-source
                                --resource-group
                                [--capability-id]
                                [--name]
                                [--observability-mode]
                                [--qs]
                                [--sampling-interval]

Examples

Add a data point to an asset.

az iot ops asset data-point add --asset {asset} -g {resource_group} --data-source {data_source}

Add a data point to an asset with capability id, data point name, observability mode, custom queue size, and custom sampling interval.

az iot ops asset data-point add --asset {asset} -g {resource_group} --data-source {data_source} --name {name} --capability-id {capability_id} --observability-mode {observability_mode} --queue-size {queue_size} --sampling-interval {sampling_interval}

Add a data point to an asset with the given pre-filled values.

az iot ops asset data-point add --asset MyAsset -g MyRG --data-source nodeId1 --name tagName1 --capability-id tagId1 --observability-mode log --queue-size 5 --sampling-interval 200

Required Parameters

--asset -a

Asset name.

--data-source --ds

Data source.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--capability-id --ci

Capability Id. If not provided, data point name will be used.

--name -n

Data point name.

--observability-mode --om

Observability mode.

--qs --queue-size

Custom queue size.

--sampling-interval --si

Custom sampling interval (in milliseconds).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot ops asset data-point list

Preview

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List data points in an asset.

az iot ops asset data-point list --asset
                                 --resource-group

Examples

List all data-points in an asset.

az iot ops asset data-point list --asset {asset} -g {resource_group}

Required Parameters

--asset -a

Asset name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot ops asset data-point remove

Preview

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a data point in an asset.

az iot ops asset data-point remove --asset
                                   --resource-group
                                   [--data-source]
                                   [--name]

Examples

Remove a data point from an asset via the data source.

az iot ops asset data-point remove --asset {asset} -g {resource_group} --data-source {data_source}

Remove a data point from an asset via the data point name.

az iot ops asset data-point remove --asset {asset} -g {resource_group} --name {name}

Required Parameters

--asset -a

Asset name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--data-source --ds

Data source.

--name -n

Data point name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.