Share via

az tsi environment

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 environment command. Learn more about extensions.

Manage environment with Azure Time Series Insights.

Commands

Name Description Type Status
az tsi environment delete

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

 Extension GA
az tsi environment gen1

Manage a gen1 environment in the specified subscription and resource group.

 Extension GA
az tsi environment gen1 create

Create a gen1 environment in the specified subscription and resource group.

 Extension GA
az tsi environment gen1 update

Update a gen1 environment in the specified subscription and resource group.

 Extension GA
az tsi environment gen2

Manage a gen2 environment in the specified subscription and resource group.

 Extension GA
az tsi environment gen2 create

Create a gen2 environment in the specified subscription and resource group.

 Extension GA
az tsi environment gen2 update

Update a gen2 environment in the specified subscription and resource group.

 Extension GA
az tsi environment list

List all the available environments within a subscription, irrespective of the resource groups.

 Extension GA
az tsi environment show

Get the environment with the specified name in the specified subscription and resource group.

 Extension GA

az tsi environment delete

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

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

Examples

EnvironmentsDelete

az tsi environment delete --name "env1" --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 --name -n

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

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

List all the available environments within a subscription, irrespective of the resource groups.

az tsi environment list [--resource-group]

Examples

EnvironmentsByResourceGroup

az tsi environment list --resource-group "rg1"

EnvironmentsBySubscription

az tsi environment list

Optional Parameters

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

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

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 environment show

Get the environment with the specified name in the specified subscription and resource group.

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

Examples

EnvironmentsGet

az tsi environment show --name "env1" --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 --name -n

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

Property Value
Parameter group: Resource Id Arguments
--expand

Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

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