快速入门:使用 Azure CLI 将 Azure Cache for Redis 事件路由到 Web 终结点Quickstart: Route Azure Cache for Redis events to web endpoint with Azure CLI

Azure 事件网格是针对云的事件处理服务。Azure Event Grid is an eventing service for the cloud. 在本快速入门中,你将使用 Azure CLI 订阅 Azure Cache for Redis 事件、触发事件并查看结果。In this quickstart, you'll use the Azure CLI to subscribe to Azure Cache for Redis events, trigger an event, and view the results.

通常,你会将事件发送到处理事件数据并执行操作的终结点。Typically, you send events to an endpoint that processes the event data and takes actions. 但是,为了简化本快速入门,你需要将事件发送到要收集和显示消息的 Web 应用。However, to simplify this quickstart, you'll send events to a web app that will collect and display the messages. 完成本快速入门所述步骤后,即可看到事件数据已发送到 Web 应用。When you complete the steps described in this quickstart, you'll see that the event data has been sent to the web app.

如果没有 Azure 订阅,可在开始前创建一个试用帐户If you don't have an Azure subscription, create a trial account before you begin.

如果选择在本地安装并使用 CLI,则本快速入门要求你运行最新版的 Azure CLI(2.0.70 或更高版本)。If you choose to install and use the CLI locally, this quickstart requires that you're running the latest version of Azure CLI (2.0.70 or later). 要查找版本,请运行 az --versionTo find the version, run az --version. 如果需要进行安装或升级,请参阅安装 Azure CLIIf you need to install or upgrade, see Install Azure CLI.

必须先使用 az login 登录。You must first sign in using az login.

创建资源组Create a resource group

事件网格主题部署为单个 Azure 资源,且必须在 Azure 资源组下进行预配。Event Grid topics are deployed as individual Azure resources and must be provisioned under an Azure resource group. 资源组是在其中部署和管理 Azure 资源的逻辑集合。A resource group is a logical collection into which Azure resources are deployed and managed.

使用“az group create”命令创建资源组。Create a resource group with the az group create command.

以下示例在 chinanorth 位置创建名为 <resource_group_name> 的资源组。The following example creates a resource group named <resource_group_name> in the chinanorth location. <resource_group_name> 替换为资源组的唯一名称。Replace <resource_group_name> with a unique name for your resource group.

az group create --name <resource_group_name> --location chinanorth

创建缓存实例Create a cache instance

#/bin/bash

# Create a Basic C0 (256 MB) Azure Cache for Redis instance
az redis create --name <cache_name> --resource-group <resource_group_name> --location chinanorth --sku Basic --vm-size C0

创建消息终结点Create a message endpoint

在订阅主题之前,让我们创建事件消息的终结点。Before subscribing to the topic, let's create the endpoint for the event message. 通常情况下,终结点基于事件数据执行操作。Typically, the endpoint takes actions based on the event data. 为了简化此快速入门,将部署用于显示事件消息的预建的 Web 应用To simplify this quickstart, you deploy a pre-built web app that displays the event messages. 所部署的解决方案包括应用服务计划、应用服务 Web 应用和 GitHub 中的源代码。The deployed solution includes an App Service plan, an App Service web app, and source code from GitHub.

<your-site-name> 替换为 Web 应用的唯一名称。Replace <your-site-name> with a unique name for your web app. Web 应用名称必须唯一,因为它是 DNS 条目的一部分。The web app name must be unique because it's part of the DNS entry.

sitename=<your-site-name>

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

部署可能需要几分钟才能完成。The deployment may take a few minutes to complete. 部署成功后,请查看 Web 应用以确保它正在运行。After the deployment has succeeded, view your web app to make sure it's running. 在 Web 浏览器中导航到 https://<your-site-name>.chinacloudsites.cnIn a web browser, navigate to: https://<your-site-name>.chinacloudsites.cn

应会看到站点上当前未显示任何消息。You should see the site with no messages currently displayed.

启用事件网格资源提供程序Enable Event Grid resource provider

如果以前未在 Azure 订阅中使用过事件网格,则可能需要注册事件网格资源提供程序。If you haven't previously used Event Grid in your Azure subscription, you may need to register the Event Grid resource provider. 运行以下命令,注册提供程序:Run the following command to register the provider:

az provider register --namespace Microsoft.EventGrid

完成注册可能需要一些时间。It may take a moment for the registration to finish. 若要检查状态,请运行:To check the status, run:

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

registrationStateRegistered 后,即可继续。When registrationState is Registered, you're ready to continue.

订阅 Azure Cache for Redis 实例Subscribe to your Azure Cache for Redis instance

在此步骤中,你将订阅主题,使事件网格知道你想要跟踪哪些事件,以及要将事件发送到哪里。In this step, you'll subscribe to a topic to tell Event Grid which events you want to track and where to send those events. 以下示例将订阅你创建的 Azure Cache for Redis 实例,并将 Web 应用中的 URL 作为事件通知的终结点进行传递。The following example subscribes to the Azure Cache for Redis instance you created, and passes the URL from your web app as the endpoint for event notification. <event_subscription_name> 替换为事件订阅的名称。Replace <event_subscription_name> with a name for your event subscription. 对于 <resource_group_name><cache_name>,请使用此前创建的值。For <resource_group_name> and <cache_name>, use the values you created earlier.

Web 应用的终结点必须包括后缀 /api/updates/The endpoint for your web app must include the suffix /api/updates/.

cacheId=$(az redis show --name <cache_name> --resource-group <resource_group_name> --query id --subscription <subscription_id>)
endpoint=https://$sitename.chinacloudsites.cn/api/updates

az eventgrid event-subscription create \
  --source-resource-id $cacheId \
  --name <event_subscription_name> \
  --endpoint $endpoint

再次查看 Web 应用,并注意现已向该应用发送了订阅验证事件。View your web app again, and notice that a subscription validation event has been sent to it. 选择眼睛图标以展开事件数据。Select the eye icon to expand the event data. 事件网格发送验证事件,以便终结点可以验证它是否想要接收事件数据。Event Grid sends the validation event so the endpoint can verify that it wants to receive event data. Web 应用包含用于验证订阅的代码。The web app includes code to validate the subscription.

Azure 事件网格查看器。

从 Azure Cache for Redis 触发事件Trigger an event from Azure Cache for Redis

现在,让我们触发一个事件,看事件网格如何将消息分发到终结点。Now, let's trigger an event to see how Event Grid distributes the message to your endpoint. 导出 Azure Cache for Redis 实例中存储的数据。Let's export the data stored in your Azure Cache for Redis instance. 同样,对于 {cache_name}{resource_group_name},请使用此前创建的值。Again, use the values for {cache_name} and {resource_group_name} you created earlier.

az redis export  --ids '/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}' \
    --prefix '<prefix_for_exported_files>' \
    --container '<SAS_url>'  

现已触发事件,并且事件网格已将消息发送到订阅时配置的终结点。You've triggered the event, and Event Grid sent the message to the endpoint you configured when subscribing. 查看 Web 应用以查看刚刚发送的事件。View your web app to see the event you just sent.

[{
"id": "e1ceb52d-575c-4ce4-8056-115dec723cff",
  "eventType": "Microsoft.Cache.ExportRDBCompleted",
  "topic": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}",
  "data": {
    "name": "ExportRDBCompleted",
    "timestamp": "2020-12-10T18:07:54.4937063+00:00",
    "status": "Succeeded"
  },
  "subject": "ExportRDBCompleted",
  "dataversion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2020-12-10T18:07:54.4937063+00:00"
}]

清理资源Clean up resources

如果计划继续使用此 Azure Cache for Redis 实例和事件订阅,请不要清理在本快速入门中创建的资源。If you plan to continue working with this Azure Cache for Redis instance and event subscription, do not clean up the resources created in this quickstart. 如果不打算继续学习,请使用以下命令删除这些资源。If you do not plan to continue, use the following command to delete the resources you created in this quickstart.

<resource_group_name> 替换为上面创建的资源组。Replace <resource_group_name> with the resource group you created above.

az group delete --name <resource_group_name>

后续步骤Next steps

你现已了解如何创建主题和事件订阅后,接下来请详细了解 Azure Cache for Redis 事件以及事件网格的功能:Now that you know how to create topics and event subscriptions, learn more about Azure Cache for Redis Events and what Event Grid can help you do: