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

Microsoft.EventGrid 主题 2023-06-01-preview

Bicep 资源定义

主题资源类型可以使用目标操作进行部署:

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

资源格式

若要创建 Microsoft.EventGrid/topics 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.EventGrid/topics@2023-06-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    dataResidencyBoundary: 'string'
    disableLocalAuth: bool
    eventTypeInfo: {
      inlineEventTypes: {
        {customized property}: {
          dataSchemaUrl: 'string'
          description: 'string'
          displayName: 'string'
          documentationUrl: 'string'
        }
      }
      kind: 'string'
    }
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    minimumTlsVersionAllowed: 'string'
    publicNetworkAccess: 'string'
  }
  sku: {
    name: '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'
    }
  }
}

属性值

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties,并且将包含每个内联事件类型的附加信息。
EventTypeInfoInlineEventTypes
所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

ExtendedLocation

名字 描述 价值
名字 扩展位置的完全限定名称。 字符串
类型 扩展位置的类型。 字符串

IdentityInfo

名字 描述 价值
principalId 资源标识的主体 ID。 字符串
tenantId 资源的租户 ID。 字符串
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,并保留以供将来使用。
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字 描述 价值

InboundIpRule

名字 描述 价值
行动 根据匹配项或 IpMask 的匹配项执行的操作。 “允许”
ipMask CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 字符串

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

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

名字 描述 价值
extendedLocation 资源的扩展位置。 ExtendedLocation
身份 资源的标识信息。 IdentityInfo
资源的种类。 “Azure”
“AzureArc”
位置 资源的位置。 string (必需)
名字 资源名称 string (必需)
性能 主题的属性。 TopicProperties
sku 主题的 SKU 定价层。 ResourceSku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceSku

名字 描述 价值
名字 资源的 SKU 名称。 可能的值包括:基本值或高级值。 “Basic”
“Premium”

TopicProperties

名字 描述 价值
dataResidencyBoundary 资源的数据驻留边界。 “WithinGeopair”
“WithinRegion”
disableLocalAuth 此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true,则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。 bool
eventTypeInfo 用户主题的事件类型信息。 此信息由发布者提供,可供发布者使用
订阅者查看发布的不同类型的事件。
EventTypeInfo
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
inputSchema 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 “CloudEventSchemaV1_0”
“CustomEventSchema”
“EventGridSchema”
inputSchemaMapping 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping,将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 InputSchemaMapping
minimumTlsVersionAllowed 允许发布到本主题的发布服务器的最低 TLS 版本 '1.0'
'1.1'
'1.2'
publicNetworkAccess 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。
可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” />
“Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值

UserIdentityProperties

名字 描述 价值
clientId 用户分配标识的客户端 ID。 字符串
principalId 用户分配标识的主体 ID。 字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
创建 Azure 事件网格自定义主题和队列订阅 创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建 Azure 事件网格自定义主题和订阅 创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。

ARM 模板资源定义

主题资源类型可以使用目标操作进行部署:

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

资源格式

若要创建 Microsoft.EventGrid/topics 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "dataResidencyBoundary": "string",
    "disableLocalAuth": "bool",
    "eventTypeInfo": {
      "inlineEventTypes": {
        "{customized property}": {
          "dataSchemaUrl": "string",
          "description": "string",
          "displayName": "string",
          "documentationUrl": "string"
        }
      },
      "kind": "string"
    },
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "minimumTlsVersionAllowed": "string",
    "publicNetworkAccess": "string"
  },
  "sku": {
    "name": "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"
    }
  }
}

属性值

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties,并且将包含每个内联事件类型的附加信息。
EventTypeInfoInlineEventTypes
所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

ExtendedLocation

名字 描述 价值
名字 扩展位置的完全限定名称。 字符串
类型 扩展位置的类型。 字符串

IdentityInfo

名字 描述 价值
principalId 资源标识的主体 ID。 字符串
tenantId 资源的租户 ID。 字符串
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,并保留以供将来使用。
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字 描述 价值

InboundIpRule

名字 描述 价值
行动 根据匹配项或 IpMask 的匹配项执行的操作。 “允许”
ipMask CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 字符串

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

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 版本 '2023-06-01-preview'
extendedLocation 资源的扩展位置。 ExtendedLocation
身份 资源的标识信息。 IdentityInfo
资源的种类。 “Azure”
“AzureArc”
位置 资源的位置。 string (必需)
名字 资源名称 string (必需)
性能 主题的属性。 TopicProperties
sku 主题的 SKU 定价层。 ResourceSku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.EventGrid/topics”

ResourceSku

名字 描述 价值
名字 资源的 SKU 名称。 可能的值包括:基本值或高级值。 “Basic”
“Premium”

TopicProperties

名字 描述 价值
dataResidencyBoundary 资源的数据驻留边界。 “WithinGeopair”
“WithinRegion”
disableLocalAuth 此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true,则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。 bool
eventTypeInfo 用户主题的事件类型信息。 此信息由发布者提供,可供发布者使用
订阅者查看发布的不同类型的事件。
EventTypeInfo
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
inputSchema 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 “CloudEventSchemaV1_0”
“CustomEventSchema”
“EventGridSchema”
inputSchemaMapping 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping,将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 InputSchemaMapping
minimumTlsVersionAllowed 允许发布到本主题的发布服务器的最低 TLS 版本 '1.0'
'1.1'
'1.2'
publicNetworkAccess 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。
可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” />
“Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值

UserIdentityProperties

名字 描述 价值
clientId 用户分配标识的客户端 ID。 字符串
principalId 用户分配标识的主体 ID。 字符串

快速入门模板

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

模板 描述
创建 Azure 事件网格自定义主题和队列订阅

部署到 Azure
创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建 Azure 事件网格自定义主题和订阅

部署到 Azure
创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。
创建 Azure 事件网格自定义主题订阅

部署到 Azure
创建 Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。
创建事件网格自定义主题和事件中心处理程序

部署到 Azure
创建 Azure 事件网格自定义主题和事件中心来处理事件。
使用 CloudEvents 自定义 Azure 事件网格主题/订阅

部署到 Azure
创建自定义 Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和逻辑应用作为事件处理程序。 模板最初由 Justin Yoo 创作。

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

主题资源类型可以使用目标操作进行部署:

  • 资源组

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

资源格式

若要创建 Microsoft.EventGrid/topics 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2023-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      dataResidencyBoundary = "string"
      disableLocalAuth = bool
      eventTypeInfo = {
        inlineEventTypes = {
          {customized property} = {
            dataSchemaUrl = "string"
            description = "string"
            displayName = "string"
            documentationUrl = "string"
          }
        }
        kind = "string"
      }
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      minimumTlsVersionAllowed = "string"
      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"
    }
  }
}

属性值

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties,并且将包含每个内联事件类型的附加信息。
EventTypeInfoInlineEventTypes
所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

ExtendedLocation

名字 描述 价值
名字 扩展位置的完全限定名称。 字符串
类型 扩展位置的类型。 字符串

IdentityInfo

名字 描述 价值
principalId 资源标识的主体 ID。 字符串
tenantId 资源的租户 ID。 字符串
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,并保留以供将来使用。
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字 描述 价值

InboundIpRule

名字 描述 价值
行动 根据匹配项或 IpMask 的匹配项执行的操作。 “允许”
ipMask CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 字符串

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

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

名字 描述 价值
extendedLocation 资源的扩展位置。 ExtendedLocation
身份 资源的标识信息。 IdentityInfo
资源的种类。 “Azure”
“AzureArc”
位置 资源的位置。 string (必需)
名字 资源名称 string (必需)
性能 主题的属性。 TopicProperties
sku 主题的 SKU 定价层。 ResourceSku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.EventGrid/topics@2023-06-01-preview”

ResourceSku

名字 描述 价值
名字 资源的 SKU 名称。 可能的值包括:基本值或高级值。 “Basic”
“Premium”

TopicProperties

名字 描述 价值
dataResidencyBoundary 资源的数据驻留边界。 “WithinGeopair”
“WithinRegion”
disableLocalAuth 此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true,则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。 bool
eventTypeInfo 用户主题的事件类型信息。 此信息由发布者提供,可供发布者使用
订阅者查看发布的不同类型的事件。
EventTypeInfo
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
inputSchema 这决定了事件网格应该期望用于发布到主题的传入事件的格式。 “CloudEventSchemaV1_0”
“CustomEventSchema”
“EventGridSchema”
inputSchemaMapping 这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping,将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。 InputSchemaMapping
minimumTlsVersionAllowed 允许发布到本主题的发布服务器的最低 TLS 版本 '1.0'
'1.1'
'1.2'
publicNetworkAccess 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。
可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” />
“Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值

UserIdentityProperties

名字 描述 价值
clientId 用户分配标识的客户端 ID。 字符串
principalId 用户分配标识的主体 ID。 字符串