Azure Functions

Overview Examples Configuration reference Changelog

Configuration

configobjectrequired

Hide Child Parameters

apikeystring

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

appnamestringrequired

The Azure app name.

clientidstring

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

functionnamestringrequired

Name of the Azure function to invoke.

hostdomainstring

The domain where the function resides.

Default:azurewebsites.net

httpsboolean

Use of HTTPS to connect with the Azure Functions server.

Default:true

https_verifyboolean

Set to true to authenticate the Azure Functions server.

Default:false

keepalivenumber

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

Default:60000

routeprefixstring

Route prefix to use.

Default:api

timeoutnumber

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

Default:600000

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Azure Functions

Configuration

Did this doc help?

Help us make these docs great!

Still need help