You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
string required
The name of the plugin, in this case
azure-functions
.- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
name
. - If using the KongPlugin object in Kubernetes, the field is
plugin
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
string
The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level
/plugins
endpoint. Not required if using/services/{serviceName|Id}/plugins
. -
string
The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level
/plugins
endpoint. Not required if using/routes/{routeName|Id}/plugins
. -
string
The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level
/plugins
endpoint. Not required if using/consumers/{consumerName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
number default:
600000
Timeout in milliseconds before closing a connection to the Azure Functions server.
-
number default:
60000
Time in milliseconds during which an idle connection to the Azure Functions server lives before being closed.
-
boolean default:
true
Use of HTTPS to connect with the Azure Functions server.
-
boolean default:
false
Set to
true
to authenticate the Azure Functions server.
-
string referenceable encrypted
The apikey to access the Azure resources. If provided, it is injected as the
x-functions-key
header.
-
string referenceable encrypted
The
clientid
to access the Azure resources. If provided, it is injected as thex-functions-clientid
header.
-
string required
The Azure app name.
-
string required default:
azurewebsites.net
The domain where the function resides.
-
string default:
api
Route prefix to use.
-
string required
Name of the Azure function to invoke.
-