az tsi environment gen2
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 gen2 command. Learn more about extensions.
Manage a gen2 environment in the specified subscription and resource group.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 gen2 create
Create a gen2 environment in the specified subscription and resource group.
az tsi environment gen2 create --environment-name
--id-properties
--location
--resource-group
--sku
--storage-config
[--no-wait]
[--tags]
[--warm-store-config]Examples
EnvironmentsGen2Create
az tsi environment gen2 create --name "env2" --location westus --resource-group "rg1" --sku name="L1" capacity=1 --time-series-id-properties name=idName type=String --storage-configuration account-name=your-account-name management-key=your-account-keyRequired Parameters
Name of the environment.
The list of event properties which will be used to define the environment's time series id.
Usage: --time-series-id-properties name=XX type=String
name: The name of the property. type: The type of the property.
Multiple actions can be specified by using more than one --time-series-id-properties argument.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The sku determines the type of environment, L1.
Usage: --sku name=XX capacity=XX
name: Required. The name of this SKU. capacity: Required. The capacity of the sku.
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
Usage: --storage-configuration account-name=XX management-key=XX
account-name: Required. The name of the storage account that will hold the environment's Gen2 data. management-key: Required. The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses.
Optional Parameters
Do not wait for the long-running operation to finish.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
Usage: --warm-store-configuration data-retention=XX
data-retention: Required. ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az tsi environment gen2 update
Update a gen2 environment in the specified subscription and resource group.
az tsi environment gen2 update [--environment-name]
[--ids]
[--no-wait]
[--resource-group]
[--storage-config]
[--subscription]
[--tags]
[--warm-store-config]Examples
EnvironmentsGen2Update
az tsi environment gen2 update --name "env2" --resource-group "rg1" --warm-store-configuration data-retention=P30D --storage-configuration account-name=your-account-name management-key=your-account-keyOptional Parameters
Name of the environment.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
Usage: --storage-configuration account-name=XX management-key=XX
account-name: Required. The name of the storage account that will hold the environment's Gen2 data. management-key: Required. The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
Usage: --warm-store-configuration data-retention=XX
data-retention: Required. ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
