@azure/functions

constructor

constructor(init?: AppStartContextInit);

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

constructor

constructor(init?: AppTerminateContextInit);

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

constructor

constructor(callOnDispose: () => any);

• Creates a new disposable that calls the provided function on dispose. *Note* that an asynchronous function is not awaited.

  Parameter callOnDispose

  Function that disposes something.

method dispose

dispose: () => any;

• Dispose this object.

method from

static from: (...disposableLikes: { dispose: () => any }[]) => Disposable;

• Combine many disposable-likes into one. You can use this method when having objects with a dispose function which aren't instances of Disposable.

  Parameter disposableLikes

  Objects that have at least a dispose-function member. Note that asynchronous dispose-functions aren't awaited. Returns a new disposable which, upon dispose, will dispose all provided disposables.

constructor

constructor(init?: HookContextInit);

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

property hookData

readonly hookData: Record<string, unknown>;

• The recommended place to store and share data between hooks in the same scope (app-level vs invocation-level). You should use a unique property name so that it doesn't conflict with other hooks' data. This object is readonly. You may modify it, but attempting to overwrite it will throw an error

constructor

constructor(httpRequestInit: HttpRequestInit);

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

property arrayBuffer

readonly arrayBuffer: () => Promise<ArrayBuffer>;

• Returns a promise fulfilled with the body as an ArrayBuffer

property blob

readonly blob: () => Promise<Blob>;

• Returns a promise fulfilled with the body as a Blob

property body

readonly body: any;

• Returns the body as a ReadableStream

property bodyUsed

readonly bodyUsed: boolean;

• Returns whether the body has been read from

property formData

readonly formData: () => Promise<FormData>;

• Returns a promise fulfilled with the body as FormData

property headers

readonly headers: Headers;

• HTTP request headers.

property json

readonly json: () => Promise<unknown>;

• Returns a promise fulfilled with the body parsed as JSON

property method

readonly method: string;

• HTTP request method used to invoke this function.

property params

readonly params: HttpRequestParams;

• Route parameter keys and values.

property query

readonly query: URLSearchParams;

• Query string parameter keys and values from the URL.

property text

readonly text: () => Promise<string>;

• Returns a promise fulfilled with the body as a string

property url

readonly url: string;

• Request URL.

property user

readonly user: HttpRequestUser;

• Object representing logged-in user, either through AppService/Functions authentication, or SWA Authentication null when no such user is logged in.

constructor

constructor(responseInit?: HttpResponseInit);

property arrayBuffer

readonly arrayBuffer: () => Promise<ArrayBuffer>;

• Returns a promise fulfilled with the body as an ArrayBuffer

property blob

readonly blob: () => Promise<Blob>;

• Returns a promise fulfilled with the body as a Blob

property body

readonly body: any;

• Returns the body as a ReadableStream

property bodyUsed

readonly bodyUsed: boolean;

• Returns whether the body has been read from

property cookies

readonly cookies: Cookie[];

• HTTP response cookies

property enableContentNegotiation

readonly enableContentNegotiation: boolean;

• Enable content negotiation of response body if true If false, treat response body as raw false

property formData

readonly formData: () => Promise<FormData>;

• Returns a promise fulfilled with the body as FormData

property headers

readonly headers: Headers;

• HTTP response headers.

property json

readonly json: () => Promise<unknown>;

• Returns a promise fulfilled with the body parsed as JSON

property status

readonly status: number;

• HTTP response status code 200

property text

readonly text: () => Promise<string>;

• Returns a promise fulfilled with the body as a string

constructor

constructor(init?: InvocationContextInit);

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

property extraInputs

extraInputs: InvocationContextExtraInputs;

• An object used to get secondary inputs

property extraOutputs

extraOutputs: InvocationContextExtraOutputs;

• An object used to set secondary outputs

property functionName

functionName: string;

• The name of the function that is being invoked

property invocationId

invocationId: string;

• A unique guid specific to this invocation

property options

options: EffectiveFunctionOptions;

• The options used when registering the function NOTE: This value may differ slightly from the original because it has been validated and defaults may have been explicitly added

property retryContext

retryContext?: RetryContext;

• The retry context of the current function execution if the retry policy is defined

property traceContext

traceContext?: TraceContext;

• TraceContext information to enable distributed tracing scenarios

property triggerMetadata

triggerMetadata?: TriggerMetadata;

• Metadata about the trigger or undefined if the metadata is already represented elsewhere For example, this will be undefined for http and timer triggers because you can find that information on the request & timer object instead

method debug

debug: (...args: any[]) => void;

• The recommended way to log debug data (level 1) during invocation. Similar to Node.js's console.debug, but has integration with Azure features like application insights

method error

error: (...args: any[]) => void;

• The recommended way to log error data (level 4) during invocation. Similar to Node.js's console.error, but has integration with Azure features like application insights

method info

info: (...args: any[]) => void;

• The recommended way to log information data (level 2) during invocation. Similar to Node.js's console.info, but has integration with Azure features like application insights

method log

log: (...args: any[]) => void;

• The recommended way to log data during invocation. Similar to Node.js's console.log, but has integration with Azure features like application insights Uses the 'information' log level

method trace

trace: (...args: any[]) => void;

• The recommended way to log trace data (level 0) during invocation. Similar to Node.js's console.trace, but has integration with Azure features like application insights

method warn

warn: (...args: any[]) => void;

• The recommended way to log warning data (level 3) during invocation. Similar to Node.js's console.warn, but has integration with Azure features like application insights

constructor

constructor(init?: InvocationHookContextInit);

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

property invocationContext

readonly invocationContext: InvocationContext;

• The context object passed to the function. This object is readonly. You may modify it, but attempting to overwrite it will throw an error

constructor

constructor(init?: PostInvocationContextInit);

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

property error

error: {};

• The error thrown by the function, or null/undefined if there is no error. Changes to this value _will_ affect the overall result of the function

property inputs

inputs: unknown[];

• The arguments passed to this specific invocation.

property result

result: {};

• The result of the function. Changes to this value _will_ affect the overall result of the function

constructor

constructor(init?: PreInvocationContextInit);

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

property functionHandler

functionHandler: FunctionHandler;

• The function handler for this specific invocation. Changes to this value _will_ affect the function itself

property inputs

inputs: unknown[];

• The arguments passed to this specific invocation. Changes to this array _will_ affect the inputs passed to your function

property domain

domain?: string;

• Specifies allowed hosts to receive the cookie

property expires

expires?: Date | number;

• NOTE: It is generally recommended that you use maxAge over expires. Sets the cookie to expire at a specific date instead of when the client closes. This can be a Javascript Date or Unix time in milliseconds.

property httpOnly

httpOnly?: boolean;

• Sets the cookie to be inaccessible to JavaScript's Document.cookie API

property maxAge

maxAge?: number;

• Number of seconds until the cookie expires. A zero or negative number will expire the cookie immediately.

property name

name: string;

property path

path?: string;

• Specifies URL path that must exist in the requested URL

property sameSite

sameSite?: 'Strict' | 'Lax' | 'None' | undefined;

• Can restrict the cookie to not be sent with cross-site requests

property secure

secure?: boolean;

• Sets the cookie to only be sent with an encrypted request

property value

value: string;

property handler

handler: CosmosDBv3Handler;

property retry

retry?: RetryOptions;

• An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more [here](https://learn.microsoft.com/azure/azure-functions/functions-bindings-error-pages)

property trigger

trigger?: CosmosDBv3Trigger;

property collectionName

collectionName: string;

• The name of the collection being monitored

property connectionStringSetting

connectionStringSetting: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the collection being monitored

property id

id?: string;

• The ID of the document to retrieve. This property supports [binding expressions](https://docs.microsoft.com/azure/azure-functions/functions-bindings-expressions-patterns). Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.

property partitionKey

partitionKey?: string;

• Specifies the partition key value for the lookup. May include binding parameters. It is required for lookups in partitioned collections

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property sqlQuery

sqlQuery?: string;

• An Azure Cosmos DB SQL query used for retrieving multiple documents. The property supports runtime bindings, as in this example: SELECT * FROM c where c.departmentId = {departmentId} Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.

property collectionName

collectionName: string;

• The name of the collection being monitored

property collectionThroughput

collectionThroughput?: number;

• When createIfNotExists is true, it defines the [throughput](https://docs.microsoft.com/azure/cosmos-db/set-throughput) of the created collection

property connectionStringSetting

connectionStringSetting: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property createIfNotExists

createIfNotExists?: boolean;

• A boolean value to indicate whether the collection is created when it doesn't exist. The default is false because new collections are created with reserved throughput, which has cost implications. For more information, see the [pricing page](https://azure.microsoft.com/pricing/details/cosmos-db/).

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the collection being monitored

property partitionKey

partitionKey?: string;

• When createIfNotExists is true, it defines the partition key path for the created collection. May include binding parameters.

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property useMultipleWriteLocations

useMultipleWriteLocations?: boolean;

• When set to true along with preferredLocations, supports multi-region writes in the Azure Cosmos DB service.

property checkpointDocumentCount

checkpointDocumentCount?: number;

• Customizes the amount of documents between lease checkpoints. Default is after every function call.

property checkpointInterval

checkpointInterval?: number;

• When set, it defines, in milliseconds, the interval between lease checkpoints. Default is always after each Function call.

property collectionName

collectionName: string;

• The name of the collection being monitored

property connectionStringSetting

connectionStringSetting: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property createLeaseCollectionIfNotExists

createLeaseCollectionIfNotExists?: boolean;

• Checks for existence and automatically creates the leases collection. Default is false

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the collection being monitored

property feedPollDelay

feedPollDelay?: number;

• The time (in milliseconds) for the delay between polling a partition for new changes on the feed, after all current changes are drained. Default is 5,000 milliseconds, or 5 seconds.

property leaseAcquireInterval

leaseAcquireInterval?: number;

• When set, it defines, in milliseconds, the interval to kick off a task to compute if partitions are distributed evenly among known host instances. Default is 13000 (13 seconds).

property leaseCollectionName

leaseCollectionName?: string;

• The name of the collection to store leases. If not set, it will use "leases"

property leaseCollectionPrefix

leaseCollectionPrefix?: string;

• When set, the value is added as a prefix to the leases created in the Lease collection for this function. Using a prefix allows two separate Azure Functions to share the same Lease collection by using different prefixes.

property leaseCollectionThroughput

leaseCollectionThroughput?: number;

• When createLeaseCollectionIfNotExists is set to true, defines the amount of Request Units to assign to the created lease collection

property leaseConnectionStringSetting

leaseConnectionStringSetting?: string;

• The name of an app setting that contains the connection string to the service which holds the lease collection. If not set it will connect to the service defined by connectionStringSetting

property leaseDatabaseName

leaseDatabaseName?: string;

• The name of the database that holds the collection to store leases. If not set, it will use the value of databaseName

property leaseExpirationInterval

leaseExpirationInterval?: number;

• When set, it defines, in milliseconds, the interval for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another instance. Default is 60000 (60 seconds).

property leaseRenewInterval

leaseRenewInterval?: number;

• When set, it defines, in milliseconds, the renew interval for all leases for partitions currently held by an instance. Default is 17000 (17 seconds).

property maxItemsPerInvocation

maxItemsPerInvocation?: number;

• When set, this property sets the maximum number of items received per Function call. If operations in the monitored container are performed through stored procedures, transaction scope is preserved when reading items from the change feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property startFromBeginning

startFromBeginning?: boolean;

• This option tells the Trigger to read changes from the beginning of the container's change history instead of starting at the current time. Reading from the beginning only works the first time the trigger starts, as in subsequent runs, the checkpoints are already stored. Setting this option to true when there are leases already created has no effect.

property useMultipleWriteLocations

useMultipleWriteLocations?: boolean;

• Enables multi-region accounts for writing to the leases collection.

property handler

handler: CosmosDBv4Handler;

property retry

retry?: RetryOptions;

• An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more [here](https://learn.microsoft.com/azure/azure-functions/functions-bindings-error-pages)

property trigger

trigger?: CosmosDBv4Trigger;

property connection

connection: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property containerName

containerName: string;

• The name of the container being monitored

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the container being monitored

property id

id?: string;

• The ID of the document to retrieve. This property supports [binding expressions](https://docs.microsoft.com/azure/azure-functions/functions-bindings-expressions-patterns). Don't set both the id and sqlQuery properties. If you don't set either one, the entire container is retrieved.

property partitionKey

partitionKey?: string;

• Specifies the partition key value for the lookup. May include binding parameters. It is required for lookups in partitioned containers

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property sqlQuery

sqlQuery?: string;

• An Azure Cosmos DB SQL query used for retrieving multiple documents. The property supports runtime bindings, as in this example: SELECT * FROM c where c.departmentId = {departmentId} Don't set both the id and sqlQuery properties. If you don't set either one, the entire container is retrieved.

property connection

connection: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property containerName

containerName: string;

• The name of the collection being monitored

property containerThroughput

containerThroughput?: number;

• When createIfNotExists is true, it defines the [throughput](https://docs.microsoft.com/azure/cosmos-db/set-throughput) of the created collection

property createIfNotExists

createIfNotExists?: boolean;

• A boolean value to indicate whether the collection is created when it doesn't exist. The default is false because new collections are created with reserved throughput, which has cost implications. For more information, see the [pricing page](https://azure.microsoft.com/pricing/details/cosmos-db/).

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the collection being monitored

property partitionKey

partitionKey?: string;

• When createIfNotExists is true, it defines the partition key path for the created collection. May include binding parameters.

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property connection

connection: string;

• An app setting (or environment variable) with the Cosmos DB connection string

property containerName

containerName: string;

• The name of the container being monitored

property createLeaseContainerIfNotExists

createLeaseContainerIfNotExists?: boolean;

• Checks for existence and automatically creates the leases container. Default is false

property databaseName

databaseName: string;

• The name of the Azure Cosmos DB database with the container being monitored

property feedPollDelay

feedPollDelay?: number;

• The time (in milliseconds) for the delay between polling a partition for new changes on the feed, after all current changes are drained. Default is 5,000 milliseconds, or 5 seconds.

property leaseAcquireInterval

leaseAcquireInterval?: number;

• When set, it defines, in milliseconds, the interval to kick off a task to compute if partitions are distributed evenly among known host instances. Default is 13000 (13 seconds).

property leaseConnection

leaseConnection?: string;

• The name of an app setting that contains the connection string to the service which holds the lease container. If not set it will connect to the service defined by connection

property leaseContainerName

leaseContainerName?: string;

• The name of the container to store leases. If not set, it will use "leases"

property leaseContainerPrefix

leaseContainerPrefix?: string;

• When set, the value is added as a prefix to the leases created in the Lease container for this function. Using a prefix allows two separate Azure Functions to share the same Lease container by using different prefixes.

property leaseDatabaseName

leaseDatabaseName?: string;

• The name of the database that holds the container to store leases. If not set, it will use the value of databaseName

property leaseExpirationInterval

leaseExpirationInterval?: number;

• When set, it defines, in milliseconds, the interval for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another instance. Default is 60000 (60 seconds).

property leaseRenewInterval

leaseRenewInterval?: number;

• When set, it defines, in milliseconds, the renew interval for all leases for partitions currently held by an instance. Default is 17000 (17 seconds).

property leasesContainerThroughput

leasesContainerThroughput?: number;

• When createLeaseContainerIfNotExists is set to true, defines the amount of Request Units to assign to the created lease container

property maxItemsPerInvocation

maxItemsPerInvocation?: number;

• When set, this property sets the maximum number of items received per Function call. If operations in the monitored container are performed through stored procedures, transaction scope is preserved when reading items from the change feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.

property preferredLocations

preferredLocations?: string;

• Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

property startFromBeginning

startFromBeginning?: boolean;

• This option tells the Trigger to read changes from the beginning of the container's change history instead of starting at the current time. Reading from the beginning only works the first time the trigger starts, as in subsequent runs, the checkpoints are already stored. Setting this option to true when there are leases already created has no effect.

property startFromTime

startFromTime?: string;

• Gets or sets the date and time from which to initialize the change feed read operation. The recommended format is ISO 8601 with the UTC designator, such as 2021-02-16T14:19:29Z. This is only used to set the initial trigger state. After the trigger has a lease state, changing this value has no effect.

property hours

hours?: number;

property milliseconds

milliseconds?: number;

property minutes

minutes?: number;

property seconds

seconds?: number;

property extraInputs

extraInputs: FunctionInput[];

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

property extraOutputs

extraOutputs: FunctionOutput[];

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

property return

return?: FunctionOutput;

• 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

property trigger

trigger: FunctionTrigger;

• 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 dataVersion

dataVersion: string;

• The schema version of the data object. The publisher defines the schema version.

property metadataVersion

metadataVersion: string;

• The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.

property topic

topic: string;

• Full resource path to the event source. This field isn't writeable. Event Grid provides this value

property handler

handler: EventGridHandler;

property trigger

trigger?: EventGridTrigger;

property connection

connection: string;

• The value of the common prefix for the app setting that contains the topicEndpointUri. When setting the connection property, the topicEndpointUri and topicKeySetting properties should NOT be set.

property topicEndpointUri

topicEndpointUri: string;

• An app setting (or environment variable) that contains the URI for the custom topic

property topicKeySetting

topicKeySetting: string;

• An app setting (or environment variable) that contains an access key for the custom topic

property data

data?: Record<string, unknown>;

• Event data specific to the resource provider

property dataVersion

dataVersion?: string;

• The schema version of the data object. The publisher defines the schema version. If not included, will be stamped with an empty value

property eventTime

eventTime: string;

• The time the event is generated based on the provider's UTC time

property eventType

eventType: string;

• One of the registered event types for this event source

property id

id: string;

• Unique identifier for the event

property metadataVersion

metadataVersion?: string;

• The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. If included, must match the Event Grid Schema metadataVersion exactly (currently, only 1). If not included, Event Grid will stamp onto the event.

property subject

subject: string;

• Publisher-defined path to the event subject

property topic

topic?: string;

• Full resource path to the event source. This field isn't writeable. Event Grid provides this value If included, must match the Event Grid topic Azure Resource Manager ID exactly. If not included, Event Grid will stamp onto the event.

property handler

handler: EventHubHandler;

property retry

retry?: RetryOptions;

• An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more [here](https://learn.microsoft.com/azure/azure-functions/functions-bindings-error-pages)

property trigger

trigger?: EventHubTrigger;

property connection

connection: string;

• An app setting (or environment variable) with the event hub connection string

property eventHubName

eventHubName: string;

• The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime.

property cardinality

cardinality?: 'many' | 'one';

• Set to many in order to enable batching. If omitted or set to one, a single message is passed to the function.

property connection

connection: string;

• An app setting (or environment variable) with the event hub connection string

property consumerGroup

consumerGroup?: string;

• An optional property that sets the [consumer group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#event-consumers) used to subscribe to events in the hub. If omitted, the $Default consumer group is used.

property eventHubName

eventHubName: string;

• The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime.

property message

message?: string;

property source

source?: string;

property stackTrace

stackTrace?: string;

property maximumInterval

maximumInterval: Duration | number;

• The maximum retry delay. This can be a number in milliseconds, or a Duration object

property maxRetryCount

maxRetryCount: number;

• The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

property minimumInterval

minimumInterval: Duration | number;

• The minimum retry delay. This can be a number in milliseconds, or a Duration object

property strategy

strategy: 'exponentialBackoff';

• The first retry waits for the minimum delay. On subsequent retries, time is added exponentially to the initial duration for each retry, until the maximum delay is reached. Exponential back-off adds some small randomization to delays to stagger retries in high-throughput scenarios.

property delayInterval

delayInterval: Duration | number;

• The delay that's used between retries. This can be a number in milliseconds or a Duration object

property maxRetryCount

maxRetryCount: number;

• The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

property strategy

strategy: 'fixedDelay';

• A specified amount of time is allowed to elapse between each retry.

property name

name: string;

• Must be unique within this function. If using the input namespace to create this object, the name will be auto-generated for you

property type

type: string;

• The type for this trigger ('blob', 'cosmosDB', etc.) If using the input namespace to create this object, the type will be set for you

property extraInputs

extraInputs?: FunctionInput[];

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

property extraOutputs

extraOutputs?: FunctionOutput[];

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

property handler

handler: FunctionHandler;

• The code that will be executed when your function is triggered

property return

return?: FunctionOutput;

• 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

property trigger

trigger: FunctionTrigger;

• 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 name

name: string;

• Must be unique within this function. If using the output namespace to create this object, the name will be auto-generated for you

property type

type: string;

• The type for this output ('http', 'blob', 'queue', etc.) If using the output namespace to create this object, the type will be set for you

property name

name: string;

• Must be unique within this function. If using the trigger namespace to create this object, the name will be auto-generated for you

property type

type: string;

• The type for this trigger ('httpTrigger', 'timerTrigger', etc.) If using the trigger namespace to create this object, the type will be set for you

property retry

retry?: RetryOptions;

• An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more [here](https://learn.microsoft.com/azure/azure-functions/functions-bindings-error-pages)

property type

type: string;

property type

type: string;

property type

type: string;

property hookData

hookData?: Record<string, unknown>;

property handler

handler: HttpHandler;

property return

return?: FunctionOutput;

• 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

property trigger

trigger?: HttpTrigger;

property bytes

bytes?: Uint8Array;

• The body as a buffer. You only need to specify one of the bytes or string properties

property string

string?: string;

• The body as a buffer. You only need to specify one of the bytes or string properties

property body

body?: HttpRequestBodyInit;

property headers

headers?: Record<string, string>;

property method

method?: string;

property params

params?: Record<string, string>;

property query

query?: Record<string, string>;

property url

url?: string;

property claimsPrincipalData

claimsPrincipalData: Record<string, unknown>;

• Extra authentication information, dependent on auth type and auth provider

property id

id: string;

• unique user GUID

property identityProvider

identityProvider: string;

• provider of authentication service

property type

type: HttpRequestUserType;

• Type of authentication, either AppService or StaticWebApps

property username

username: string;

• unique username

property body

body?: BodyInit;

• HTTP response body

property cookies

cookies?: Cookie[];

• HTTP response cookies

property enableContentNegotiation

enableContentNegotiation?: boolean;

• Enable content negotiation of response body if true If false, treat response body as raw false

property headers

headers?: HeadersInit;

• HTTP response headers

property jsonBody

jsonBody?: any;

• A JSON-serializable HTTP Response body. If set, the HttpResponseInit.body property will be ignored in favor of this property

property status

status?: number;

• HTTP response status code 200

property authLevel

authLevel: 'anonymous' | 'function' | 'admin';

• The function HTTP authorization level.

property methods

methods: HttpMethod[];

• An array of the http methods for this http input

property route

route?: string;

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

property authLevel

authLevel?: 'anonymous' | 'function' | 'admin';

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

property methods

methods?: HttpMethod[];

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

property route

route?: string;

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

method get

get: {
    (input: StorageBlobInput): unknown;
    (input: TableInput): unknown;
    (input: CosmosDBInput): unknown;
    (input: SqlInput): unknown;
    (inputOrName: string | FunctionInput): unknown;
};