Share via

az tsi reference-data-set

  • Reference

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 reference-data-set command. Learn more about extensions.

Manage reference data set with timeseriesinsights.

Commands

Name Description Type Status
az tsi reference-data-set create

Create a reference data set in the specified environment.

 Extension GA
az tsi reference-data-set delete

Delete the reference data set with the specified name in the specified subscription, resource group, and environment.

 Extension GA
az tsi reference-data-set list

List all the available reference data sets associated with the subscription and within the specified resource group and environment.

 Extension GA
az tsi reference-data-set show

Get the reference data set with the specified name in the specified environment.

 Extension GA
az tsi reference-data-set update

Update the reference data set with the specified name in the specified subscription, resource group, and environment.

 Extension GA

az tsi reference-data-set create

Create a reference data set in the specified environment.

az tsi reference-data-set create --environment-name
                                 --key-properties
                                 --location
                                 --name
                                 --resource-group
                                 [--comparison-behavior {Ordinal, OrdinalIgnoreCase}]
                                 [--tags]

Examples

ReferenceDataSetsCreate

az tsi reference-data-set create --environment-name "env1" --location westus --key-properties name="DeviceId1" type="String" --key-properties name="DeviceFloor" type="Double" --name "rds1" --resource-group "rg1"

Required Parameters

--environment-name

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

--key-properties

The list of key properties for the reference data set.

Usage: --key-properties name=XX type=XX

name: The name of the key property. type: The type of the key property.

Multiple actions can be specified by using more than one --key-properties argument.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --reference-data-set-name -n

The name of the Time Series Insights reference data set associated with the specified environment.

--resource-group -g

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

Optional Parameters

--comparison-behavior --data-string-comparison-behavior

The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.

Accepted values: Ordinal, OrdinalIgnoreCase
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az tsi reference-data-set delete

Delete the reference data set with the specified name in the specified subscription, resource group, and environment.

az tsi reference-data-set delete [--environment-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Examples

ReferenceDataSetsDelete

az tsi reference-data-set delete --environment-name "env1" --name "rds1" --resource-group "rg1"

Optional Parameters

--environment-name

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

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

--name --reference-data-set-name -n

The name of the Time Series Insights reference data set associated with the specified environment.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az tsi reference-data-set list

List all the available reference data sets associated with the subscription and within the specified resource group and environment.

az tsi reference-data-set list --environment-name
                               --resource-group

Examples

ReferenceDataSetsListByEnvironment

az tsi reference-data-set 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. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az tsi reference-data-set show

Get the reference data set with the specified name in the specified environment.

az tsi reference-data-set show [--environment-name]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Examples

ReferenceDataSetsGet

az tsi reference-data-set show --environment-name "env1" --name "rds1" --resource-group "rg1"

Optional Parameters

--environment-name

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

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

--name --reference-data-set-name -n

The name of the Time Series Insights reference data set associated with the specified environment.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az tsi reference-data-set update

Update the reference data set with the specified name in the specified subscription, resource group, and environment.

az tsi reference-data-set update [--environment-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

Examples

ReferenceDataSetsUpdate

az tsi reference-data-set update --environment-name "env1" --name "rds1" --tags someKey="someValue" --resource-group "rg1"

Optional Parameters

--environment-name

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

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

--name --reference-data-set-name -n

The name of the Time Series Insights reference data set associated with the specified environment.

--resource-group -g

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

--subscription

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

--tags

Key-value pairs of additional properties for the reference data set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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