Share via

az iot ops ns asset custom event point

  • Preview

Note

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

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

Manage event points for custom asset events in Device Registry namespaces.

Commands

Name Description Type Status
az iot ops ns asset custom event point add

Add an event data point to a custom asset event in a Device Registry namespace.

 Extension Preview
az iot ops ns asset custom event point list

List event points for a custom asset event in a Device Registry namespace.

 Extension Preview
az iot ops ns asset custom event point remove

Remove an event point from a custom asset event in a Device Registry namespace.

 Extension Preview

az iot ops ns asset custom event point add

Preview

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

Add an event data point to a custom asset event in a Device Registry namespace.

az iot ops ns asset custom event point add --asset
                                           --data-source --ds
                                           --event
                                           --instance
                                           --name
                                           --resource-group
                                           [--config]
                                           [--replace {false, true}]

Examples

Add a basic custom event point

az iot ops ns asset custom event point add --asset mycustomasset --instance myInstance -g myInstanceResourceGroup --event alarmEvent --name severity --data-source "alarm.severity"

Replace a custom event point with same name

az iot ops ns asset custom event point add --asset mycustomasset --instance myInstance -g myInstanceResourceGroup --event alarmEvent --name severity --data-source "alarm.severity.updated" --replace

Required Parameters

--asset -a

Asset name.

--data-source --ds

Data source for the event data point.

--event -e

Event name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Data point name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--config

Custom event data point configuration as a JSON string or file path.

--replace

Replace the data point if another point with the same name is already present.

Property Value
Default value: False
Accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az iot ops ns asset custom event point list

Preview

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

List event points for a custom asset event in a Device Registry namespace.

az iot ops ns asset custom event point list --asset
                                            --event
                                            --instance
                                            --resource-group

Examples

List all event points for an event

az iot ops ns asset custom event point list --asset mycustomasset --instance myInstance -g myInstanceResourceGroup --event alarmEvent

Required Parameters

--asset -a

Asset name.

--event -e

Event name.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az iot ops ns asset custom event point remove

Preview

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

Remove an event point from a custom asset event in a Device Registry namespace.

az iot ops ns asset custom event point remove --asset
                                              --event
                                              --instance
                                              --name
                                              --resource-group

Examples

Remove an event point from an event

az iot ops ns asset custom event point remove --asset mycustomasset --instance myInstance -g myInstanceResourceGroup --event alarmEvent --name severity

Required Parameters

--asset -a

Asset name.

--event -e

Event name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Data point name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False