Azure Functions Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Azure Functions plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  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.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example azure-functions_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  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.

• route.name or route.id

  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.

• consumer.name or consumer.id

  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.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • timeout

    number default: 600000

    Timeout in milliseconds before closing a connection to the Azure Functions server.

  • keepalive

    number default: 60000

    Time in milliseconds during which an idle connection to the Azure Functions server lives before being closed.

  • https

    boolean default: true

    Use of HTTPS to connect with the Azure Functions server.

  • https_verify

    boolean default: false

    Set to true to authenticate the Azure Functions server.

  • apikey

    string referenceable encrypted

    The apikey to access the Azure resources. If provided, it is injected as the x-functions-key header.

  • clientid

    string referenceable encrypted

    The clientid to access the Azure resources. If provided, it is injected as the x-functions-clientid header.

  • appname

    string required

    The Azure app name.

  • hostdomain

    string required default: azurewebsites.net

    The domain where the function resides.

  • routeprefix

    string default: api

    Route prefix to use.

  • functionname

    string required

    Name of the Azure function to invoke.