你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.TimeSeriesInsights 环境 2021-03-31-preview
Bicep 资源定义
可以使用目标操作部署环境资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.TimeSeriesInsights/environments@2021-03-31-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 对象
设置 类型 属性以指定对象的类型。
对于 Gen1，请使用：
{
kind: 'Gen1'
properties: {
dataRetentionTime: 'string'
partitionKeyProperties: [
{
name: 'string'
type: 'string'
}
]
storageLimitExceededBehavior: 'string'
}
}
对于 Gen2，请使用：
{
kind: 'Gen2'
properties: {
publicNetworkAccess: 'string'
storageConfiguration: {
accountName: 'string'
managementKey: 'string'
}
timeSeriesIdProperties: [
{
name: 'string'
type: 'string'
}
]
warmStoreConfiguration: {
dataRetention: 'string'
}
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen1”（必需） |
| 性能 | 用于创建 Gen1 环境的属性。 | Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties（必需） |
Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetentionTime | ISO8601时间跨度，指定环境事件可用于查询的最小天数。 | string （必需） |
| partitionKeyProperties | 将用于对环境中的数据进行分区的事件属性列表。 目前，仅支持单个分区键属性。 | TimeSeriesIdProperty[] |
| storageLimitExceededBehavior | 超出环境容量时，时序见解服务应采用的行为。 如果指定了“PauseIngress”，则不会从事件源读取新事件。 如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。 默认行为为 PurgeOldData。 | “PauseIngress” “PurgeOldData” |
Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen2”（必需） |
| 性能 | 用于创建 Gen2 环境的属性。 | Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties（必需） |
Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| publicNetworkAccess | 此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。 | “disabled” “enabled” |
| storageConfiguration | 存储配置提供连接详细信息，允许时序见解服务连接到用于存储环境数据的客户存储帐户。 | Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput（必需） |
| timeSeriesIdProperties | 用于定义环境的时序 ID 的事件属性列表。 | TimeSeriesIdProperty[] （必需） |
| warmStoreConfiguration | 暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。 | WarmStoreConfigurationProperties |
Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput
| 名字 | 描述 | 价值 |
|---|---|---|
| accountName | 将保存环境的 Gen2 数据的存储帐户的名称。 | string （必需） |
| managementKey | 授予时序见解服务对存储帐户的写入访问权限的管理密钥的值。 环境响应中未显示此属性。 | string （必需） |
Microsoft.TimeSeriesInsights/environments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 type Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource，设置为“Gen1”。 对于 type Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource，设置为“Gen2”。 | “Gen1” “Gen2”（必需） |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| sku | SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。 对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。 | Sku（必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
Sku
| 名字 | 描述 | 价值 |
|---|---|---|
| 能力 | SKU 的容量。 对于 Gen1 环境，此值可以更改为支持在创建环境后横向扩展环境。 | int 约束： 最小值 = 1 最大值 = 10 （必需） |
| 名字 | 此 SKU 的名称。 | “L1” “P1” “S1” “S2”（必需） |
TimeSeriesIdProperty
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 属性的名称。 | 字符串 |
| 类型 | 属性的类型。 | “String” |
WarmStoreConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetention | ISO8601时间跨度，指定环境事件将可用于从暖存储进行查询的天数。 | string （必需） |
ARM 模板资源定义
可以使用目标操作部署环境资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 JSON 添加到模板。
{
"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 对象
设置 类型 属性以指定对象的类型。
对于 Gen1，请使用：
{
"kind": "Gen1",
"properties": {
"dataRetentionTime": "string",
"partitionKeyProperties": [
{
"name": "string",
"type": "string"
}
],
"storageLimitExceededBehavior": "string"
}
}
对于 Gen2，请使用：
{
"kind": "Gen2",
"properties": {
"publicNetworkAccess": "string",
"storageConfiguration": {
"accountName": "string",
"managementKey": "string"
},
"timeSeriesIdProperties": [
{
"name": "string",
"type": "string"
}
],
"warmStoreConfiguration": {
"dataRetention": "string"
}
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen1”（必需） |
| 性能 | 用于创建 Gen1 环境的属性。 | Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties（必需） |
Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetentionTime | ISO8601时间跨度，指定环境事件可用于查询的最小天数。 | string （必需） |
| partitionKeyProperties | 将用于对环境中的数据进行分区的事件属性列表。 目前，仅支持单个分区键属性。 | TimeSeriesIdProperty[] |
| storageLimitExceededBehavior | 超出环境容量时，时序见解服务应采用的行为。 如果指定了“PauseIngress”，则不会从事件源读取新事件。 如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。 默认行为为 PurgeOldData。 | “PauseIngress” “PurgeOldData” |
Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen2”（必需） |
| 性能 | 用于创建 Gen2 环境的属性。 | Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties（必需） |
Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| publicNetworkAccess | 此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。 | “disabled” “enabled” |
| storageConfiguration | 存储配置提供连接详细信息，允许时序见解服务连接到用于存储环境数据的客户存储帐户。 | Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput（必需） |
| timeSeriesIdProperties | 用于定义环境的时序 ID 的事件属性列表。 | TimeSeriesIdProperty[] （必需） |
| warmStoreConfiguration | 暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。 | WarmStoreConfigurationProperties |
Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput
| 名字 | 描述 | 价值 |
|---|---|---|
| accountName | 将保存环境的 Gen2 数据的存储帐户的名称。 | string （必需） |
| managementKey | 授予时序见解服务对存储帐户的写入访问权限的管理密钥的值。 环境响应中未显示此属性。 | string （必需） |
Microsoft.TimeSeriesInsights/environments
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2021-03-31-preview' |
| 类 | 对于 type Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource，设置为“Gen1”。 对于 type Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource，设置为“Gen2”。 | “Gen1” “Gen2”（必需） |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| sku | SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。 对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。 | Sku（必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.TimeSeriesInsights/environments” |
Sku
| 名字 | 描述 | 价值 |
|---|---|---|
| 能力 | SKU 的容量。 对于 Gen1 环境，此值可以更改为支持在创建环境后横向扩展环境。 | int 约束： 最小值 = 1 最大值 = 10 （必需） |
| 名字 | 此 SKU 的名称。 | “L1” “P1” “S1” “S2”（必需） |
TimeSeriesIdProperty
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 属性的名称。 | 字符串 |
| 类型 | 属性的类型。 | “String” |
WarmStoreConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetention | ISO8601时间跨度，指定环境事件将可用于从暖存储进行查询的天数。 | string （必需） |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
使用 IoT 中心创建即用即付（PAYG）环境
|
使用此模板，可以部署配置为使用 IoT 中心的事件的即用即付（PAYG）时序见解环境。 |
|
使用事件中心事件源创建环境
|
使用此模板，可以部署配置为使用事件中心的事件的时序见解环境。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署环境资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments 资源，请将以下 Terraform 添加到模板。
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 对象
设置 类型 属性以指定对象的类型。
对于 Gen1，请使用：
{
kind = "Gen1"
properties = {
dataRetentionTime = "string"
partitionKeyProperties = [
{
name = "string"
type = "string"
}
]
storageLimitExceededBehavior = "string"
}
}
对于 Gen2，请使用：
{
kind = "Gen2"
properties = {
publicNetworkAccess = "string"
storageConfiguration = {
accountName = "string"
managementKey = "string"
}
timeSeriesIdProperties = [
{
name = "string"
type = "string"
}
]
warmStoreConfiguration = {
dataRetention = "string"
}
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen1”（必需） |
| 性能 | 用于创建 Gen1 环境的属性。 | Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties（必需） |
Gen1EnvironmentCreationPropertiesOrGen1EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetentionTime | ISO8601时间跨度，指定环境事件可用于查询的最小天数。 | string （必需） |
| partitionKeyProperties | 将用于对环境中的数据进行分区的事件属性列表。 目前，仅支持单个分区键属性。 | TimeSeriesIdProperty[] |
| storageLimitExceededBehavior | 超出环境容量时，时序见解服务应采用的行为。 如果指定了“PauseIngress”，则不会从事件源读取新事件。 如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。 默认行为为 PurgeOldData。 | “PauseIngress” “PurgeOldData” |
Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 环境的类型。 | “Gen2”（必需） |
| 性能 | 用于创建 Gen2 环境的属性。 | Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties（必需） |
Gen2EnvironmentCreationPropertiesOrGen2EnvironmentResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| publicNetworkAccess | 此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。 | “disabled” “enabled” |
| storageConfiguration | 存储配置提供连接详细信息，允许时序见解服务连接到用于存储环境数据的客户存储帐户。 | Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput（必需） |
| timeSeriesIdProperties | 用于定义环境的时序 ID 的事件属性列表。 | TimeSeriesIdProperty[] （必需） |
| warmStoreConfiguration | 暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。 | WarmStoreConfigurationProperties |
Gen2StorageConfigurationInputOrGen2StorageConfigurationOutput
| 名字 | 描述 | 价值 |
|---|---|---|
| accountName | 将保存环境的 Gen2 数据的存储帐户的名称。 | string （必需） |
| managementKey | 授予时序见解服务对存储帐户的写入访问权限的管理密钥的值。 环境响应中未显示此属性。 | string （必需） |
Microsoft.TimeSeriesInsights/environments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 type Gen1EnvironmentCreateOrUpdateParametersOrGen1EnvironmentResource，设置为“Gen1”。 对于 type Gen2EnvironmentCreateOrUpdateParametersOrGen2EnvironmentResource，设置为“Gen2”。 | “Gen1” “Gen2”（必需） |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| sku | SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。 对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。 | Sku（必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.TimeSeriesInsights/environments@2021-03-31-preview” |
Sku
| 名字 | 描述 | 价值 |
|---|---|---|
| 能力 | SKU 的容量。 对于 Gen1 环境，此值可以更改为支持在创建环境后横向扩展环境。 | int 约束： 最小值 = 1 最大值 = 10 （必需） |
| 名字 | 此 SKU 的名称。 | “L1” “P1” “S1” “S2”（必需） |
TimeSeriesIdProperty
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 属性的名称。 | 字符串 |
| 类型 | 属性的类型。 | “String” |
WarmStoreConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataRetention | ISO8601时间跨度，指定环境事件将可用于从暖存储进行查询的天数。 | string （必需） |