Microsoft.TimeSeriesInsights environments 2017-02-28-preview

The environments resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.TimeSeriesInsights/environments resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.TimeSeriesInsights/environments@2017-02-28-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  properties: {
    dataRetentionTime: 'string'
    storageLimitExceededBehavior: 'string'
  }
}

Property values

environments

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.TimeSeriesInsights/environments'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-02-28-preview'
name The resource name string (required)
location The location of the resource. string (required)
tags Key-value pairs of additional properties for the resource. Dictionary of tag names and values. See Tags in templates
sku The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate. Sku (required)
properties Properties used to create an environment. EnvironmentCreationProperties (required)

EnvironmentCreationProperties

Name Description Value
dataRetentionTime ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. string (required)
storageLimitExceededBehavior 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. 'PauseIngress'
'PurgeOldData'

Sku

Name Description Value
capacity The capacity of the sku. This value can be changed to support scale out of environments after they have been created. int (required)
name The name of this SKU. 'S1'
'S2'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Pay As You Go (PAYG) Environment with an IoT Hub

Deploy to Azure
This template enables you to deploy a Pay As You Go (PAYG) Time Series Insights environment that is configured to consume events from an IoT Hub.
Create an Environment with an Event Hub Event Source

Deploy to Azure
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.