Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

WebJobs

Contains tasks to package and deploy Azure Web Jobs via the Kudu Zip controller

Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found here

Nested types and modules

TypeDescription
WebClientWithTimeout
WebJob

WebJob type

WebJobType

The running modes of webjobs

WebSite

The website that webjobs are deployed to

Functions and values

Function or valueDescription
WebJobs.deployWebJobs(webSites)
Signature: webSites:WebSite list -> unit

This task to can be used deploy a prebuilt webjob zip to a website

Parameters

  • webSites - The websites and webjobs to deploy.
WebJobs.deployWebJobsToWebSite(webSite)
Signature: webSite:WebSite -> unit
WebJobs.deployWebJobToWebSite(...)
Signature: webSite:WebSite -> webJob:WebJob -> unit
WebJobs.jobTypePath(webJobType)
Signature: webJobType:WebJobType -> string
WebJobs.packageWebJobs(webSites)
Signature: webSites:WebSite list -> unit

This task to can be used create a zip for each webjob to deploy to a website The output structure is: outputpath/{websitename}/webjobs/{continuous/triggered}/{webjobname}.zip

Parameters

  • webSites - The websites and webjobs to build zips from.
WebJobs.zipWebJob webSite webJob
Signature: webSite:'?18750 -> webJob:WebJob -> unit
Type parameters: '?18750