充当事件网格源的 Azure 应用程序配置

本文提供 Azure 应用程序配置事件的属性和架构。 有关事件架构的简介,请参阅 Azure 事件网格事件架构。 本文还提供了有关将 Azure 应用程序配置用作事件源的快速入门和教程列表。

可用事件类型

事件网格使用事件订阅将事件消息路由到订阅方。 Azure 应用程序配置会发出以下事件类型:

事件类型 说明
Microsoft.AppConfiguration.KeyValueModified 创建或替换键/值时引发。
Microsoft.AppConfiguration.KeyValueDeleted 删除键/值时引发。
Microsoft.AppConfiguration.SnapshotCreated 创建快照时引发。
Microsoft.AppConfiguration.SnapshotModified 修改快照时引发。

事件架构

事件具有以下顶级数据:

属性 类型​​ 说明
source string 事件源的完整资源路径。 此字段不可写入。 事件网格提供此值。
subject string 事件主题的发布者定义路径。
type string 此事件源的一个注册事件类型。
time string 基于提供程序 UTC 时间的事件生成时间。
id string 事件的唯一标识符。
data 对象 应用配置事件数据。
specversion 字符串 CloudEvents 架构规范版本。

数据对象具有以下属性:

键值事件

properties 类型​​ 说明
key 字符串 已修改或已删除的键/值的键。
label 字符串 已修改或已删除的键/值的标签(如果有)。
etag 字符串 对于 KeyValueModified,为新键/值的 etag。 对于 KeyValueDeleted,为已删除的键/值的 etag。
syncToken string 表示键值事件后服务器状态的同步令牌。

快照事件

properties 类型​​ 说明
name string 已创建或修改的快照的名称。
etag string 对于 SnapshotCreated,为新快照的 etag。 对于 SnapshotModified,为已修改的快照的 etag。
syncToken string 表示快照事件后服务器状态的同步令牌。

示例事件

以下示例显示键/值修改事件的架构:

[{
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
  "data": {
    "key": "Foo",
    "label": "FizzBuzz",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
  },
  "type": "Microsoft.AppConfiguration.KeyValueModified",
  "time": "2019-05-31T20:05:03Z",
  "specversion": "1.0"
}]

以下示例显示了键值删除事件的架构:

[{
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
  "data": {
    "key": "Foo",
    "label": "FizzBuzz",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
  },
  "type": "Microsoft.AppConfiguration.KeyValueDeleted",
  "time": "2019-05-31T20:05:03Z",
  "specversion": "1.0"
}]

以下示例显示了快照创建事件的架构:

[{
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kvsnapshots/Foo",
  "type": "Microsoft.AppConfiguration.SnapshotCreated",
  "time": "2023-09-02T20:05:03.0000000Z",
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "data": {
    "name": "Foo",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
    "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
  },
  "specversion": "1.0"
}]

以下示例显示了快照修改事件的架构:

[{
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/snapshots/Foo",
  "type": "Microsoft.AppConfiguration.SnapshotModified",
  "time": "2023-09-03T20:05:03.0000000Z",
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "data": {
    "name": "Foo",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
    "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
  },
  "specversion": "1.0"
}]

教程和操作指南

标题 说明
使用事件网格响应 Azure 应用程序配置事件 概述 Azure 应用程序配置与事件网格的集成。
使用事件网格进行数据更改通知 了解如何设置 Azure 应用程序配置事件订阅,以将键值修改事件发送到 Web 终结点。

后续步骤