az timeseriesinsights environment standard

Create or update a standard environment in the specified subscription and resource group.

Commands

az timeseriesinsights environment standard create

Create or update a standard environment in the specified subscription and resource group.

az timeseriesinsights environment standard update

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

az timeseriesinsights environment standard create

Create or update a standard environment in the specified subscription and resource group.

az timeseriesinsights environment standard create --data-retention-time
                                                  --name
                                                  --resource-group
                                                  --sku-capacity
                                                  --sku-name {L1, P1, S1, S2}
                                                  [--location]
                                                  [--no-wait]
                                                  [--partition-key-properties]
                                                  [--storage-limit-exceeded-behavior {PauseIngress, PurgeOldData}]
                                                  [--tags]

Examples

Create a standard environment

az timeseriesinsights environment standard create -g {rg} -n {env} --location westus --sku-name S1 --sku-capacity 1 --data-retention-time 31 --partition-key DeviceId1 --storage-limit-exceeded-behavior PauseIngress

Required Parameters

--data-retention-time

The minimum number of days the environment's events will be available for query.

--name -n

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

--sku-capacity

The capacity of the sku. For standard environments, this value can be changed to support scale out of environments after they have been created.

--sku-name

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

accepted values: L1, P1, S1, S2

Optional Parameters

--location -l

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

--no-wait

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

--partition-key-properties

The list of event properties which will be used to partition data in the environment.

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

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

az timeseriesinsights environment standard update

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

az timeseriesinsights environment standard update --name
                                                  --resource-group
                                                  [--data-retention-time]
                                                  [--no-wait]
                                                  [--partition-key-properties]
                                                  [--sku-capacity]
                                                  [--sku-name {L1, P1, S1, S2}]
                                                  [--storage-limit-exceeded-behavior {PauseIngress, PurgeOldData}]
                                                  [--tags]

Examples

Update sku capacity

az timeseriesinsights environment standard update -g {rg} -n {env} --sku-name S1 --sku-capacity 2

Update data retention days

az timeseriesinsights environment standard update -g {rg} -n {env} --data-retention-time 8

Update storage limit exceeded behavior

az timeseriesinsights environment standard update -g {rg} -n {env} --storage-limit-exceeded-behavior PurgeOldData

Required Parameters

--name -n

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

Optional Parameters

--data-retention-time

The minimum number of days the environment's events will be available for query.

--no-wait

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

--partition-key-properties

The list of event properties which will be used to partition data in the environment.

--sku-capacity

The capacity of the sku. For standard environments, this value can be changed to support scale out of environments after they have been created.

--sku-name

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

accepted values: L1, P1, S1, S2
--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
--tags

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