你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.TimeSeriesInsights 环境 2017-11-15

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

Bicep 资源定义

可以使用面向以下操作部署环境资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 Bicep 添加到模板。

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'
  }
}

属性值

environments

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-90 有效字符： 不得使用： '<>%&:\?/# 或控制字符
location	资源的位置。	字符串 (必需)
标记	资源的附加属性的键值对。	标记名称和值的字典。 请参阅 模板中的标记
sku	SKU 确定环境的容量、每分钟查询数中的 SLA (、总容量) 以及计费费率。	需要 sku ()
properties	用于创建环境的属性。	EnvironmentCreationPropertiesOrEnvironmentResourcePr... 所需的 ()

EnvironmentCreationPropertiesOrEnvironmentResourcePr...

名称	说明	值
dataRetentionTime	ISO8601 时间跨度，指定环境事件可用于查询的最小天数。	字符串 (必需)
partitionKeyProperties	根据该列表对环境中的数据进行排序的分区键列表。	PartitionKeyProperty[]
storageLimitExceededBehavior	超过环境容量时，时序见解服务应采取的行为。 如果指定了“PauseIngress”，则不会从事件源中读取新事件。 如果指定了“PurgeOldData”，将继续读取新事件，并从环境中删除旧事件。 默认行为为 PurgeOldData。	'PauseIngress' “PurgeOldData”

PartitionKeyProperty

名称	说明	值
name	属性的名称。	string
type	属性的类型。	'String'

SKU

名称	说明	值
容量	SKU 的容量。 可以更改此值，以支持在创建环境后横向扩展环境。	int (必需)
name	此 SKU 的名称。	'S1' 需要“S2” ()

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用IoT 中心创建即用即付 (PAYG) 环境	此模板使你能够部署即用即付 (PAYG) 时序见解环境，该环境配置为使用IoT 中心中的事件。
使用事件中心事件源创建环境	使用此模板，可以部署配置为使用事件中心的事件的时序见解环境。

ARM 模板资源定义

可以使用面向以下操作部署环境资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 JSON 添加到模板。

{
  "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"
  }
}

属性值

environments

名称	说明	Value
type	资源类型	“Microsoft.TimeSeriesInsights/environments”
apiVersion	资源 API 版本	'2017-11-15'
name	资源名称	字符串 (必需) 字符限制：1-90 有效字符： 不得使用： '<>%&:\?/# 或控制字符
location	资源的位置。	字符串 (必需)
标记	资源的附加属性的键值对。	标记名称和值的字典。 请参阅 模板中的标记
sku	SKU 确定环境的容量、每分钟查询数中的 SLA (和总容量) ，以及计费费率。	需要 sku ()
properties	用于创建环境的属性。	EnvironmentCreationPropertiesOrEnvironmentResourcePr... 所需的 ()

EnvironmentCreationPropertiesOrEnvironmentResourcePr...

名称	说明	值
dataRetentionTime	ISO8601 时间跨度，指定环境事件可供查询的最小天数。	字符串 (必需)
partitionKeyProperties	将依据环境中的数据排序的分区键列表。	PartitionKeyProperty[]
storageLimitExceededBehavior	时序见解服务在超出环境的容量时应采取的行为。 如果指定了“PauseIngress”，则不会从事件源中读取新事件。 如果指定了“PurgeOldData”，将继续读取新事件，并从环境中删除旧事件。 默认行为为 PurgeOldData。	“PauseIngress” “PurgeOldData”

PartitionKeyProperty

名称	说明	值
name	属性的名称。	string
type	属性的类型。	“String”

SKU

名称	说明	值
容量	SKU 的容量。 可以更改此值，以支持在创建环境后横向扩展环境。	int (必需)
name	此 SKU 的名称。	“S1” “S2” (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用 IoT 中心 (PAYG) 环境创建即用即付	使用此模板，可以部署一个即用即付 (PAYG) 时序见解环境，该环境配置为使用IoT 中心中的事件。
使用事件中心事件源创建环境	通过此模板，可以部署配置为使用事件中心的事件的时序见解环境。

Terraform (AzAPI 提供程序) 资源定义

环境资源类型可以使用面向以下对象的操作进行部署：

• 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 Terraform 添加到模板。

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"
    }
  })
}

属性值

environments

名称	说明	Value
type	资源类型	“Microsoft.TimeSeriesInsights/environments@2017-11-15”
name	资源名称	字符串 (必需) 字符限制：1-90 有效字符： 不得使用： '<>%&:\?/# 或控制字符
location	资源的位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源的附加属性的键值对。	标记名称和值的字典。
sku	SKU 确定环境的容量、每分钟查询数中的 SLA (、总容量) 以及计费费率。	需要 sku ()
properties	用于创建环境的属性。	EnvironmentCreationPropertiesOrEnvironmentResourcePr... 所需的 ()

EnvironmentCreationPropertiesOrEnvironmentResourcePr...

名称	说明	值
dataRetentionTime	ISO8601 时间跨度，指定环境事件可用于查询的最小天数。	字符串 (必需)
partitionKeyProperties	根据该列表对环境中的数据进行排序的分区键列表。	PartitionKeyProperty[]
storageLimitExceededBehavior	超过环境容量时，时序见解服务应采取的行为。 如果指定了“PauseIngress”，则不会从事件源中读取新事件。 如果指定了“PurgeOldData”，将继续读取新事件，并从环境中删除旧事件。 默认行为为 PurgeOldData。	“PauseIngress” “PurgeOldData”

PartitionKeyProperty

名称	说明	值
name	属性的名称。	string
type	属性的类型。	“String”

SKU

名称	说明	值
容量	SKU 的容量。 可以更改此值，以支持在创建环境后横向扩展环境。	int (必需)
name	此 SKU 的名称。	“S1” 需要“S2” ()