Share via

az tsi environment gen1

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

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

Commands

Name Description Type Status
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 gen1 create

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

az tsi environment gen1 create --data-retention-time
                               --environment-name
                               --location
                               --resource-group
                               --sku
                               [--exceeded-behavior {PauseIngress, PurgeOldData}]
                               [--key-properties]
                               [--no-wait]
                               [--tags]

Examples

EnvironmentsGen1Create

az tsi environment gen1 create --name "env1" --location westus --data-retention-time "P31D" --partition-key-properties name="DeviceId1" type="String" --sku name="S1" capacity=1 --resource-group "rg1"

Required Parameters

--data-retention-time

ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

--environment-name --name -n

Name of the environment.

--location -l

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

--resource-group -g

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

--sku

The sku determines the type of environment, either S1 or S2. For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

Usage: --sku name=XX capacity=XX

name: Required. The name of this SKU. capacity: Required. The capacity of the sku. This value can be changed to support scale out of environments after they have been created.

Optional Parameters

--exceeded-behavior --storage-limit-exceeded-behavior

The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

Accepted values: PauseIngress, PurgeOldData
--key-properties --partition-key-properties

The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.

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

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

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

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--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 environment gen1 update

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

az tsi environment gen1 update [--data-retention-time]
                               [--environment-name]
                               [--exceeded-behavior {PauseIngress, PurgeOldData}]
                               [--ids]
                               [--no-wait]
                               [--resource-group]
                               [--sku]
                               [--subscription]
                               [--tags]

Examples

EnvironmentsGen1Update

az tsi environment gen1 update --name "env1" --sku name="S1" capacity=2                --resource-group "rg1" --data-retention-time "P30D" --storage-limit-exceeded-behavior PurgeOldData

Optional Parameters

--data-retention-time

ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

--environment-name --name -n

Name of the environment.

--exceeded-behavior --storage-limit-exceeded-behavior

The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

Accepted values: PauseIngress, PurgeOldData
--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.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

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

--sku

The sku determines the type of environment, either S1 or S2. For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

Usage: --sku name=XX capacity=XX

name: Required. The name of this SKU. capacity: Required. The capacity of the sku. This value can be changed to support scale out of environments after they have been created.

--subscription

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

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