@azure/functions package

Classes

HttpRequest

HTTP request object. Provided to your function when using HTTP Bindings.

HttpResponse

HTTP response class

InvocationContext

Contains metadata and helper methods specific to this invocation

Interfaces

Cookie

Http response cookie object to "Set-Cookie"

CosmosDBv3FunctionOptions
CosmosDBv3InputOptions
CosmosDBv3OutputOptions
CosmosDBv3TriggerOptions
CosmosDBv4FunctionOptions
CosmosDBv4InputOptions
CosmosDBv4OutputOptions
CosmosDBv4TriggerOptions
Duration
EffectiveFunctionOptions

The options used when registering the function, as passed to a specific invocation NOTE: This value may differ slightly from the original because it has been validated and defaults may have been explicitly added

EventGridEvent

Link to docs and examples

EventGridFunctionOptions

At this point in time there are no event grid trigger-specific options

EventGridOutputOptions
EventGridPartialEvent

Link to docs and examples This "partial" interface is meant to be used when creating an event yourself and allows some properties to be left out

EventGridTriggerOptions

At this point in time there are no event grid trigger-specific options

EventHubFunctionOptions
EventHubOutputOptions
EventHubTriggerOptions
Exception
ExponentialBackoffRetryOptions
FixedDelayRetryOptions
FunctionInput

Full configuration for the secondary input to a function ("trigger" is the primary input) NOTE: Not all triggers can be used as secondary inputs

FunctionOptions

Configures the inputs, outputs, and handler for an Azure Function

FunctionOutput

Full configuration for the output to a function

FunctionTrigger

Full configuration for the primary input to a function

GenericFunctionOptions

Configures the inputs, outputs, and handler for an Azure Function

GenericInputOptions
GenericOutputOptions
GenericTriggerOptions
HttpFunctionOptions
HttpOutputOptions

At this point in time there are no http output specific options

HttpRequestBodyInit

For testing purposes only. This will always be constructed for you when run in the context of the Azure Functions runtime

HttpRequestInit

For testing purposes only. This will always be constructed for you when run in the context of the Azure Functions runtime

HttpRequestUser

Object representing logged-in user, either through AppService/Functions authentication, or SWA Authentication

HttpResponseInit
HttpTrigger

Full configuration for the primary input to a function

HttpTriggerOptions
InvocationContextExtraInputs

An object used to get secondary inputs

InvocationContextExtraOutputs

An object used to set secondary outputs

InvocationContextInit

For testing purposes only. This will always be constructed for you when run in the context of the Azure Functions runtime

RetryContext
ServiceBusQueueFunctionOptions
ServiceBusQueueOutputOptions
ServiceBusQueueTriggerOptions
ServiceBusTopicFunctionOptions
ServiceBusTopicOutputOptions
ServiceBusTopicTriggerOptions
SqlInputOptions
SqlOutputOptions
StorageBlobFunctionOptions
StorageBlobOptions
StorageBlobTriggerOptions
StorageQueueFunctionOptions
StorageQueueOptions
TableInputOptions
TableOutputOptions
Timer

Timer schedule information. Provided to your function when using a timer binding.

TimerFunctionOptions
TimerTriggerOptions
TraceContext

TraceContext information to enable distributed tracing scenarios

Type Aliases

CosmosDBFunctionOptions
CosmosDBHandler
CosmosDBInput
CosmosDBInputOptions
CosmosDBOutput
CosmosDBOutputOptions
CosmosDBTrigger
CosmosDBTriggerOptions
CosmosDBv3Handler
CosmosDBv3Input
CosmosDBv3Output
CosmosDBv3Trigger
CosmosDBv4Handler
CosmosDBv4Input
CosmosDBv4Output
CosmosDBv4Trigger
EventGridHandler
EventGridOutput
EventGridTrigger
EventHubHandler
EventHubOutput
EventHubTrigger
FunctionHandler
FunctionResult

Void if no return output is registered Otherwise, the registered return output

HttpHandler
HttpMethod

Possible values for an HTTP request method.

HttpMethodFunctionOptions
HttpOutput
HttpRequestParams

Route parameter keys and values.

HttpRequestUserType

Possible values for an HTTP Request user type

LogHandler
LogLevel
RetryOptions
ServiceBusQueueHandler
ServiceBusQueueOutput
ServiceBusQueueTrigger
ServiceBusTopicHandler
ServiceBusTopicOutput
ServiceBusTopicTrigger
SqlInput
SqlOutput
StorageBlobHandler
StorageBlobInput
StorageBlobInputOptions
StorageBlobOutput
StorageBlobOutputOptions
StorageBlobTrigger
StorageQueueHandler
StorageQueueOutput
StorageQueueOutputOptions
StorageQueueTrigger
StorageQueueTriggerOptions
TableInput
TableOutput
TimerHandler
TimerTrigger
TriggerMetadata

Metadata related to the input that triggered your function