Gebeurtenissen op een HTTP-eindpunt ontvangen
In dit artikel wordt beschreven hoe u een HTTP-eindpunt valideert voor het ontvangen van gebeurtenissen van een gebeurtenisabonnement en vervolgens gebeurtenissen ontvangt en deserialiseert. In dit artikel wordt een Azure-functie gebruikt voor demonstratiedoeleinden, maar dezelfde concepten zijn van toepassing, ongeacht waar de toepassing wordt gehost.
Notitie
U wordt aangeraden een Event Grid-trigger te gebruiken bij het activeren van een Azure-functie met Event Grid. Het biedt een eenvoudigere en snellere integratie tussen Event Grid en Azure Functions. Houd er echter rekening mee dat de Event Grid-trigger van Azure Functions geen ondersteuning biedt voor het scenario waarin de gehoste code de HTTP-statuscode moet beheren die wordt geretourneerd naar Event Grid. Vanwege deze beperking kan uw code die wordt uitgevoerd op een Azure-functie, bijvoorbeeld geen 5XX-fout retourneren om een nieuwe poging voor het leveren van gebeurtenissen door Event Grid te starten.
Vereisten
U hebt een functie-app met een door HTTP geactiveerde functie nodig.
Afhankelijkheden toevoegen
Als u in .NET ontwikkelt, voegt u een afhankelijkheid toe aan uw functie voor het Azure.Messaging.EventGridNuGet-pakket.
SDK's voor andere talen zijn beschikbaar via de referentie voor publicatie-SDK's . Deze pakketten hebben de modellen voor systeemeigen gebeurtenistypen, zoals EventGridEvent, StorageBlobCreatedEventDataen EventHubCaptureFileCreatedEventData.
Eindpuntvalidatie
Het eerste wat u wilt doen, is gebeurtenissen afhandelen Microsoft.EventGrid.SubscriptionValidationEvent . Telkens wanneer iemand zich abonneert op een gebeurtenis, verzendt Event Grid een validatie-gebeurtenis naar het eindpunt met een validationCode nettolading van de gegevens. Het eindpunt is vereist om dit terug te echoën in de hoofdtekst van het antwoord om te bewijzen dat het eindpunt geldig is en eigendom is van u. Als u een Event Grid-trigger gebruikt in plaats van een door WebHook geactiveerde functie, wordt eindpuntvalidatie voor u afgehandeld. Als u een API-service van derden gebruikt (zoals Zapier of IFTTT), kunt u de validatiecode mogelijk niet programmatisch echoën. Voor deze services kunt u het abonnement handmatig valideren met behulp van een validatie-URL die wordt verzonden in de validatie-gebeurtenis van het abonnement. Kopieer die URL in de validationUrl eigenschap en verzend een GET-aanvraag via een REST-client of uw webbrowser.
In C# wordt de methode gebruikt voor het ParseMany() deserialiseren van een exemplaar met een BinaryData of meer gebeurtenissen in een matrix van EventGridEvent. Als u van tevoren wist dat u slechts één gebeurtenis deserialiseert, kunt u in plaats daarvan de Parse methode gebruiken.
Als u de validatiecode programmatisch wilt echoën, gebruikt u de volgende code.
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using Azure.Messaging.EventGrid;
using Azure.Messaging.EventGrid.SystemEvents;
namespace Function1
{
public static class Function1
{
[FunctionName("Function1")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
string response = string.Empty;
BinaryData events = await BinaryData.FromStreamAsync(req.Body);
log.LogInformation($"Received events: {events}");
EventGridEvent[] eventGridEvents = EventGridEvent.ParseMany(events);
foreach (EventGridEvent eventGridEvent in eventGridEvents)
{
// Handle system events
if (eventGridEvent.TryGetSystemEventData(out object eventData))
{
// Handle the subscription validation event
if (eventData is SubscriptionValidationEventData subscriptionValidationEventData)
{
log.LogInformation($"Got SubscriptionValidation event data, validation code: {subscriptionValidationEventData.ValidationCode}, topic: {eventGridEvent.Topic}");
// Do any additional validation (as required) and then return back the below response
var responseData = new
{
ValidationResponse = subscriptionValidationEventData.ValidationCode
};
return new OkObjectResult(responseData);
}
}
}
return new OkObjectResult(response);
}
}
}
module.exports = function (context, req) {
context.log('JavaScript HTTP trigger function begun');
var validationEventType = "Microsoft.EventGrid.SubscriptionValidationEvent";
for (var events in req.body) {
var body = req.body[events];
// Deserialize the event data into the appropriate type based on event type
if (body.data && body.eventType == validationEventType) {
context.log("Got SubscriptionValidation event data, validation code: " + body.data.validationCode + " topic: " + body.topic);
// Do any additional validation (as required) and then return back the below response
var code = body.data.validationCode;
context.res = { status: 200, body: { "ValidationResponse": code } };
}
}
context.done();
};
Testvalidatieantwoord
Test de validatiereactiefunctie door de voorbeeldgebeurtenis in het testveld voor de functie te plakken:
[{
"id": "2d1781af-3a4c-4d7c-bd0c-e34b19da4e66",
"topic": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"subject": "",
"data": {
"validationCode": "512d38b6-c7b8-40c8-89fe-f46f9e9622b6"
},
"eventType": "Microsoft.EventGrid.SubscriptionValidationEvent",
"eventTime": "2018-01-25T22:12:19.4556811Z",
"metadataVersion": "1",
"dataVersion": "1"
}]
Wanneer u Uitvoeren selecteert, moet de uitvoer 200 OK zijn en {"validationResponse":"512d38b6-c7b8-40c8-89fe-f46f9e9622b6"} in de hoofdtekst:
Blob Storage-gebeurtenissen verwerken
Nu gaan we de functie uitbreiden om de Microsoft.Storage.BlobCreated systeem gebeurtenis af te handelen:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using Azure.Messaging.EventGrid;
using Azure.Messaging.EventGrid.SystemEvents;
namespace Function1
{
public static class Function1
{
[FunctionName("Function1")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
string response = string.Empty;
BinaryData events = await BinaryData.FromStreamAsync(req.Body);
log.LogInformation($"Received events: {events}");
EventGridEvent[] eventGridEvents = EventGridEvent.ParseMany(events);
foreach (EventGridEvent eventGridEvent in eventGridEvents)
{
// Handle system events
if (eventGridEvent.TryGetSystemEventData(out object eventData))
{
// Handle the subscription validation event
if (eventData is SubscriptionValidationEventData subscriptionValidationEventData)
{
log.LogInformation($"Got SubscriptionValidation event data, validation code: {subscriptionValidationEventData.ValidationCode}, topic: {eventGridEvent.Topic}");
// Do any additional validation (as required) and then return back the below response
var responseData = new
{
ValidationResponse = subscriptionValidationEventData.ValidationCode
};
return new OkObjectResult(responseData);
}
// Handle the storage blob created event
else if (eventData is StorageBlobCreatedEventData storageBlobCreatedEventData)
{
log.LogInformation($"Got BlobCreated event data, blob URI {storageBlobCreatedEventData.Url}");
}
}
}
return new OkObjectResult(response);
}
}
}
module.exports = function (context, req) {
context.log('JavaScript HTTP trigger function begun');
var validationEventType = "Microsoft.EventGrid.SubscriptionValidationEvent";
var storageBlobCreatedEvent = "Microsoft.Storage.BlobCreated";
for (var events in req.body) {
var body = req.body[events];
// Deserialize the event data into the appropriate type based on event type
if (body.data && body.eventType == validationEventType) {
context.log("Got SubscriptionValidation event data, validation code: " + body.data.validationCode + " topic: " + body.topic);
// Do any additional validation (as required) and then return back the below response
var code = body.data.validationCode;
context.res = { status: 200, body: { "ValidationResponse": code } };
}
else if (body.data && body.eventType == storageBlobCreatedEvent) {
var blobCreatedEventData = body.data;
context.log("Relaying received blob created event payload:" + JSON.stringify(blobCreatedEventData));
}
}
context.done();
};
Afhandeling van gebeurtenissen die door blob zijn gemaakt testen
Test de nieuwe functionaliteit van de functie door een Blob Storage-gebeurtenis in het testveld te plaatsen en uit te voeren:
[{
"topic": "/subscriptions/{subscription-id}/resourceGroups/Storage/providers/Microsoft.Storage/storageAccounts/xstoretestaccount",
"subject": "/blobServices/default/containers/testcontainer/blobs/testfile.txt",
"eventType": "Microsoft.Storage.BlobCreated",
"eventTime": "2017-06-26T18:41:00.9584103Z",
"id": "831e1650-001e-001b-66ab-eeb76e069631",
"data": {
"api": "PutBlockList",
"clientRequestId": "6d79dbfb-0e37-4fc4-981f-442c9ca65760",
"requestId": "831e1650-001e-001b-66ab-eeb76e000000",
"eTag": "0x8D4BCC2E4835CD0",
"contentType": "text/plain",
"contentLength": 524288,
"blobType": "BlockBlob",
"url": "https://example.blob.core.windows.net/testcontainer/testfile.txt",
"sequencer": "00000000000004420000000000028963",
"storageDiagnostics": {
"batchId": "b68529f3-68cd-4744-baa4-3c0498ec19f0"
}
},
"dataVersion": "",
"metadataVersion": "1"
}]
U ziet nu de uitvoer van de blob-URL in het functielogboek:
2022-11-14T22:40:45.978 [Information] Executing 'Function1' (Reason='This function was programmatically called via the host APIs.', Id=8429137d-9245-438c-8206-f9e85ef5dd61)
2022-11-14T22:40:46.012 [Information] C# HTTP trigger function processed a request.
2022-11-14T22:40:46.017 [Information] Received events: [{"topic": "/subscriptions/{subscription-id}/resourceGroups/Storage/providers/Microsoft.Storage/storageAccounts/xstoretestaccount","subject": "/blobServices/default/containers/testcontainer/blobs/testfile.txt","eventType": "Microsoft.Storage.BlobCreated","eventTime": "2017-06-26T18:41:00.9584103Z","id": "831e1650-001e-001b-66ab-eeb76e069631","data": {"api": "PutBlockList","clientRequestId": "6d79dbfb-0e37-4fc4-981f-442c9ca65760","requestId": "831e1650-001e-001b-66ab-eeb76e000000","eTag": "0x8D4BCC2E4835CD0","contentType": "text/plain","contentLength": 524288,"blobType": "BlockBlob","url": "https://example.blob.core.windows.net/testcontainer/testfile.txt","sequencer": "00000000000004420000000000028963","storageDiagnostics": {"batchId": "b68529f3-68cd-4744-baa4-3c0498ec19f0"}},"dataVersion": "","metadataVersion": "1"}]
2022-11-14T22:40:46.335 [Information] Got BlobCreated event data, blob URI https://example.blob.core.windows.net/testcontainer/testfile.txt
2022-11-14T22:40:46.346 [Information] Executed 'Function1' (Succeeded, Id=8429137d-9245-438c-8206-f9e85ef5dd61, Duration=387ms)
U kunt ook testen door een Blob Storage-account of V2-opslagaccount voor algemeen gebruik te maken, een gebeurtenisabonnement toe te voegen en het eindpunt in te stellen op de functie-URL:
Aangepaste gebeurtenissen verwerken
Ten slotte kunt u de functie nogmaals uitbreiden, zodat deze ook aangepaste gebeurtenissen kan verwerken.
Voeg een controle voor uw gebeurtenis Contoso.Items.ItemReceivedtoe. De uiteindelijke code moet er als volgt uitzien:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using Azure.Messaging.EventGrid;
using Azure.Messaging.EventGrid.SystemEvents;
namespace Function1
{
public static class Function1
{
[FunctionName("Function1")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
string response = string.Empty;
BinaryData events = await BinaryData.FromStreamAsync(req.Body);
log.LogInformation($"Received events: {events}");
EventGridEvent[] eventGridEvents = EventGridEvent.ParseMany(events);
foreach (EventGridEvent eventGridEvent in eventGridEvents)
{
// Handle system events
if (eventGridEvent.TryGetSystemEventData(out object eventData))
{
// Handle the subscription validation event
if (eventData is SubscriptionValidationEventData subscriptionValidationEventData)
{
log.LogInformation($"Got SubscriptionValidation event data, validation code: {subscriptionValidationEventData.ValidationCode}, topic: {eventGridEvent.Topic}");
// Do any additional validation (as required) and then return back the below response
var responseData = new
{
ValidationResponse = subscriptionValidationEventData.ValidationCode
};
return new OkObjectResult(responseData);
}
// Handle the storage blob created event
else if (eventData is StorageBlobCreatedEventData storageBlobCreatedEventData)
{
log.LogInformation($"Got BlobCreated event data, blob URI {storageBlobCreatedEventData.Url}");
}
}
// Handle the custom contoso event
else if (eventGridEvent.EventType == "Contoso.Items.ItemReceived")
{
var contosoEventData = eventGridEvent.Data.ToObjectFromJson<ContosoItemReceivedEventData>();
log.LogInformation($"Got ContosoItemReceived event data, item SKU {contosoEventData.ItemSku}");
}
}
return new OkObjectResult(response);
}
}
}
module.exports = function (context, req) {
context.log('JavaScript HTTP trigger function begun');
var validationEventType = "Microsoft.EventGrid.SubscriptionValidationEvent";
var storageBlobCreatedEvent = "Microsoft.Storage.BlobCreated";
var customEventType = "Contoso.Items.ItemReceived";
for (var events in req.body) {
var body = req.body[events];
// Deserialize the event data into the appropriate type based on event type
if (body.data && body.eventType == validationEventType) {
context.log("Got SubscriptionValidation event data, validation code: " + body.data.validationCode + " topic: " + body.topic);
// Do any additional validation (as required) and then return back the below response
var code = body.data.validationCode;
context.res = { status: 200, body: { "ValidationResponse": code } };
}
else if (body.data && body.eventType == storageBlobCreatedEvent) {
var blobCreatedEventData = body.data;
context.log("Relaying received blob created event payload:" + JSON.stringify(blobCreatedEventData));
}
else if (body.data && body.eventType == customEventType) {
var payload = body.data;
context.log("Relaying received custom payload:" + JSON.stringify(payload));
}
}
context.done();
};
Aangepaste gebeurtenisafhandeling testen
Test ten slotte of uw functie nu uw aangepaste gebeurtenistype kan verwerken:
[{
"subject": "Contoso/foo/bar/items",
"eventType": "Contoso.Items.ItemReceived",
"eventTime": "2017-08-16T01:57:26.005121Z",
"id": "602a88ef-0001-00e6-1233-1646070610ea",
"data": {
"itemSku": "Standard"
},
"dataVersion": "",
"metadataVersion": "1"
}]
U kunt deze functionaliteit ook live testen door een aangepaste gebeurtenis met CURL vanuit de portal te verzenden of door te posten naar een aangepast onderwerp met behulp van een service of toepassing die POST naar een eindpunt kan verzenden, zoals Postman. Maak een aangepast onderwerp en een gebeurtenisabonnement met het eindpunt dat is ingesteld als de functie-URL.
Berichtkoppen
Dit zijn de eigenschappen die u ontvangt in de berichtkoppen:
| Eigenschapsnaam | Beschrijving |
|---|---|
| aeg-subscription-name | Naam van het gebeurtenisabonnement. |
| aeg-delivery-count | Aantal pogingen voor de gebeurtenis. |
| aeg-event-type | Type van de gebeurtenis. Dit kan een van de volgende waarden zijn:
|
| aeg-metadata-version | Metagegevensversie van de gebeurtenis. Voor event grid-gebeurtenisschema vertegenwoordigt deze eigenschap de metagegevensversie en voor het cloud-gebeurtenisschema, het vertegenwoordigt de specificatieversie. |
| aeg-data-version | Gegevensversie van de gebeurtenis. Voor Event Grid-gebeurtenisschema vertegenwoordigt deze eigenschap de gegevensversie en voor het cloud-gebeurtenisschema is deze niet van toepassing. |
| aeg-output-event-id | Id van de Event Grid-gebeurtenis. |
Volgende stappen
- De Azure Event Grid-beheer- en publicatie-SDK's verkennen
- Meer informatie over het posten van een aangepast onderwerp
- Probeer een van de uitgebreide zelfstudies voor Event Grid en Functions, zoals het wijzigen van het formaat van afbeeldingen die zijn geüpload naar Blob Storage