你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.TimeSeriesInsights 环境/eventSources 2018-08-15-preview
Bicep 资源定义
可以使用目标操作部署环境/eventSources 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments/eventSources 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview' = {
localTimestamp: {
format: 'string'
timeZoneOffset: {
propertyName: 'string'
}
}
location: 'string'
name: 'string'
tags: {
{customized property}: 'string'
}
kind: 'string'
// For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}
Microsoft.TimeSeriesInsights/environments/eventSources 对象
设置 类型 属性以指定对象的类型。
对于 Microsoft.EventHub，请使用：
{
kind: 'Microsoft.EventHub'
properties: {
consumerGroupName: 'string'
eventHubName: 'string'
eventSourceResourceId: 'string'
keyName: 'string'
serviceBusNamespace: 'string'
sharedAccessKey: 'string'
timestampPropertyName: 'string'
}
}
对于 Microsoft.IoTHub，请使用：
{
kind: 'Microsoft.IoTHub'
properties: {
consumerGroupName: 'string'
eventSourceResourceId: 'string'
iotHubName: 'string'
keyName: 'string'
sharedAccessKey: 'string'
timestampPropertyName: 'string'
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.EventHub”（必需） |
| 性能 | 创建或更新请求时所需的 EventHub 事件源的属性。 | EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties（必需） |
EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 事件中心使用者组的名称，该组包含要从中读取事件的分区。 | string （必需） |
| eventHubName | 事件中心的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| keyName | 授予时序见解服务访问事件中心的 SAS 密钥的名称。 此密钥的共享访问策略必须向事件中心授予“侦听”权限。 | string （必需） |
| serviceBusNamespace | 包含事件中心的服务总线的名称。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对事件中心的读取访问权限的共享访问密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.IoTHub”（必需） |
| 性能 | 创建或更新请求时所需的 IoTHub 事件源的属性。 | IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties（必需） |
IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 用于保存要从中读取事件的分区的 iot 中心的使用者组的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| iotHubName | iot 中心的名称。 | string （必需） |
| keyName | 授予时序见解服务对 iot 中心的访问权限的共享访问策略密钥的名称。 此共享访问策略密钥必须向 iot 中心授予“服务连接”权限。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对 iot 中心的读取访问权限的共享访问策略密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
LocalTimestamp
| 名字 | 描述 | 价值 |
|---|---|---|
| 格式 | 一个枚举，表示需要设置的本地时间戳属性的格式。 | “Embedded” |
| timeZoneOffset | 一个对象，表示指定的本地时间戳格式的偏移信息。 不应为 LocalTimestampFormat - Embedded 指定。 | LocalTimestampTimeZoneOffset |
LocalTimestampTimeZoneOffset
| 名字 | 描述 | 价值 |
|---|---|---|
| propertyName | 将包含偏移信息以计算本地时间戳的事件属性。 LocalTimestampFormat 为 Iana 时，属性名称将包含包含 IANA 时区名称的列的名称（例如：美洲/洛杉矶）。 LocalTimestampFormat 为 Timespan 时，它包含表示偏移量的值的属性的名称（例如：P1D 或 1.00：00：00） | 字符串 |
Microsoft.TimeSeriesInsights/environments/eventSources
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource，设置为“Microsoft.EventHub”。 对于 IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource，请设置为“Microsoft.IoTHub”。 | “Microsoft.EventHub” “Microsoft.IoTHub”（必需） |
| localTimestamp | 一个表示本地时间戳属性的对象。 它包含需要使用的本地时间戳的格式以及相应的时区偏移信息。 如果未为 localTimestamp 指定值，或为 null，则不会使用事件传入本地时间戳。 | LocalTimestamp |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：环境 |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ARM 模板资源定义
可以使用目标操作部署环境/eventSources 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments/eventSources 资源，请将以下 JSON 添加到模板。
{
"localTimestamp": {
"format": "string",
"timeZoneOffset": {
"propertyName": "string"
}
},
"location": "string",
"name": "string",
"tags": {
"{customized property}": "string"
},
"kind": "string"
// For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}
Microsoft.TimeSeriesInsights/environments/eventSources 对象
设置 类型 属性以指定对象的类型。
对于 Microsoft.EventHub，请使用：
{
"kind": "Microsoft.EventHub",
"properties": {
"consumerGroupName": "string",
"eventHubName": "string",
"eventSourceResourceId": "string",
"keyName": "string",
"serviceBusNamespace": "string",
"sharedAccessKey": "string",
"timestampPropertyName": "string"
}
}
对于 Microsoft.IoTHub，请使用：
{
"kind": "Microsoft.IoTHub",
"properties": {
"consumerGroupName": "string",
"eventSourceResourceId": "string",
"iotHubName": "string",
"keyName": "string",
"sharedAccessKey": "string",
"timestampPropertyName": "string"
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.EventHub”（必需） |
| 性能 | 创建或更新请求时所需的 EventHub 事件源的属性。 | EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties（必需） |
EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 事件中心使用者组的名称，该组包含要从中读取事件的分区。 | string （必需） |
| eventHubName | 事件中心的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| keyName | 授予时序见解服务访问事件中心的 SAS 密钥的名称。 此密钥的共享访问策略必须向事件中心授予“侦听”权限。 | string （必需） |
| serviceBusNamespace | 包含事件中心的服务总线的名称。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对事件中心的读取访问权限的共享访问密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.IoTHub”（必需） |
| 性能 | 创建或更新请求时所需的 IoTHub 事件源的属性。 | IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties（必需） |
IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 用于保存要从中读取事件的分区的 iot 中心的使用者组的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| iotHubName | iot 中心的名称。 | string （必需） |
| keyName | 授予时序见解服务对 iot 中心的访问权限的共享访问策略密钥的名称。 此共享访问策略密钥必须向 iot 中心授予“服务连接”权限。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对 iot 中心的读取访问权限的共享访问策略密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
LocalTimestamp
| 名字 | 描述 | 价值 |
|---|---|---|
| 格式 | 一个枚举，表示需要设置的本地时间戳属性的格式。 | “Embedded” |
| timeZoneOffset | 一个对象，表示指定的本地时间戳格式的偏移信息。 不应为 LocalTimestampFormat - Embedded 指定。 | LocalTimestampTimeZoneOffset |
LocalTimestampTimeZoneOffset
| 名字 | 描述 | 价值 |
|---|---|---|
| propertyName | 将包含偏移信息以计算本地时间戳的事件属性。 LocalTimestampFormat 为 Iana 时，属性名称将包含包含 IANA 时区名称的列的名称（例如：美洲/洛杉矶）。 LocalTimestampFormat 为 Timespan 时，它包含表示偏移量的值的属性的名称（例如：P1D 或 1.00：00：00） | 字符串 |
Microsoft.TimeSeriesInsights/environments/eventSources
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-08-15-preview' |
| 类 | 对于 type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource，设置为“Microsoft.EventHub”。 对于 IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource，请设置为“Microsoft.IoTHub”。 | “Microsoft.EventHub” “Microsoft.IoTHub”（必需） |
| localTimestamp | 一个表示本地时间戳属性的对象。 它包含需要使用的本地时间戳的格式以及相应的时区偏移信息。 如果未为 localTimestamp 指定值，或为 null，则不会使用事件传入本地时间戳。 | LocalTimestamp |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.TimeSeriesInsights/environments/eventSources” |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署环境/eventSources 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.TimeSeriesInsights/environments/eventSources 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
localTimestamp = {
format = "string"
timeZoneOffset = {
propertyName = "string"
}
}
location = "string"
name = "string"
tags = {
{customized property} = "string"
}
kind = "string"
// For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}
Microsoft.TimeSeriesInsights/environments/eventSources 对象
设置 类型 属性以指定对象的类型。
对于 Microsoft.EventHub，请使用：
{
kind = "Microsoft.EventHub"
properties = {
consumerGroupName = "string"
eventHubName = "string"
eventSourceResourceId = "string"
keyName = "string"
serviceBusNamespace = "string"
sharedAccessKey = "string"
timestampPropertyName = "string"
}
}
对于 Microsoft.IoTHub，请使用：
{
kind = "Microsoft.IoTHub"
properties = {
consumerGroupName = "string"
eventSourceResourceId = "string"
iotHubName = "string"
keyName = "string"
sharedAccessKey = "string"
timestampPropertyName = "string"
}
}
属性值
CreateOrUpdateTrackedResourcePropertiesTags
| 名字 | 描述 | 价值 |
|---|
EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.EventHub”（必需） |
| 性能 | 创建或更新请求时所需的 EventHub 事件源的属性。 | EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties（必需） |
EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 事件中心使用者组的名称，该组包含要从中读取事件的分区。 | string （必需） |
| eventHubName | 事件中心的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| keyName | 授予时序见解服务访问事件中心的 SAS 密钥的名称。 此密钥的共享访问策略必须向事件中心授予“侦听”权限。 | string （必需） |
| serviceBusNamespace | 包含事件中心的服务总线的名称。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对事件中心的读取访问权限的共享访问密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 事件源的类型。 | “Microsoft.IoTHub”（必需） |
| 性能 | 创建或更新请求时所需的 IoTHub 事件源的属性。 | IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties（必需） |
IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consumerGroupName | 用于保存要从中读取事件的分区的 iot 中心的使用者组的名称。 | string （必需） |
| eventSourceResourceId | Azure 资源管理器中事件源的资源 ID。 | string （必需） |
| iotHubName | iot 中心的名称。 | string （必需） |
| keyName | 授予时序见解服务对 iot 中心的访问权限的共享访问策略密钥的名称。 此共享访问策略密钥必须向 iot 中心授予“服务连接”权限。 | string （必需） |
| sharedAccessKey | 授予时序见解服务对 iot 中心的读取访问权限的共享访问策略密钥的值。 此属性未显示在事件源响应中。 | string （必需） |
| timestampPropertyName | 将用作事件源时间戳的事件属性。 如果未为 timestampPropertyName 指定值，或者指定 null 或空字符串，则将使用事件创建时间。 | 字符串 |
LocalTimestamp
| 名字 | 描述 | 价值 |
|---|---|---|
| 格式 | 一个枚举，表示需要设置的本地时间戳属性的格式。 | “Embedded” |
| timeZoneOffset | 一个对象，表示指定的本地时间戳格式的偏移信息。 不应为 LocalTimestampFormat - Embedded 指定。 | LocalTimestampTimeZoneOffset |
LocalTimestampTimeZoneOffset
| 名字 | 描述 | 价值 |
|---|---|---|
| propertyName | 将包含偏移信息以计算本地时间戳的事件属性。 LocalTimestampFormat 为 Iana 时，属性名称将包含包含 IANA 时区名称的列的名称（例如：美洲/洛杉矶）。 LocalTimestampFormat 为 Timespan 时，它包含表示偏移量的值的属性的名称（例如：P1D 或 1.00：00：00） | 字符串 |
Microsoft.TimeSeriesInsights/environments/eventSources
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource，设置为“Microsoft.EventHub”。 对于 IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource，请设置为“Microsoft.IoTHub”。 | “Microsoft.EventHub” “Microsoft.IoTHub”（必需） |
| localTimestamp | 一个表示本地时间戳属性的对象。 它包含需要使用的本地时间戳的格式以及相应的时区偏移信息。 如果未为 localTimestamp 指定值，或为 null，则不会使用事件传入本地时间戳。 | LocalTimestamp |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[-\w\._\(\)]+$ （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：环境 |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview” |