az iot ops asset data-point
Note
This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.53.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 export |
Export data points in an asset. |
Extension | Preview |
az iot ops asset data-point import |
Import data points in 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
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 name.
Data source.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Capability Id. If not provided, data point name will be used.
Data point name.
Observability mode. Must be none, gauge, counter, histogram, or log.
Custom queue size.
Custom sampling interval (in milliseconds).
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops asset data-point export
Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Export data points in an asset.
The file name will be {asset_name}_dataPoints.{file_type}.
az iot ops asset data-point export --asset
--resource-group
[--format {csv, json, portal-csv, yaml}]
[--od]
[--replace {false, true}]
Examples
Export all data points in an asset in JSON format.
az iot ops asset data-point export --asset {asset} -g {resource_group}
Export all data points in an asset in CSV format in a specific output directory.
az iot ops asset data-point export --asset {asset} -g {resource_group} --format csv --output-dir {output_directory}
Export all data points in an asset in CSV format that can be uploaded via the DOE portal.
az iot ops asset data-point export --asset {asset} -g {resource_group} --format portal-csv
Export all data points in an asset in YAML format. Replace the file if one is present already.
az iot ops asset data-point export --asset {asset} -g {resource_group} --format yaml --replace
Required Parameters
Asset name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
File format.
Output directory for exported file.
Replace the local file if present.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops asset data-point import
Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Import data points in an asset.
For examples of file formats, please see aka.ms/aziotops-assets.
az iot ops asset data-point import --asset
--if
--resource-group
[--replace {false, true}]
Examples
Import all data points from a file. These data points will be appended to the asset's current data points. Data-points with duplicate dataSources will be ignored.
az iot ops asset data-point import --asset {asset} -g {resource_group} --input-file {input_file}
Import all data points from a file. These data points will be appended to the asset's current data points. Data-points with duplicate dataSources will be replaced.
az iot ops asset data-point import --asset {asset} -g {resource_group} --input-file {input_file} --replace
Required Parameters
Asset name.
File path for the file containing the data points. The following file types are supported: csv, json, portal-csv, yaml.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Replace all asset data points with those from the file. If false, the file data points will be appended.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops asset data-point list
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 name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops asset data-point remove
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 name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Data source.
Data point name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.