-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Note added for the original event grid binding by the team
- Loading branch information
Showing
1 changed file
with
72 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,72 @@ | ||
| # Azure Functions Event Grid binding | ||
|
|
||
| An easy to use Azure Functions output binding for Azure Event Grid. | ||
|
|
||
| ## Badges | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
|
|
||
| ## Download | ||
|
|
||
| The compiled version can be downloaded via NuGet (https://www.nuget.org/packages/AzureFunctions.EventGridBinding/), so you can use it in your project. | ||
|
|
||
| ## Usage | ||
|
|
||
| A sample on how you can use the output binding is as follows. | ||
|
|
||
| ```csharp | ||
| [FunctionName("Test")] | ||
| public static async Task<IActionResult> Run( | ||
| [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = null)] HttpRequest req, | ||
| [EventGrid( | ||
| // The endpoint of your Event Grid Topic, this should be specified in your application settings of the Function App | ||
| TopicEndpoint = "EventGridBindingSampleTopicEndpoint", | ||
| // This is the secret key to connect to your Event Grid Topic. To be placed in the application settings. | ||
| TopicKey = "EventGridBindingSampleTopicKey")] | ||
| IAsyncCollector<Event> outputCollector, | ||
| ILogger log) | ||
| { | ||
| log.LogInformation("Executing the Test function"); | ||
|
|
||
| // Create the actual `Data` object you want to publish to Event Grid | ||
| var customEvent = new MyCustomEvent | ||
| { | ||
| Identifier = 1, | ||
| Name = "Jan", | ||
| Product = "Azure Functions" | ||
| }; | ||
| // Specify some meta data of the message you want to publish to Event Grid | ||
| var myTestEvent = new Event | ||
| { | ||
| EventType = nameof(MyCustomEvent), | ||
| Subject = "Jandev/Samples/CustomTestEvent", | ||
| Data = customEvent | ||
| }; | ||
|
|
||
| // Add the event to the IAsyncCollector<T> in order to get your event published. | ||
| await outputCollector.AddAsync(myTestEvent); | ||
|
|
||
| log.LogInformation("Executed the Test function"); | ||
|
|
||
| return new OkObjectResult($"Sending {customEvent.Identifier}."); | ||
| } | ||
|
|
||
| private class MyCustomEvent | ||
| { | ||
| public int Identifier { get; set; } | ||
| public string Name { get; set; } | ||
| public string Product { get; set; } | ||
| } | ||
| ``` | ||
|
|
||
| The publishing of the events will be executed after the Azure Function is finished, | ||
| in the `FlushAsync` method of the `IAsyncCollector<T>`. | ||
| # Azure Functions Event Grid binding | ||
|
|
||
| An easy to use Azure Functions output binding for Azure Event Grid. | ||
|
|
||
| ## Moving on | ||
|
|
||
| When I created this package, there wasn't an Event Grid binding available for Azure Functions. Nowadays, there is one provided to you by the team. I recommend you start using the binding which is supported by the team in favor of this one. [More information can be found in the docs.](https://docs.microsoft.com/en-us/azure/azure-functions/functions-bindings-event-grid?tabs=in-process%2Cextensionv3&pivots=programming-language-csharp). | ||
|
|
||
| ## Badges | ||
|
|
||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
| [](https://sonarcloud.io/dashboard?id=azurefunctions-eventgrid) | ||
|
|
||
| ## Download | ||
|
|
||
| The compiled version can be downloaded via NuGet (https://www.nuget.org/packages/AzureFunctions.EventGridBinding/), so you can use it in your project. | ||
|
|
||
| ## Usage | ||
|
|
||
| A sample on how you can use the output binding is as follows. | ||
|
|
||
| ```csharp | ||
| [FunctionName("Test")] | ||
| public static async Task<IActionResult> Run( | ||
| [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = null)] HttpRequest req, | ||
| [EventGrid( | ||
| // The endpoint of your Event Grid Topic, this should be specified in your application settings of the Function App | ||
| TopicEndpoint = "EventGridBindingSampleTopicEndpoint", | ||
| // This is the secret key to connect to your Event Grid Topic. To be placed in the application settings. | ||
| TopicKey = "EventGridBindingSampleTopicKey")] | ||
| IAsyncCollector<Event> outputCollector, | ||
| ILogger log) | ||
| { | ||
| log.LogInformation("Executing the Test function"); | ||
|
|
||
| // Create the actual `Data` object you want to publish to Event Grid | ||
| var customEvent = new MyCustomEvent | ||
| { | ||
| Identifier = 1, | ||
| Name = "Jan", | ||
| Product = "Azure Functions" | ||
| }; | ||
| // Specify some meta data of the message you want to publish to Event Grid | ||
| var myTestEvent = new Event | ||
| { | ||
| EventType = nameof(MyCustomEvent), | ||
| Subject = "Jandev/Samples/CustomTestEvent", | ||
| Data = customEvent | ||
| }; | ||
|
|
||
| // Add the event to the IAsyncCollector<T> in order to get your event published. | ||
| await outputCollector.AddAsync(myTestEvent); | ||
|
|
||
| log.LogInformation("Executed the Test function"); | ||
|
|
||
| return new OkObjectResult($"Sending {customEvent.Identifier}."); | ||
| } | ||
|
|
||
| private class MyCustomEvent | ||
| { | ||
| public int Identifier { get; set; } | ||
| public string Name { get; set; } | ||
| public string Product { get; set; } | ||
| } | ||
| ``` | ||
|
|
||
| The publishing of the events will be executed after the Azure Function is finished, | ||
| in the `FlushAsync` method of the `IAsyncCollector<T>`. |