This repository has been archived by the owner on Feb 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
88069a4
commit 541c997
Showing
1 changed file
with
60 additions
and
60 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,61 +1,61 @@ | ||
| --- | ||
| page_type: sample | ||
| languages: | ||
| - csharp | ||
| - yaml | ||
| products: | ||
| - dotnet | ||
| - dotnet-core | ||
| - azure-functions | ||
| - azure-event-grid | ||
| - azure-storage | ||
| - azure-blob-storage | ||
| - azure-devops | ||
| --- | ||
|
|
||
| # Subscribing an Azure Function to Event Grid Events via Terraform | ||
|
|
||
| This sample will show you how to create Terraform scripts that create an Azure Function and Subscribe it to Event Grid Storage events. | ||
| This is especially interesting as, for Event Grid Subscriptions, the target endpoint must answer EG's "[Subscription Validation Event](https://docs.microsoft.com/en-us/azure/event-grid/security-authentication#validation-details)" which it cannot do until it is deployed. So this method - affectionally coined a "Terraform Sandwich" - shows how to do just that. | ||
|
|
||
| ## Deploying locally | ||
| 1. Open the repo in its VS Code Dev Container (this ensures you have all the right versions of the necessary tooling) | ||
| 1. run `az login` and `az account set --subscription <target subscription id>` to connect to your Azure Subscription | ||
| 1. `cd infrastructure/terraform` | ||
| 1. run `terraform init` | ||
| 1. run `terraform apply -var 'prefix=<some unique prefix here>' -target module.functions` | ||
| 1. `cd ../../src/FunctionApp` | ||
| 1. run `func azure functionapp publish <the name of the functionapp outputted by terraform apply> --csharp` | ||
| 1. `cd ../../infrastructure/terraform` | ||
| 1. run `terraform apply -var 'prefix=<same prefix as before>'` | ||
|
|
||
| ### What it does | ||
| - Tells terraform to run everything **except** the event grid subscription piece | ||
| - Deploys the function app out to Azure so it's ready to answer the subscription wire-up that Terraform will do next | ||
| - Tells terraform to apply **everything**, which issues the necessary changes to Azure to add the event grid subscription to an 'inbox' storage account | ||
|
|
||
| ## Deploying via Azure DevOps | ||
| By importing the [azure-piplines.yaml](./azure-pipelines.yaml) file in to an Azure DevOps pipeline, you'll get the same process as the above local execution. | ||
| > Note: Be sure to uncomment change [the `PREFIX` variable](./azure-pipelines.yml#L10) to something unique to you to avoid naming collisions on storage & function apps | ||
| <img src="img/azdo_run.png" alt="Azure DevOps successful run" width="200"/> | ||
|
|
||
| ## Running the sample | ||
| This sample has an Azure Function that subscribes to Blob Storage Events and then simply passes the event on to a custom Event Grid Topic. The receiving and sending of events is accomplished via the Event Grid Binding for Azure Functions. | ||
|
|
||
| To exercise the sample: | ||
| 1. Open the 'inbox' storage account created by the deployment | ||
| 1. Create a new container | ||
| 1. Upload a file in to the container | ||
|
|
||
| Next, go to the Azure Portal, and the Storage Account created by the deployment. Click the 'Events' area and you will see one or more events have come through: | ||
|
|
||
| <img src="img/azstorevents.png" alt="Azure Portal Storage Events area" width="600"/> | ||
|
|
||
| Then go to the custom topic created by deployment, and you'll see that one or more events have been posted to it: | ||
|
|
||
| <img src="img/azcustomtopicevents.png" alt="Azure Portal Custom Topic Events area" width="600"/> | ||
|
|
||
| Finally, if you wish to see the output from the Function, go to the Application Insights resource created by deployment and look through the logged TRACE events: | ||
|
|
||
| --- | ||
| page_type: sample | ||
| languages: | ||
| - csharp | ||
| - yaml | ||
| products: | ||
| - dotnet | ||
| - dotnet-core | ||
| - azure-functions | ||
| - azure-event-grid | ||
| - azure-storage | ||
| - azure-blob-storage | ||
| - azure-devops | ||
| --- | ||
|
|
||
| # Subscribing an Azure Function to Event Grid Events via Terraform | ||
|
|
||
| This sample will show you how to create Terraform scripts that create an Azure Function and Subscribe it to Event Grid Storage events. | ||
| This is especially interesting as, for Event Grid Subscriptions, the target endpoint must answer EG's "[Subscription Validation Event](https://docs.microsoft.com/en-us/azure/event-grid/security-authentication#validation-details)" which it cannot do until it is deployed. So this method - affectionally coined a "Terraform Sandwich" - shows how to do just that. | ||
|
|
||
| ## Deploying locally | ||
| 1. Open the repo in its VS Code Dev Container (this ensures you have all the right versions of the necessary tooling) | ||
| 1. run `az login` and `az account set --subscription <target subscription id>` to connect to your Azure Subscription | ||
| 1. `cd infrastructure/terraform` | ||
| 1. run `terraform init` | ||
| 1. run `terraform apply -var prefix=<some unique prefix here> -target module.functions` | ||
| 1. `cd ../../src/FunctionApp` | ||
| 1. run `func azure functionapp publish <the name of the functionapp outputted by terraform apply> --csharp` | ||
| 1. `cd ../../infrastructure/terraform` | ||
| 1. run `terraform apply -var prefix=<same prefix as before>` | ||
|
|
||
| ### What it does | ||
| - Tells terraform to run everything **except** the event grid subscription piece | ||
| - Deploys the function app out to Azure so it's ready to answer the subscription wire-up that Terraform will do next | ||
| - Tells terraform to apply **everything**, which issues the necessary changes to Azure to add the event grid subscription to an 'inbox' storage account | ||
|
|
||
| ## Deploying via Azure DevOps | ||
| By importing the [azure-piplines.yaml](./azure-pipelines.yaml) file in to an Azure DevOps pipeline, you'll get the same process as the above local execution. | ||
| > Note: Be sure to change [the `PREFIX` variable](./azure-pipelines.yml#L10) to something unique to you to avoid naming collisions on storage & function apps | ||
| <img src="img/azdo_run.png" alt="Azure DevOps successful run" width="200"/> | ||
|
|
||
| ## Running the sample | ||
| This sample has an Azure Function that subscribes to Blob Storage Events and then simply passes the event on to a custom Event Grid Topic. The receiving and sending of events is accomplished via the Event Grid Binding for Azure Functions. | ||
|
|
||
| To exercise the sample: | ||
| 1. Open the 'inbox' storage account created by the deployment | ||
| 1. Create a new container | ||
| 1. Upload a file in to the container | ||
|
|
||
| Next, go to the Azure Portal, and the Storage Account created by the deployment. Click the 'Events' area and you will see one or more events have come through: | ||
|
|
||
| <img src="img/azstorevents.png" alt="Azure Portal Storage Events area" width="600"/> | ||
|
|
||
| Then go to the custom topic created by deployment, and you'll see that one or more events have been posted to it: | ||
|
|
||
| <img src="img/azcustomtopicevents.png" alt="Azure Portal Custom Topic Events area" width="600"/> | ||
|
|
||
| Finally, if you wish to see the output from the Function, go to the Application Insights resource created by deployment and look through the logged TRACE events: | ||
|
|
||
| <img src="img/azloggedevents.png" alt="Azure Portal Custom Topic Events area" width="600"/> |