app module
Functions
| cosmosDB(string, Cosmos |
Registers a Cosmos DB function in your app that will be triggered whenever inserts and updates occur (not deletions) |
| delete |
Registers an http function in your app that will be triggered by making a 'DELETE' request to the function url |
| delete |
Registers an http function in your app that will be triggered by making a 'DELETE' request to the function url |
| event |
Registers a function in your app that will be triggered whenever an event is sent by an event grid source |
| event |
Registers a function in your app that will be triggered whenever a message is added to an event hub |
| generic(string, Generic |
Registers a generic function in your app that will be triggered based on the type specified in |
| get(string, Http |
Registers an http function in your app that will be triggered by making a 'GET' request to the function url |
| get(string, Http |
Registers an http function in your app that will be triggered by making a 'GET' request to the function url |
| http(string, Http |
Registers an http function in your app that will be triggered by making a request to the function url |
| patch(string, Http |
Registers an http function in your app that will be triggered by making a 'PATCH' request to the function url |
| patch(string, Http |
Registers an http function in your app that will be triggered by making a 'PATCH' request to the function url |
| post(string, Http |
Registers an http function in your app that will be triggered by making a 'POST' request to the function url |
| post(string, Http |
Registers an http function in your app that will be triggered by making a 'POST' request to the function url |
| put(string, Http |
Registers an http function in your app that will be triggered by making a 'PUT' request to the function url |
| put(string, Http |
Registers an http function in your app that will be triggered by making a 'PUT' request to the function url |
| service |
Registers a function in your app that will be triggered whenever a message is added to a service bus queue |
| service |
Registers a function in your app that will be triggered whenever a message is added to a service bus topic |
| storage |
Registers a function in your app that will be triggered whenever an item is added to a storage blob path |
| storage |
Registers a function in your app that will be triggered whenever an item is added to a storage queue |
| timer(string, Timer |
Registers a timer function in your app that will be triggered on a schedule |
Function Details
cosmosDB(string, CosmosDBFunctionOptions)
Registers a Cosmos DB function in your app that will be triggered whenever inserts and updates occur (not deletions)
function cosmosDB(name: string, options: CosmosDBFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- CosmosDBFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
deleteRequest(string, HttpHandler)
Registers an http function in your app that will be triggered by making a 'DELETE' request to the function url
function deleteRequest(name: string, handler: HttpHandler)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- handler
- HttpHandler
The handler for this function
deleteRequest(string, HttpMethodFunctionOptions)
Registers an http function in your app that will be triggered by making a 'DELETE' request to the function url
function deleteRequest(name: string, options: HttpMethodFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpMethodFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
eventGrid(string, EventGridFunctionOptions)
Registers a function in your app that will be triggered whenever an event is sent by an event grid source
function eventGrid(name: string, options: EventGridFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- EventGridFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
eventHub(string, EventHubFunctionOptions)
Registers a function in your app that will be triggered whenever a message is added to an event hub
function eventHub(name: string, options: EventHubFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- EventHubFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
generic(string, GenericFunctionOptions)
Registers a generic function in your app that will be triggered based on the type specified in options.trigger.type
Use this method if your desired trigger type does not already have its own method
function generic(name: string, options: GenericFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- GenericFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
get(string, HttpHandler)
Registers an http function in your app that will be triggered by making a 'GET' request to the function url
function get(name: string, handler: HttpHandler)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- handler
- HttpHandler
The handler for this function
get(string, HttpMethodFunctionOptions)
Registers an http function in your app that will be triggered by making a 'GET' request to the function url
function get(name: string, options: HttpMethodFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpMethodFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
http(string, HttpFunctionOptions)
Registers an http function in your app that will be triggered by making a request to the function url
function http(name: string, options: HttpFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
patch(string, HttpHandler)
Registers an http function in your app that will be triggered by making a 'PATCH' request to the function url
function patch(name: string, handler: HttpHandler)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- handler
- HttpHandler
The handler for this function
patch(string, HttpMethodFunctionOptions)
Registers an http function in your app that will be triggered by making a 'PATCH' request to the function url
function patch(name: string, options: HttpMethodFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpMethodFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
post(string, HttpHandler)
Registers an http function in your app that will be triggered by making a 'POST' request to the function url
function post(name: string, handler: HttpHandler)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- handler
- HttpHandler
The handler for this function
post(string, HttpMethodFunctionOptions)
Registers an http function in your app that will be triggered by making a 'POST' request to the function url
function post(name: string, options: HttpMethodFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpMethodFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
put(string, HttpHandler)
Registers an http function in your app that will be triggered by making a 'PUT' request to the function url
function put(name: string, handler: HttpHandler)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- handler
- HttpHandler
The handler for this function
put(string, HttpMethodFunctionOptions)
Registers an http function in your app that will be triggered by making a 'PUT' request to the function url
function put(name: string, options: HttpMethodFunctionOptions)Parameters
- name
-
string
The name of the function. This will be the route unless a route is explicitly configured in the HttpTriggerOptions
- options
- HttpMethodFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
serviceBusQueue(string, ServiceBusQueueFunctionOptions)
Registers a function in your app that will be triggered whenever a message is added to a service bus queue
function serviceBusQueue(name: string, options: ServiceBusQueueFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- ServiceBusQueueFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
serviceBusTopic(string, ServiceBusTopicFunctionOptions)
Registers a function in your app that will be triggered whenever a message is added to a service bus topic
function serviceBusTopic(name: string, options: ServiceBusTopicFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- ServiceBusTopicFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
storageBlob(string, StorageBlobFunctionOptions)
Registers a function in your app that will be triggered whenever an item is added to a storage blob path
function storageBlob(name: string, options: StorageBlobFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- StorageBlobFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
storageQueue(string, StorageQueueFunctionOptions)
Registers a function in your app that will be triggered whenever an item is added to a storage queue
function storageQueue(name: string, options: StorageQueueFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- StorageQueueFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function
timer(string, TimerFunctionOptions)
Registers a timer function in your app that will be triggered on a schedule
function timer(name: string, options: TimerFunctionOptions)Parameters
- name
-
string
The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
- options
- TimerFunctionOptions
Configuration options describing the inputs, outputs, and handler for this function