Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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-02-28-preview' = {
location: 'string'
name: 'string'
properties: {
dataRetentionTime: 'string'
storageLimitExceededBehavior: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.TimeSeriesInsights/environments
| Name | Description | Value |
|---|---|---|
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Properties used to create an environment. | EnvironmentCreationPropertiesOrEnvironmentResourceProperties (required) |
| sku | The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CreateOrUpdateTrackedResourcePropertiesTags
| Name | Description | Value |
|---|
EnvironmentCreationPropertiesOrEnvironmentResourceProperties
| 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 Constraints: Min value = 1 Max value = 10 (required) |
| name | The name of this SKU. | 'S1' 'S2' (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.
{
"type": "Microsoft.TimeSeriesInsights/environments",
"apiVersion": "2017-02-28-preview",
"name": "string",
"location": "string",
"properties": {
"dataRetentionTime": "string",
"storageLimitExceededBehavior": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.TimeSeriesInsights/environments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-02-28-preview' |
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Properties used to create an environment. | EnvironmentCreationPropertiesOrEnvironmentResourceProperties (required) |
| sku | The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), 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' |
CreateOrUpdateTrackedResourcePropertiesTags
| Name | Description | Value |
|---|
EnvironmentCreationPropertiesOrEnvironmentResourceProperties
| 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 Constraints: Min value = 1 Max value = 10 (required) |
| name | The name of this SKU. | 'S1' 'S2' (required) |
Usage Examples
Azure Quickstart Templates
The following Azure 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-02-28-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
dataRetentionTime = "string"
storageLimitExceededBehavior = "string"
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
Microsoft.TimeSeriesInsights/environments
| Name | Description | Value |
|---|---|---|
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Properties used to create an environment. | EnvironmentCreationPropertiesOrEnvironmentResourceProperties (required) |
| sku | The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.TimeSeriesInsights/environments@2017-02-28-preview" |
CreateOrUpdateTrackedResourcePropertiesTags
| Name | Description | Value |
|---|
EnvironmentCreationPropertiesOrEnvironmentResourceProperties
| 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 Constraints: Min value = 1 Max value = 10 (required) |
| name | The name of this SKU. | 'S1' 'S2' (required) |