你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.EventGrid 主题 2020-06-01
- 最新
- 2024-12-15-preview
- 2024-06-01-preview
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Bicep 资源定义
主题资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/topics 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.EventGrid/topics@2020-06-01' = {
location: 'string'
name: 'string'
properties: {
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
inputSchema: 'string'
inputSchemaMapping: {
inputSchemaMappingType: 'string'
// For remaining properties, see InputSchemaMapping objects
}
publicNetworkAccess: 'string'
}
tags: {
{customized property}: 'string'
}
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json，请使用：
{
inputSchemaMappingType: 'Json'
properties: {
dataVersion: {
defaultValue: 'string'
sourceField: 'string'
}
eventTime: {
sourceField: 'string'
}
eventType: {
defaultValue: 'string'
sourceField: 'string'
}
id: {
sourceField: 'string'
}
subject: {
defaultValue: 'string'
sourceField: 'string'
}
topic: {
sourceField: 'string'
}
}
}
属性值
InboundIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
| ipMask | CIDR 表示法中的 IP 地址，例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 对于 JsonInputSchemaMapping，请设置为“Json”。 | “Json”（必需） |
JsonField
| 名字 | 描述 | 价值 |
|---|---|---|
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性，则用于映射的默认值。 | 字符串 |
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 自定义映射的类型 | “Json”（必需） |
| 性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
| eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
| eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
| id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
| 主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
| 主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/topics
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 主题的属性。 | TopicProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
TopicProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。 | InboundIpRule[] |
| inputSchema | 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
| inputSchemaMapping | 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping，将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 | InputSchemaMapping |
| publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建 Azure 事件网格自定义主题和队列订阅 | 创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
| 创建 Azure 事件网格自定义主题和订阅 | 创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。 |
ARM 模板资源定义
主题资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/topics 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.EventGrid/topics",
"apiVersion": "2020-06-01",
"name": "string",
"location": "string",
"properties": {
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"inputSchema": "string",
"inputSchemaMapping": {
"inputSchemaMappingType": "string"
// For remaining properties, see InputSchemaMapping objects
},
"publicNetworkAccess": "string"
},
"tags": {
"{customized property}": "string"
}
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json，请使用：
{
"inputSchemaMappingType": "Json",
"properties": {
"dataVersion": {
"defaultValue": "string",
"sourceField": "string"
},
"eventTime": {
"sourceField": "string"
},
"eventType": {
"defaultValue": "string",
"sourceField": "string"
},
"id": {
"sourceField": "string"
},
"subject": {
"defaultValue": "string",
"sourceField": "string"
},
"topic": {
"sourceField": "string"
}
}
}
属性值
InboundIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
| ipMask | CIDR 表示法中的 IP 地址，例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 对于 JsonInputSchemaMapping，请设置为“Json”。 | “Json”（必需） |
JsonField
| 名字 | 描述 | 价值 |
|---|---|---|
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性，则用于映射的默认值。 | 字符串 |
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 自定义映射的类型 | “Json”（必需） |
| 性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
| eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
| eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
| id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
| 主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
| 主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/topics
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2020-06-01' |
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 主题的属性。 | TopicProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.EventGrid/topics” |
TopicProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。 | InboundIpRule[] |
| inputSchema | 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
| inputSchemaMapping | 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping，将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 | InputSchemaMapping |
| publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
创建 Azure 事件网格自定义主题和队列订阅
|
创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
|
创建 Azure 事件网格自定义主题和订阅
|
创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。 |
|
创建 Azure 事件网格自定义主题订阅
|
创建 Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。 |
|
创建事件网格自定义主题和事件中心处理程序
|
创建 Azure 事件网格自定义主题和事件中心来处理事件。 |
| 使用 CloudEvents
|
创建自定义 Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和逻辑应用作为事件处理程序。 模板最初由 Justin Yoo 创作。 |
Terraform （AzAPI 提供程序）资源定义
主题资源类型可以使用目标操作进行部署：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/topics 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/topics@2020-06-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
inboundIpRules = [
{
action = "string"
ipMask = "string"
}
]
inputSchema = "string"
inputSchemaMapping = {
inputSchemaMappingType = "string"
// For remaining properties, see InputSchemaMapping objects
}
publicNetworkAccess = "string"
}
})
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json，请使用：
{
inputSchemaMappingType = "Json"
properties = {
dataVersion = {
defaultValue = "string"
sourceField = "string"
}
eventTime = {
sourceField = "string"
}
eventType = {
defaultValue = "string"
sourceField = "string"
}
id = {
sourceField = "string"
}
subject = {
defaultValue = "string"
sourceField = "string"
}
topic = {
sourceField = "string"
}
}
}
属性值
InboundIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
| ipMask | CIDR 表示法中的 IP 地址，例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 对于 JsonInputSchemaMapping，请设置为“Json”。 | “Json”（必需） |
JsonField
| 名字 | 描述 | 价值 |
|---|---|---|
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性，则用于映射的默认值。 | 字符串 |
| sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
| 名字 | 描述 | 价值 |
|---|---|---|
| inputSchemaMappingType | 自定义映射的类型 | “Json”（必需） |
| 性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
| eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
| eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
| id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
| 主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
| 主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/topics
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 主题的属性。 | TopicProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.EventGrid/topics@2020-06-01” |
TopicProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。 | InboundIpRule[] |
| inputSchema | 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
| inputSchemaMapping | 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping，将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 | InputSchemaMapping |
| publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|