Share via

az iot ops ns asset custom event

Note

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

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

Commands

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

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

 Extension GA
az iot ops ns asset custom event export

Export events to file.

 Extension GA
az iot ops ns asset custom event import

Import events from file.

 Extension GA
az iot ops ns asset custom event list

List events for a custom asset event group in a Device Registry namespace.

 Extension GA
az iot ops ns asset custom event remove

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

 Extension GA

az iot ops ns asset custom event add

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

az iot ops ns asset custom event add --asset
                                     --eg --event-group
                                     --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--config]
                                     [--data-source --ds]
                                     [--dest --destination]
                                     [--replace {false, true}]
                                     [--tr --type-ref]

Examples

Add a basic custom event

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

Replace a custom event with same name

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

Required Parameters

--asset -a

Asset name.

--eg --event-group

Event name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--config

Custom event configuration as a JSON string or file path.

--data-source --ds

Data source for the event.

--dest --destination

Key=value pairs representing the destination for event groups. Allowed arguments include: key for BrokerStateStore; path for Storage; or topic, retain, qos, and ttl for MQTT. Allowed values for retain are Keep and Never and allowed values for qos are Qos0 and Qos1.

--replace

Replace the event if another event with the same name is already present.

Property Value
Default value: False
Accepted values: false, true
--tr --type-ref

Type definition ID or URI.

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 export

Export events to file.

Export events from an event-group to JSON, YAML, or CSV format.

az iot ops ns asset custom event export --asset
                                        --eg --event-group
                                        --instance
                                        --resource-group
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--format {csv, json, yaml}]
                                        [--od --output-dir]
                                        [--replace {false, true}]

Required Parameters

--asset -a

Asset name.

--eg --event-group

Event-group name.

--instance -i

The name of the Azure IoT Operations instance.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--format -f

Export file format.

Property Value
Default value: json
Accepted values: csv, json, yaml
--od --output-dir

Output directory for export.

Property Value
Default value: .
--replace

Replace the event if another event 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 import

Import events from file.

Import events from JSON, YAML, or CSV file. Use --replace to merge with overwrite.

az iot ops ns asset custom event import --asset
                                        --eg --event-group
                                        --if --input-file
                                        --instance
                                        --resource-group
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--replace {false, true}]

Required Parameters

--asset -a

Asset name.

--eg --event-group

Event-group name.

--if --input-file

Path to import file (JSON, YAML, or CSV).

--instance -i

The name of the Azure IoT Operations instance.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--replace

Replace the event if another event 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 list

List events for a custom asset event group in a Device Registry namespace.

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

Examples

List all events for an event group

az iot ops ns asset custom event list --asset mycustomasset --instance myInstance -g myInstanceResourceGroup --event-group alarmGroup

Required Parameters

--asset -a

Asset name.

--eg --event-group

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 remove

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

az iot ops ns asset custom event remove --asset
                                        --eg --event-group
                                        --instance
                                        --name
                                        --resource-group
                                        [--acquire-policy-token]
                                        [--change-reference]

Examples

Remove an event from an event group

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

Required Parameters

--asset -a

Asset name.

--eg --event-group

Event name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
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