HttpDurableClientOptions interface

Package:

durable-functions

Configures options for an HTTP-triggered Durable Client function.

Extends

Omit<HttpFunctionOptions, "handler">

Properties

handler

Inherited Properties

authLevel	The function HTTP authorization level Defaults to 'anonymous' if not specified
extraInputs	Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()
extraOutputs	Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()
methods	An array of the http methods for this http input Defaults to ["get", "post"] if not specified
return	Configuration for the optional primary output of the function. If not set, this will default to a standard http response output This is the main output that you should set as the return value of the function handler during invocation
route	The route for this http input. If not specified, the function name will be used
trigger	Configuration for the primary input to the function, aka the reason it will be triggered This is the only input that is passed as an argument to the function handler during invocation

Property Details

handler

handler: HttpDurableClientHandler

Property Value

HttpDurableClientHandler

Inherited Property Details

authLevel

The function HTTP authorization level Defaults to 'anonymous' if not specified

authLevel?: "function" | "anonymous" | "admin"

Property Value

"function" | "anonymous" | "admin"

Inherited From Omit.authLevel

extraInputs

Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()

extraInputs?: FunctionInput[]

Property Value

FunctionInput[]

Inherited From Omit.extraInputs

extraOutputs

Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Property Value

FunctionOutput[]

Inherited From Omit.extraOutputs

methods

An array of the http methods for this http input Defaults to ["get", "post"] if not specified

methods?: HttpMethod[]

Property Value

HttpMethod[]

Inherited From Omit.methods

return

Configuration for the optional primary output of the function. If not set, this will default to a standard http response output This is the main output that you should set as the return value of the function handler during invocation

return?: FunctionOutput

Property Value

FunctionOutput

Inherited From Omit.return

route

The route for this http input. If not specified, the function name will be used

route?: string

Property Value

string

Inherited From Omit.route

trigger

Configuration for the primary input to the function, aka the reason it will be triggered This is the only input that is passed as an argument to the function handler during invocation

trigger?: HttpTrigger

Property Value

HttpTrigger

Inherited From Omit.trigger