使用命名空间主题将事件传送到 Webhook - Azure CLI (预览版)

本文提供分步说明,以 CloudEvents JSON 格式 将事件发布到 Azure 事件网格,并使用推送传送模型传送这些事件。 具体来说,使用 Azure CLI 和 Curl 将事件发布到事件网格中的命名空间主题,并将这些事件从事件订阅推送到 Webhook 处理程序目标。 有关推送传递模型的详细信息,请参阅 推送传递概述

注释

Azure CLI 事件网格扩展 尚不支持命名空间及其包含的任何资源。 我们将使用 Azure CLI 资源 创建事件网格资源。

如果没有 Azure 帐户,请在开始前创建一个免费帐户

先决条件

启用事件网格资源提供程序

  1. 如果以前未在 Azure 订阅中使用过事件网格,则可能需要注册事件网格资源提供程序。 运行以下命令,注册提供程序:

    az provider register --namespace Microsoft.EventGrid
    
  2. 完成注册可能需要一些时间。 若要查看状态,请运行以下命令:

    az provider show --namespace Microsoft.EventGrid --query "registrationState"
    

    registrationStateRegistered 后,即可继续。

创建资源组

使用 az group create 命令创建 Azure 资源组。 您可以使用这个资源组来容纳本文中创建的所有资源。

使用 Cloud Shell 运行命令的一般步骤包括:

  • 选择 “打开 Cloud Shell ”以查看右侧窗格中的 Azure Cloud Shell 窗口。
  • 复制命令并将其粘贴到 Azure Cloud Shell 窗口中。
  • 按 Enter 运行命令。
  1. 声明一个变量以保存 Azure 资源组的名称。 请用您喜欢的值替换<your-resource-group-name>,以指定资源组的名称。

    resource_group="<your-resource-group-name>"
    
    ___location="<your-resource-group-___location>"
    
  2. 创建资源组。 根据需要更改位置。

    az group create --name $resource_group --___location $___location
    

创建命名空间

事件网格命名空间提供一个用户定义的终结点,可在其中发布事件。 以下示例使用 Azure Cloud Shell 中的 Bash 在资源组中创建命名空间。 命名空间名称必须唯一,因为它是域名系统(DNS)条目的一部分。 命名空间名称应符合以下规则:

  • 它应介于 3-50 个字符之间。
  • 它应该是区域唯一的。
  • 仅允许的字符是 a-z、A-Z、0-9 和 -
  • 它不应以保留的关键字前缀开头,例如 MicrosoftSystemEventGrid
  1. 声明一个变量以保存事件网格命名空间的名称。 通过将<your-namespace-name>替换为您喜欢的值来指定命名空间的名称。

    namespace="<your-namespace-name>"
    
  2. 创建命名空间。 你可能想要更改部署的位置。

    az eventgrid namespace create -g $resource_group -n $namespace -l $___location
    

创建命名空间主题

创建用于保存发布到命名空间终结点的所有事件的主题。

  1. 声明一个变量以保存命名空间主题的名称。 指定命名空间主题名称,请用您喜欢的值替换 <your-topic-name>

    topic="<your-topic-name>"
    
  2. 创建命名空间主题:

    az eventgrid namespace topic create -g $resource_group -n $topic --namespace-name $namespace 
    

创建消息终结点

在订阅命名空间主题之前,让我们为事件消息创建终结点。 通常情况下,终结点基于事件数据执行操作。 为了简化此快速入门,将部署用于显示事件消息的预生成 Web 应用。 所部署的解决方案包括应用服务计划、应用服务 Web 应用和 GitHub 中的源代码。

  1. 复制以下命令,指定 Web 应用的名称(事件网格查看器示例),然后按 Enter 运行命令。 将 <your-site-name> 替换为 Web 应用的唯一名称。 Web 应用名称必须唯一,因为它是 DNS 条目的一部分。

    sitename="<your-site-name>"
    
  2. 运行 az deployment group create,使用 Azure 资源管理器模板部署 Web 应用。

    az deployment group create \
      --resource-group $resource_group \
      --template-uri "https://raw.githubusercontent.com/Azure-Samples/azure-event-grid-viewer/master/azuredeploy.json" \
      --parameters siteName=$sitename hostingPlanName=viewerhost
    

部署可能需要几分钟时间才能完成。 部署成功后,请查看 Web 应用以确保它正在运行。 在 Web 浏览器中,导航到: https://<your-site-name>.azurewebsites.net 应会看到站点上当前未显示任何消息。

将事件传送到 Azure 事件网格查看器 Webhook

使用 Azure 事件网格查看器的 Webhook 创建命名空间的推送传递事件订阅。

  1. 定义用于保存事件订阅名称的变量。

    event_subscription="<your_event_subscription_name>"
    
  2. EVENTGRIDWEBSITENAME 替换为事件网格查看器网站的名称。 例如: contosoegridviewer

    az resource create --api-version 2024-06-01-preview --resource-group $resource_group --namespace Microsoft.EventGrid --resource-type eventsubscriptions --name $event_subscription --parent namespaces/$namespace/topics/$topic --___location $___location --properties "{\"eventDeliverySchema\": \"CloudEventSchemaV1_0\",\"deliveryConfiguration\":{\"deliveryMode\":\"Push\",\"push\":{\"destination\":{\"endpointType\":\"WebHook\",\"properties\":{\"endpointUrl\":\"https:\/\/$sitename.azurewebsites.net\/api/updates\"}}}}}"
    

将事件发送到主题

现在,按照本节中的步骤将示例事件发送到命名空间主题。

列出命名空间访问密钥

  1. 获取与创建的命名空间关联的访问密钥。 发布事件时,可以使用其中一个进行身份验证。 若要列出密钥,首先需要完整的命名空间资源 ID。 运行以下命令获取它:

    namespace_resource_id=$(az eventgrid namespace show -g $resource_group -n $namespace --query "id" --output tsv)
    
  2. 从命名空间获取第一个密钥:

    key=$(az eventgrid namespace list-key -g $resource_group --namespace-name $namespace --query "key1" --output tsv)
    

发布活动

  1. 检索命名空间主机名。 你将使用该主机名来编写要将事件发送到的命名空间 HTTP 终结点。 API 版本 2023-06-01-preview首次可用以下操作。

    publish_operation_uri="https://"$(az eventgrid namespace show -g $resource_group -n $namespace --query "topicsConfiguration.hostname" --output tsv)"/topics/"$topic:publish?api-version=2023-06-01-preview
    
  2. 创建符合 CloudEvents 的示例事件:

    event=' { "specversion": "1.0", "id": "'"$RANDOM"'", "type": "com.yourcompany.order.ordercreatedV2", "source" : "/mycontext", "subject": "orders/O-234595", "time": "'`date +%Y-%m-%dT%H:%M:%SZ`'", "datacontenttype" : "application/json", "data":{ "orderId": "O-234595", "url": "https://yourcompany.com/orders/o-234595"}} '
    

    data 元素是事件的有效负载。 可以将任何格式正确的 JSON 置于此字段中。 有关可以在事件中的属性(也称为上下文属性)的详细信息,请参阅 CloudEvents 规范。

  3. 使用 CURL 将事件发送到主题。 CURL 是发送 HTTP 请求的实用工具。

    curl -X POST -H "Content-Type: application/cloudevents+json" -H "Authorization:SharedAccessKey $key" -d "$event" $publish_operation_uri
    

验证 Azure 事件网格查看器是否收到了该事件

验证 Azure 事件网格查看器 Web 应用是否显示从事件网格接收的事件。

显示包含已接收示例事件的 Azure 事件网格查看器的屏幕截图。

在本快速入门中,你使用了 Webhook 作为事件处理程序。 有关使用 Azure 事件中心作为事件处理程序的快速入门,请参阅 使用命名空间主题将事件传递到 Azure 事件中心