Share via

az iot ops ns asset sse event-group

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 sse event-group command. Learn more about extensions.

Manage event groups for SSE namespaced assets.

Commands

Name Description Type Status
az iot ops ns asset sse event-group add

Add an event group to an SSE namespaced asset in an IoT Operations instance.

 Extension GA
az iot ops ns asset sse event-group export

Export event-groups to file.

 Extension GA
az iot ops ns asset sse event-group import

Import event-groups from file.

 Extension GA
az iot ops ns asset sse event-group list

List event groups for an SSE namespaced asset in an IoT Operations instance.

 Extension GA
az iot ops ns asset sse event-group remove

Remove an event group from an SSE namespaced asset in an IoT Operations instance.

 Extension GA
az iot ops ns asset sse event-group show

Show details of an event group for an SSE namespaced asset in an IoT Operations instance.

 Extension GA
az iot ops ns asset sse event-group update

Update an event group for an SSE namespaced asset in an IoT Operations instance.

 Extension GA

az iot ops ns asset sse event-group add

Add an event group to an SSE namespaced asset in an IoT Operations instance.

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

Examples

Add a basic event group to an SSE asset

az iot ops ns asset sse event-group add --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name alertEvents --data-source "alert"

Add an event group with MQTT destination

az iot ops ns asset sse event-group add --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name systemEvents --data-source "system" --dest topic="factory/sse/system/alerts" retain=Keep qos=Qos1 ttl=7200

Replace an existing event group

az iot ops ns asset sse event-group add --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name alertEvents --data-source "critical-alert" --replace

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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
--data-source --ds

Data source for the event group.

--dest --destination

Key=value pairs representing the destination for events. Allowed and required arguments are topic, retain, qos, and ttl for MQTT destinations. Allowed values for retain are Keep and Never and allowed values for qos are Qos0 and Qos1.

--replace

Replace the event group if another event group 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 sse event-group export

Export event-groups to file.

Export all event-groups from an asset to JSON or YAML format.

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

Required Parameters

--asset -a

Asset 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 group if another event group 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 sse event-group import

Import event-groups from file.

Import event-groups from JSON or YAML file. Use --replace to merge with overwrite.

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

Required Parameters

--asset -a

Asset name.

--if --input-file

Path to import file (JSON or YAML).

--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 group if another event group 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 sse event-group list

List event groups for an SSE namespaced asset in an IoT Operations instance.

az iot ops ns asset sse event-group list --asset
                                         --instance
                                         --resource-group

Examples

List all event groups for an SSE asset

az iot ops ns asset sse event-group list --asset mysseAsset --instance myInstance -g myInstanceResourceGroup

Required Parameters

--asset -a

Asset 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 sse event-group remove

Remove an event group from an SSE namespaced asset in an IoT Operations instance.

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

Examples

Remove an event group from an SSE asset

az iot ops ns asset sse event-group remove --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name alertEvents

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

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

az iot ops ns asset sse event-group show

Show details of an event group for an SSE namespaced asset in an IoT Operations instance.

az iot ops ns asset sse event-group show --asset
                                         --instance
                                         --name
                                         --resource-group

Examples

Show event group details

az iot ops ns asset sse event-group show --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name alertEvents

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

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

az iot ops ns asset sse event-group update

Update an event group for an SSE namespaced asset in an IoT Operations instance.

az iot ops ns asset sse event-group update --asset
                                           --instance
                                           --name
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--data-source --ds]
                                           [--dest --destination]

Examples

Update event group data source

az iot ops ns asset sse event-group update --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name alertEvents --data-source "emergency-alert"

Update event group destination

az iot ops ns asset sse event-group update --asset mysseAsset --instance myInstance -g myInstanceResourceGroup --name systemEvents --dest topic="factory/sse/updated/system" retain=Never qos=Qos0 ttl=3600

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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
--data-source --ds

Data source for the event group.

--dest --destination

Key=value pairs representing the destination for events. Allowed and required arguments are topic, retain, qos, and ttl for MQTT destinations. Allowed values for retain are Keep and Never and allowed values for qos are Qos0 and Qos1.

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