Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

Kudu

Contains tasks to stage and deploy Azure website and webjobs using source code deployment with Kudu Sync.

Nested types and modules

TypeDescription
WebJobType

The different types of web jobs.

Functions and values

Function or valueDescription
deploymentTarget
Signature: string

Location where synced outputs should be deployed to.

deploymentTemp
Signature: string

Location where staged outputs should go before synced up to the site.

getWebJobPath webJobType webJobName
Signature: webJobType:WebJobType -> webJobName:string -> string

Gets the path for deploying a web job to.

kuduPath
Signature: string

The path to the KuduSync application.

kuduSync()
Signature: unit -> unit

Synchronises all staged files from the temporary deployment to the actual deployment, removing any obsolete files, updating changed files and adding new files.

nextManifestPath
Signature: string

Used by KuduSync for tracking and diffing deployments.

previousManifestPath
Signature: string

Used by KuduSync for tracking and diffing deployments.

stageFolder source shouldInclude
Signature: source:string -> shouldInclude:(string -> bool) -> unit

Stages a folder and all subdirectories into the temp deployment area, ready for deployment into the website.

stageWebJob webJobType webJobName files
Signature: webJobType:WebJobType -> webJobName:string -> files:seq<string> -> unit

Stages a set of files into a WebJob folder in the temp deployment area, ready for deployment into the website as a webjob.