Microsoft.TimeSeriesInsights environments 2017-11-15
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@2017-11-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
properties: {
dataRetentionTime: 'string'
partitionKeyProperties: [
{
name: 'string'
type: 'String'
}
]
storageLimitExceededBehavior: '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 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. | EnvironmentCreationPropertiesOrEnvironmentResourcePr... (required) |
EnvironmentCreationPropertiesOrEnvironmentResourcePr...
| 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 partition keys according to which the data in the environment will be ordered. | PartitionKeyProperty[] |
| 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' |
PartitionKeyProperty
| Name | Description | Value |
|---|---|---|
| name | The name of the property. | string |
| type | The type of the property. | 'String' |
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' (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": "2017-11-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"properties": {
"dataRetentionTime": "string",
"partitionKeyProperties": [
{
"name": "string",
"type": "String"
}
],
"storageLimitExceededBehavior": "string"
}
}
Property values
environments
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.TimeSeriesInsights/environments' |
| apiVersion | The resource api version | '2017-11-15' |
| 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 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. | EnvironmentCreationPropertiesOrEnvironmentResourcePr... (required) |
EnvironmentCreationPropertiesOrEnvironmentResourcePr...
| 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 partition keys according to which the data in the environment will be ordered. | PartitionKeyProperty[] |
| 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' |
PartitionKeyProperty
| Name | Description | Value |
|---|---|---|
| name | The name of the property. | string |
| type | The type of the property. | 'String' |
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' (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@2017-11-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
dataRetentionTime = "string"
partitionKeyProperties = [
{
name = "string"
type = "String"
}
]
storageLimitExceededBehavior = "string"
}
sku = {
capacity = int
name = "string"
}
})
}
Property values
environments
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.TimeSeriesInsights/environments@2017-11-15" |
| 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 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. | EnvironmentCreationPropertiesOrEnvironmentResourcePr... (required) |
EnvironmentCreationPropertiesOrEnvironmentResourcePr...
| 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 partition keys according to which the data in the environment will be ordered. | PartitionKeyProperty[] |
| 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" |
PartitionKeyProperty
| Name | Description | Value |
|---|---|---|
| name | The name of the property. | string |
| type | The type of the property. | "String" |
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" (required) |