Microsoft.TimeSeriesInsights environments 2021-03-31-preview

• Latest
• 2021-06-30-preview
• 2021-03-31-preview
• 2020-05-15
• 2018-08-15-preview
• 2017-11-15
• 2017-02-28-preview

Bicep resource definition

The environments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.TimeSeriesInsights/environments@2021-03-31-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  kind: 'string'
  // For remaining properties, see environments objects
}

environments objects

Set the kind property to specify the type of object.

For Gen1, use:

  kind: 'Gen1'
  properties: {
    dataRetentionTime: 'string'
    partitionKeyProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    storageLimitExceededBehavior: 'string'
  }

For Gen2, use:

  kind: 'Gen2'
  properties: {
    publicNetworkAccess: 'string'
    storageConfiguration: {
      accountName: 'string'
      managementKey: 'string'
    }
    timeSeriesIdProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    warmStoreConfiguration: {
      dataRetention: 'string'
    }
  }

Property values

environments

Name	Description	Value
name	The resource name	string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters
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 type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.	Sku (required)
kind	Set the object type	Gen1 Gen2 (required)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Name	Description	Value
kind	The kind of the environment.	'Gen1' (required)
properties	Properties used to create a Gen1 environment.	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (required)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Name	Description	Value
dataRetentionTime	ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.	string (required)
partitionKeyProperties	The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.	TimeSeriesIdProperty[]
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'

TimeSeriesIdProperty

Name	Description	Value
name	The name of the property.	string
type	The type of the property.	'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Name	Description	Value
kind	The kind of the environment.	'Gen2' (required)
properties	Properties used to create a Gen2 environment.	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (required)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Name	Description	Value
publicNetworkAccess	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.	'disabled' 'enabled'
storageConfiguration	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.	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (required)
timeSeriesIdProperties	The list of event properties which will be used to define the environment's time series id.	TimeSeriesIdProperty[] (required)
warmStoreConfiguration	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.	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	Description	Value
accountName	The name of the storage account that will hold the environment's Gen2 data.	string (required)
managementKey	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.	string (required)

WarmStoreConfigurationProperties

Name	Description	Value
dataRetention	ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.	string (required)

Sku

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Pay As You Go (PAYG) Environment with an IoT Hub	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	This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.

ARM template resource definition

The environments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.TimeSeriesInsights/environments",
  "apiVersion": "2021-03-31-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "kind": "string",
  // For remaining properties, see environments objects
}

environments objects

Set the kind property to specify the type of object.

For Gen1, use:

  "kind": "Gen1",
  "properties": {
    "dataRetentionTime": "string",
    "partitionKeyProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "storageLimitExceededBehavior": "string"
  }

For Gen2, use:

  "kind": "Gen2",
  "properties": {
    "publicNetworkAccess": "string",
    "storageConfiguration": {
      "accountName": "string",
      "managementKey": "string"
    },
    "timeSeriesIdProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "warmStoreConfiguration": {
      "dataRetention": "string"
    }
  }

Property values

environments

Name	Description	Value
type	The resource type	'Microsoft.TimeSeriesInsights/environments'
apiVersion	The resource api version	'2021-03-31-preview'
name	The resource name	string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters
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 type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.	Sku (required)
kind	Set the object type	Gen1 Gen2 (required)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Name	Description	Value
kind	The kind of the environment.	'Gen1' (required)
properties	Properties used to create a Gen1 environment.	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (required)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Name	Description	Value
dataRetentionTime	ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.	string (required)
partitionKeyProperties	The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.	TimeSeriesIdProperty[]
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'

TimeSeriesIdProperty

Name	Description	Value
name	The name of the property.	string
type	The type of the property.	'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Name	Description	Value
kind	The kind of the environment.	'Gen2' (required)
properties	Properties used to create a Gen2 environment.	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (required)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Name	Description	Value
publicNetworkAccess	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.	'disabled' 'enabled'
storageConfiguration	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.	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (required)
timeSeriesIdProperties	The list of event properties which will be used to define the environment's time series id.	TimeSeriesIdProperty[] (required)
warmStoreConfiguration	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.	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	Description	Value
accountName	The name of the storage account that will hold the environment's Gen2 data.	string (required)
managementKey	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.	string (required)

WarmStoreConfigurationProperties

Name	Description	Value
dataRetention	ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.	string (required)

Sku

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Pay As You Go (PAYG) Environment with an IoT Hub	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	This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.

Terraform (AzAPI provider) resource definition

The environments resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments@2021-03-31-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  // For remaining properties, see environments objects
  body = jsonencode({
    sku = {
      capacity = int
      name = "string"
    }
    kind = "string"
  })
}

environments objects

Set the kind property to specify the type of object.

For Gen1, use:

  kind = "Gen1"
  properties = {
    dataRetentionTime = "string"
    partitionKeyProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    storageLimitExceededBehavior = "string"
  }

For Gen2, use:

  kind = "Gen2"
  properties = {
    publicNetworkAccess = "string"
    storageConfiguration = {
      accountName = "string"
      managementKey = "string"
    }
    timeSeriesIdProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    warmStoreConfiguration = {
      dataRetention = "string"
    }
  }

Property values

environments

Name	Description	Value
type	The resource type	"Microsoft.TimeSeriesInsights/environments@2021-03-31-preview"
name	The resource name	string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters
location	The location of the resource.	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Key-value pairs of additional properties for the resource.	Dictionary of tag names and values.
sku	The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.	Sku (required)
kind	Set the object type	Gen1 Gen2 (required)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Name	Description	Value
kind	The kind of the environment.	"Gen1" (required)
properties	Properties used to create a Gen1 environment.	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (required)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Name	Description	Value
dataRetentionTime	ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.	string (required)
partitionKeyProperties	The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.	TimeSeriesIdProperty[]
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"

TimeSeriesIdProperty

Name	Description	Value
name	The name of the property.	string
type	The type of the property.	"String"

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Name	Description	Value
kind	The kind of the environment.	"Gen2" (required)
properties	Properties used to create a Gen2 environment.	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (required)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Name	Description	Value
publicNetworkAccess	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.	"disabled" "enabled"
storageConfiguration	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.	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (required)
timeSeriesIdProperties	The list of event properties which will be used to define the environment's time series id.	TimeSeriesIdProperty[] (required)
warmStoreConfiguration	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.	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	Description	Value
accountName	The name of the storage account that will hold the environment's Gen2 data.	string (required)
managementKey	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.	string (required)

WarmStoreConfigurationProperties

Name	Description	Value
dataRetention	ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.	string (required)

Sku

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