Microsoft.TimeSeriesInsights environments 2018-08-15-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@2018-08-15-preview' = {
  location: 'string'
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  kind: 'string'
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments objects
}

Microsoft.TimeSeriesInsights/environments objects

Set the kind property to specify the type of object.

For LongTerm, use:

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

For Standard, use:

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

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'LongTerm' (required)
properties	Properties used to create a long-term environment.	LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties (required)

LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties

Name	Description	Value
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.	LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput (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

LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput

Name	Description	Value
accountName	The name of the storage account that will hold the environment's long term 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)

Microsoft.TimeSeriesInsights/environments

Name	Description	Value
kind	Set to 'LongTerm' for type LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource. Set to 'Standard' for type StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource.	'LongTerm' 'Standard' (required)
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
sku	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.	Sku (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Sku

Name	Description	Value
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.	int Constraints: Min value = 1 Max value = 10 (required)
name	The name of this SKU.	'L1' 'P1' 'S1' 'S2' (required)

StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'Standard' (required)
properties	Properties used to create a standard environment.	StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties (required)

StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties

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'

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)

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.

{
  "location": "string",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "kind": "string"
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments objects
}

Microsoft.TimeSeriesInsights/environments objects

Set the kind property to specify the type of object.

For LongTerm, use:

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

For Standard, use:

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

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'LongTerm' (required)
properties	Properties used to create a long-term environment.	LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties (required)

LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties

Name	Description	Value
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.	LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput (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

LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput

Name	Description	Value
accountName	The name of the storage account that will hold the environment's long term 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)

Microsoft.TimeSeriesInsights/environments

Name	Description	Value
apiVersion	The api version	'2018-08-15-preview'
kind	Set to 'LongTerm' for type LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource. Set to 'Standard' for type StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource.	'LongTerm' 'Standard' (required)
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
sku	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.	Sku (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.TimeSeriesInsights/environments'

Sku

Name	Description	Value
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.	int Constraints: Min value = 1 Max value = 10 (required)
name	The name of this SKU.	'L1' 'P1' 'S1' 'S2' (required)

StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'Standard' (required)
properties	Properties used to create a standard environment.	StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties (required)

StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties

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'

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)

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" {
  location = "string"
  name = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  kind = "string"
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments objects
}

Microsoft.TimeSeriesInsights/environments objects

Set the kind property to specify the type of object.

For LongTerm, use:

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

For Standard, use:

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

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'LongTerm' (required)
properties	Properties used to create a long-term environment.	LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties (required)

LongTermEnvironmentCreationPropertiesOrLongTermEnvironmentResourceProperties

Name	Description	Value
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.	LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput (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

LongTermStorageConfigurationInputOrLongTermStorageConfigurationOutput

Name	Description	Value
accountName	The name of the storage account that will hold the environment's long term 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)

Microsoft.TimeSeriesInsights/environments

Name	Description	Value
kind	Set to 'LongTerm' for type LongTermEnvironmentCreateOrUpdateParametersOrLongTermEnvironmentResource. Set to 'Standard' for type StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource.	'LongTerm' 'Standard' (required)
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
sku	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.	Sku (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.TimeSeriesInsights/environments@2018-08-15-preview"

Sku

Name	Description	Value
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.	int Constraints: Min value = 1 Max value = 10 (required)
name	The name of this SKU.	'L1' 'P1' 'S1' 'S2' (required)

StandardEnvironmentCreateOrUpdateParametersOrStandardEnvironmentResource

Name	Description	Value
kind	The kind of the environment.	'Standard' (required)
properties	Properties used to create a standard environment.	StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties (required)

StandardEnvironmentCreationPropertiesOrStandardEnvironmentResourceProperties

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'

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)