Kudu (Fake)

6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See

Kudu Module

Namespace: Fake.Azure
Assembly: Fake.Azure.Kudu.dll

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

Types

Type	Description
WebJobType	The different types of web jobs.
ZipDeployParams	Kudu ZipDeploy parameters

Functions and values

Function or value	Description
`Kudu.deploymentTarget` Full Usage: `Kudu.deploymentTarget` Returns: `string`	Location where synced outputs should be deployed to. Returns: `string`
`Kudu.deploymentTemp` Full Usage: `Kudu.deploymentTemp` Returns: `string`	Location where staged outputs should go before synced up to the site. Returns: `string`
`Kudu.getWebJobPath webJobType webJobName` Full Usage: `Kudu.getWebJobPath webJobType webJobName` Parameters: webJobType : `WebJobType` - The web job type. Of type `WebJobType` webJobName : `string` - The name of the web job Returns: `string`	Gets the path for deploying a web job to. webJobType : `WebJobType` The web job type. Of type `WebJobType` webJobName : `string` The name of the web job Returns: `string`
`Kudu.kuduPath` Full Usage: `Kudu.kuduPath` Returns: `DirectoryInfo`	The path to the KuduSync application. Returns: `DirectoryInfo`
`Kudu.kuduSync ()` Full Usage: `Kudu.kuduSync ()` Parameters: () : `unit`	Synchronises all staged files from the temporary deployment to the actual deployment, removing any obsolete files, updating changed files and adding new files. () : `unit`
`Kudu.nextManifestPath` Full Usage: `Kudu.nextManifestPath` Returns: `string`	Used by KuduSync for tracking and diffing deployments. Returns: `string`
`Kudu.previousManifestPath` Full Usage: `Kudu.previousManifestPath` Returns: `string`	Used by KuduSync for tracking and diffing deployments. Returns: `string`
`Kudu.stageFolder source shouldInclude` Full Usage: `Kudu.stageFolder source shouldInclude` Parameters: source : `string` - The source folder to copy. shouldInclude : `string -> bool` - A predicate which includes files from the folder. If the entire directory should be copied, this predicate should always return true.	Stages a folder and all subdirectories into the temp deployment area, ready for deployment into the website. source : `string` The source folder to copy. shouldInclude : `string -> bool` A predicate which includes files from the folder. If the entire directory should be copied, this predicate should always return true.
`Kudu.stageWebJob webJobType webJobName files` Full Usage: `Kudu.stageWebJob webJobType webJobName files` Parameters: webJobType : `WebJobType` - The web job type. Of type `WebJobType` webJobName : `string` - The name of the web job files : `seq<string>` - Files to deploy	Stages a set of files into a WebJob folder in the temp deployment area, ready for deployment into the website as a webjob. webJobType : `WebJobType` The web job type. Of type `WebJobType` webJobName : `string` The name of the web job files : `seq<string>` Files to deploy
`Kudu.zipDeploy zipDeployParams` Full Usage: `Kudu.zipDeploy zipDeployParams` Parameters: zipDeployParams : `ZipDeployParams` - The parameters for zip deploy command	Synchronizes contents of the zip package with the target web app using Kudu ZipDeploy. zipDeployParams : `ZipDeployParams` The parameters for zip deploy command