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

FakeDeployAgentHelper

Contains a http helper functions for FAKE.Deploy.

Nested types and modules

Type	Description
Action
App
AuthToken	Authentication token received from a successful login
DeployStatus
Deployment
DeploymentResponse	Deployment result type.
FilePath
Response	A http response type.
Url

Functions and values

Function or value	Description
`authenticate(...)` Signature: server:string -> userId:string -> serverpathToPrivateKeyFile:string -> passwordForPrivateKey:string -> Guid option	Authenticate against the given server with the given userId and private key
`buildExceptionString(r)` Signature: r:Response -> string
`deployPackage(f)` Signature: f:(Deployment -> Deployment) -> unit	Posts a deployment package to the given URL, executes the script inside it with given arguments and handles the response.
`DeployPackage url packageFileName` Signature: url:Url -> packageFileName:FilePath -> unit Attributes: [<Obsolete("Use deployPackage")>]	OBSOLETE Use deployPackage Posts a deployment package to the given URL and handles the response. Deprecated, use DeployPackage
`DeployPackageWithArgs(...)` Signature: url:Url -> packageFileName:FilePath -> args:string [] -> unit Attributes: [<Obsolete("Use deployPackage")>]	OBSOLETE Use deployPackage Posts a deployment package to the given URL, executes the script inside it with given arguments and handles the response. Deprecated, use DeployPackage
`getActiveReleasesFor server appname` Signature: server:string -> appname:string -> DeploymentResponse	Returns the active release of the given app from the given server.
`getAllActiveReleases(server)` Signature: server:string -> DeploymentResponse	Returns all active releases from the given server.
`getAllReleases(server)` Signature: server:string -> DeploymentResponse	Returns all releases from the given server.
`getAllReleasesFor server appname` Signature: server:string -> appname:string -> DeploymentResponse	Returns all releases of the given app from the given server.
`getReleasesFor server appname status` Signature: server:string -> appname:string -> status:string -> Choice<HttpResponseMessage<DeploymentResponse>,exn>	Returns all releases of the given app from the given server.
`parseDeploymentResponse(msg)` Signature: msg:string -> Choice<HttpResponseMessage<DeploymentResponse>,exn>
`postDeploymentPackage(...)` Signature: url:Url -> packageFileName:FilePath -> args:string [] -> DeploymentResponse	Posts a deployment package to the given URL.
`RollbackPackage url appName version` Signature: url:string -> appName:string -> version:string -> unit	Performs a rollback of the given app at the given URL and handles the response.
`rollbackTo server appname version` Signature: server:string -> appname:string -> version:string -> DeploymentResponse	Performs a rollback of the given app on the server.
`scriptArgumentsHeaderName` Signature: string Attributes: [<Literal>]