Share via


az tsi event-source

Note

This reference is part of the timeseriesinsights extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az tsi event-source command. Learn more about extensions.

Manage event source with timeseriesinsights.

Commands

Name Description Type Status
az tsi event-source delete

Delete the event source with the specified name in the specified subscription, resource group, and environment.

Extension GA
az tsi event-source eventhub

Manage event source with timeseriesinsights sub group event-hub.

Extension GA
az tsi event-source eventhub create

Create an event source under the specified environment.

Extension GA
az tsi event-source eventhub update

Update an event source under the specified environment.

Extension GA
az tsi event-source iothub

Manage event source with timeseriesinsights sub group iot-hub.

Extension GA
az tsi event-source iothub create

Create an event source under the specified environment.

Extension GA
az tsi event-source iothub update

Update an event source under the specified environment.

Extension GA
az tsi event-source list

List all the available event sources associated with the subscription and within the specified resource group and environment.

Extension GA
az tsi event-source show

Show the event source with the specified name in the specified environment.

Extension GA

az tsi event-source delete

Delete the event source with the specified name in the specified subscription, resource group, and environment.

az tsi event-source delete [--environment-name]
                           [--event-source-name --name]
                           [--ids]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

DeleteEventSource

az tsi event-source delete --environment-name "env1" --name "es1" --resource-group "rg1"

Optional Parameters

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

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--event-source-name --name -n

The name of the Time Series Insights event source associated with the specified environment.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az tsi event-source list

List all the available event sources associated with the subscription and within the specified resource group and environment.

az tsi event-source list --environment-name
                         --resource-group

Examples

ListEventSourcesByEnvironment

az tsi event-source list --environment-name "env1" --resource-group "rg1"

Required Parameters

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

--resource-group -g

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

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 tsi event-source show

Show the event source with the specified name in the specified environment.

az tsi event-source show [--environment-name]
                         [--event-source-name --name]
                         [--ids]
                         [--resource-group]
                         [--subscription]

Examples

GetEventHubEventSource

az tsi event-source show --environment-name "env1" --name "es1" --resource-group "rg1"

Optional Parameters

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

--environment-name

The name of the Time Series Insights environment associated with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--event-source-name --name -n

The name of the Time Series Insights event source associated with the specified environment.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False