Invoke an Azure function
Set up the plugin to invoke an Azure function located in a custom domain.
Prerequisites
-
You have an Azure account with access to Azure Functions.
-
You have created a function.
Environment variables
-
AZURE_FUNCTION_NAME
: The name of the Azure function to invoke. -
AZURE_API_KEY
: Your Azure API key. -
AZURE_APP_NAME
: The name of your Azure app.
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: azure-functions
config:
functionname: ${{ env "DECK_AZURE_FUNCTION_NAME" }}
appname: ${{ env "DECK_AZURE_APP_NAME" }}
hostdomain: azurewebsites.net
apikey: ${{ env "DECK_AZURE_API_KEY" }}
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: azure-functions
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
functionname: '$AZURE_FUNCTION_NAME'
appname: '$AZURE_APP_NAME'
hostdomain: azurewebsites.net
apikey: '$AZURE_API_KEY'
plugin: azure-functions
" | kubectl apply -f -
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_azure_functions" "my_azure_functions" {
enabled = true
config = {
functionname = var.azure_function_name
appname = var.azure_app_name
hostdomain = "azurewebsites.net"
apikey = var.azure_api_key
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value
.
variable "azure_app_name" {
type = string
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: azure-functions
service: serviceName|Id
config:
functionname: ${{ env "DECK_AZURE_FUNCTION_NAME" }}
appname: ${{ env "DECK_AZURE_APP_NAME" }}
hostdomain: azurewebsites.net
apikey: ${{ env "DECK_AZURE_API_KEY" }}
Make sure to replace the following placeholders with your own values:
-
serviceName|Id
: Theid
orname
of the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id
: Theid
orname
of the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
serviceId
: Theid
of the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: azure-functions
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
functionname: '$AZURE_FUNCTION_NAME'
appname: '$AZURE_APP_NAME'
hostdomain: azurewebsites.net
apikey: '$AZURE_API_KEY'
plugin: azure-functions
" | kubectl apply -f -
Next, apply the KongPlugin
resource by annotating the service
resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=azure-functions
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_azure_functions" "my_azure_functions" {
enabled = true
config = {
functionname = var.azure_function_name
appname = var.azure_app_name
hostdomain = "azurewebsites.net"
apikey = var.azure_api_key
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value
.
variable "azure_app_name" {
type = string
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: azure-functions
route: routeName|Id
config:
functionname: ${{ env "DECK_AZURE_FUNCTION_NAME" }}
appname: ${{ env "DECK_AZURE_APP_NAME" }}
hostdomain: azurewebsites.net
apikey: ${{ env "DECK_AZURE_API_KEY" }}
Make sure to replace the following placeholders with your own values:
-
routeName|Id
: Theid
orname
of the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id
: Theid
orname
of the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
routeId
: Theid
of the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: azure-functions
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
functionname: '$AZURE_FUNCTION_NAME'
appname: '$AZURE_APP_NAME'
hostdomain: azurewebsites.net
apikey: '$AZURE_API_KEY'
plugin: azure-functions
" | kubectl apply -f -
Next, apply the KongPlugin
resource by annotating the httproute
or ingress
resource:
kubectl annotate -n kong httproute konghq.com/plugins=azure-functions
kubectl annotate -n kong ingress konghq.com/plugins=azure-functions
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_azure_functions" "my_azure_functions" {
enabled = true
config = {
functionname = var.azure_function_name
appname = var.azure_app_name
hostdomain = "azurewebsites.net"
apikey = var.azure_api_key
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value
.
variable "azure_app_name" {
type = string
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: azure-functions
consumer: consumerName|Id
config:
functionname: ${{ env "DECK_AZURE_FUNCTION_NAME" }}
appname: ${{ env "DECK_AZURE_APP_NAME" }}
hostdomain: azurewebsites.net
apikey: ${{ env "DECK_AZURE_API_KEY" }}
Make sure to replace the following placeholders with your own values:
-
consumerName|Id
: Theid
orname
of the consumer the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id
: Theid
orname
of the consumer the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "azure-functions",
"config": {
"functionname": "'$AZURE_FUNCTION_NAME'",
"appname": "'$AZURE_APP_NAME'",
"hostdomain": "azurewebsites.net",
"apikey": "'$AZURE_API_KEY'"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerId
: Theid
of the consumer the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: azure-functions
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
functionname: '$AZURE_FUNCTION_NAME'
appname: '$AZURE_APP_NAME'
hostdomain: azurewebsites.net
apikey: '$AZURE_API_KEY'
plugin: azure-functions
" | kubectl apply -f -
Next, apply the KongPlugin
resource by annotating the KongConsumer
resource:
kubectl annotate -n kong CONSUMER_NAME konghq.com/plugins=azure-functions
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_azure_functions" "my_azure_functions" {
enabled = true
config = {
functionname = var.azure_function_name
appname = var.azure_app_name
hostdomain = "azurewebsites.net"
apikey = var.azure_api_key
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value
.
variable "azure_app_name" {
type = string
}