StorageBlobFunctionOptions interface

Package:
@azure/functions
Extends

StorageBlobTriggerOptions,Partial<FunctionOptions>

Properties

handler

The code that will be executed when your function is triggered
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

Inherited Properties

connection

An app setting (or environment variable) with the storage connection string to be used by this blob input or output
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()
path

The path to the blob container, for example "samples-workitems/{name}"
return

Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation
source

The source of the triggering event. Use EventGrid for an Event Grid-based blob trigger, which provides much lower latency. The default is LogsAndContainerScan, which uses the standard polling mechanism to detect changes in the container.

Property Details

handler

The code that will be executed when your function is triggered

handler: StorageBlobHandler

Property Value

StorageBlobHandler

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?: StorageBlobTrigger

Property Value

StorageBlobTrigger

Inherited Property Details

connection

An app setting (or environment variable) with the storage connection string to be used by this blob input or output

connection: string

Property Value

string

Inherited From StorageBlobTriggerOptions.connection

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 Partial.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 Partial.extraOutputs

path

The path to the blob container, for example "samples-workitems/{name}"

path: string

Property Value

string

Inherited From StorageBlobTriggerOptions.path

return

Configuration for the optional primary output of the function 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 Partial.return

source

The source of the triggering event. Use EventGrid for an Event Grid-based blob trigger, which provides much lower latency. The default is LogsAndContainerScan, which uses the standard polling mechanism to detect changes in the container.

source?: "EventGrid" | "LogsAndContainerScan"

Property Value

"EventGrid" | "LogsAndContainerScan"

Inherited From StorageBlobTriggerOptions.source