Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jandev/azurefunctions-eventgrid
A very lightweight project for publishing events to Azure Event Grid using an Azure Functions output binding
https://github.com/jandev/azurefunctions-eventgrid
azure azure-functions eventgrid
Last synced: 17 days ago
JSON representation
A very lightweight project for publishing events to Azure Event Grid using an Azure Functions output binding
- Host: GitHub
- URL: https://github.com/jandev/azurefunctions-eventgrid
- Owner: Jandev
- License: apache-2.0
- Created: 2019-03-31T17:38:38.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-03-29T13:45:36.000Z (over 2 years ago)
- Last Synced: 2024-11-08T00:43:35.624Z (about 2 months ago)
- Topics: azure, azure-functions, eventgrid
- Language: C#
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 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 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 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`.