Microsoft.Azure.WebJobs.Extensions.EventGrid 3.4.2

Azure WebJobs EventGrid 客户端库 for .NET

此扩展为 Azure Functions 中接收 Event Grid webhook 调用提供功能，使您能够轻松编写响应 Event Grid 发布的任何事件的函数。

入门步骤

安装包

使用 NuGet 安装 Event Grid 扩展

dotnet add package Microsoft.Azure.WebJobs.Extensions.EventGrid

先决条件

您必须拥有一个Azure 订阅以及一个包含自定义事件网格主题或域的Azure资源组。请按照以下分步教程注册事件网格资源提供程序，并使用Azure门户创建事件网格主题。还有一个类似的教程使用Azure CLI。

验证客户端

为了扩展能发布事件，您需要事件网格主题的endpoint和证书credential，这可以使用主题的访问密钥创建。

您可以在Azure门户中找到事件网格主题的endpoint，或者使用以下Azure CLI代码片段。

az eventgrid topic show --name <your-resource-name> --resource-group <your-resource-group-name> --query "endpoint"

访问密钥也可以通过门户或使用以下Azure CLI代码片段找到

az eventgrid topic key list --name <your-resource-name> --resource-group <your-resource-group-name> --query "key1"

关键概念

使用事件网格输出绑定

请按照绑定教程了解如何使用此扩展发布EventGrid事件。

使用事件网格触发器

请按照教程了解如何在发布事件时触发Azure Function。

示例

使用事件网格输出绑定的函数

如果您的主题使用EventGrid模式，您可以输出EventGridEvents。

public static class EventGridEventBindingFunction
{
    [FunctionName("EventGridEventBindingFunction")]
    public static async Task<IActionResult> RunAsync(
        [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
        [EventGrid(TopicEndpointUri = "EventGridEndpoint", TopicKeySetting = "EventGridKey")] IAsyncCollector<EventGridEvent> eventCollector)
    {
        EventGridEvent e = new EventGridEvent(await req.ReadAsStringAsync(), "IncomingRequest", "IncomingRequest", "1.0.0");
        await eventCollector.AddAsync(e);
        return new OkResult();
    }
}

如果您的主题使用CloudEvent模式，您可以输出CloudEvents。

public static class CloudEventBindingFunction
{
    [FunctionName("CloudEventBindingFunction")]
    public static async Task<IActionResult> RunAsync(
        [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
        [EventGrid(TopicEndpointUri = "EventGridEndpoint", TopicKeySetting = "EventGridKey")] IAsyncCollector<CloudEvent> eventCollector)
    {
        CloudEvent e = new CloudEvent("IncomingRequest", "IncomingRequest", await req.ReadAsStringAsync());
        await eventCollector.AddAsync(e);
        return new OkResult();
    }
}

您还可以使用Azure Identity与输出绑定。为此，将Connection属性设置为包含您的Event Grid 主题endpoint的应用设置名称，以及一组可选的描述详细的身份信息（请在此处查看）。设置Connection属性时，不应设置TopicEndpointUri和TopicKeySetting属性。

public static class CloudEventOutputBindingWithIdentityFunction
{
    [FunctionName("CloudEventOutputBindingWithIdentityFunction")]
    public static async Task<IActionResult> RunAsync(
        [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
        [EventGrid(Connection = "MyConnection")] IAsyncCollector<CloudEvent> eventCollector)
    {
        CloudEvent e = new CloudEvent("IncomingRequest", "IncomingRequest", await req.ReadAsStringAsync());
        await eventCollector.AddAsync(e);
        return new OkResult();
    }
}

对于本地开发，请使用local.settings.json文件来存储连接信息

{
  "Values": {
    "myConnection__topicEndpointUri": "{topicEndpointUri}"
  }
}

部署时，请使用应用程序设置存储此信息。

您还可以输出一个字符串或JObject，并且扩展将尝试解析为正确的强类型事件。

使用事件网格触发的函数

您还可以创建一个函数，该函数将在事件被发送到您的主题时执行。根据您为Azure Function事件订阅选择的模式，您可以将绑定到EventGridEvent或CloudEvent。

public static class EventGridEventTriggerFunction
{
    [FunctionName("EventGridEventTriggerFunction")]
    public static void Run(
        ILogger logger,
        [EventGridTrigger] EventGridEvent e)
    {
        logger.LogInformation("Event received {type} {subject}", e.EventType, e.Subject);
    }
}

如果您的订阅配置有CloudEvent模式

public static class CloudEventTriggerFunction
{
    [FunctionName("CloudEventTriggerFunction")]
    public static void Run(
        ILogger logger,
        [EventGridTrigger] CloudEvent e)
    {
        logger.LogInformation("Event received {type} {subject}", e.Type, e.Subject);
    }
}

您还可以将绑定到事件数组。如果您已启用事件网格订阅的批处理，这将很有用。

public static class EventGridEventBatchTriggerFunction
{
    [FunctionName("EventGridEventBatchTriggerFunction")]
    public static void Run(
        ILogger logger,
        [EventGridTrigger] EventGridEvent[] events)
    {
        foreach (EventGridEvent eventGridEvent in events)
        {
            logger.LogInformation("Event received {type} {subject}", eventGridEvent.EventType, eventGridEvent.Subject);
        }
    }
}

对于配置有CloudEvent模式的订阅，类似地

public static class CloudEventBatchTriggerFunction
{
    [FunctionName("CloudEventBatchTriggerFunction")]
    public static void Run(
        ILogger logger,
        [EventGridTrigger] CloudEvent[] events)
    {
        foreach (CloudEvent cloudEvent in events)
        {
            logger.LogInformation("Event received {type} {subject}", cloudEvent.Type, cloudEvent.Subject);
        }
    }
}

故障排除

请参阅监控Azure函数以获取故障排除指导。

后续步骤

阅读Azure函数简介或创建Azure函数指南。

贡献

请参阅我们的 CONTRIBUTING.md 了解如何构建、测试以及为该库贡献代码的详细信息。

本项目欢迎贡献和建议。大多数贡献需要您同意一份贡献者许可协议（CLA），声明您有权利并且实际上授予我们使用您贡献的权利。有关详细信息，请访问 cla.microsoft.com。

本项目已采用 Microsoft 开源行为准则。要了解更多信息，请查看 行为准则常见问题解答 或通过 [email protected] 联系我们，提出任何额外的问题或意见。