Share via

WebDeployApplication [SPFSDK][VMROLE]

  • Article

 

Applies To: Windows Azure Pack

The WebDeployApplication object provides settings to install an instance of Microsoft SQL Server when a Windows-based virtual machine is provisioned.

Type Hierarchy

ResourceExtension [SPFSDK][VMROLE].ExtensionSettings [SPFSDK][VMROLE].ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE].WebDeployApplication

Syntax

{
    "DeploymentName": "string",

    "ScriptCommands": [
        <Script>
    ],

    "DeploymentName": "string",
    "ApplicationPayloadId": "string",
    "PackagePassword": "string",
    "WebDeployParameters": [
        <Parameter>
    ]
}

Properties

Name

Type

Required

Default value

Description

DeploymentName

String

Yes

None

The definition of each instance of SQL Server to deploy.

ApplicationPayloadId

String

Yes

None

The identifier of an ApplicationProfile.ApplicationPayload item. This payload must point to a web deploy .zip file.

PackagePassword

String

No

None

The password for the web deploy payload, if it contains secured values.

ScriptCommands

Array of Script [SPFSDK][VMROLE]

No

null

The scripts to run during the installation.

WebDeployParameters

Array of Parameters and Types [SPFSDK][VMROLE]

No

null

The parameters that are declared for use by the deployment.

Remarks

The following code example provides a sample WebDeployApplication object.

{
    "DeploymentName": "WebDeploy App 1",

    "ScriptCommands": [
        {
            "AlwaysReboot": false,
            "ApplicationPayloadId": "366819c2-bf11-4c85-9555- 6293e2a3ce7b",
            "ErrorPolicy": "FailOnMatch",
            "ExecutableAndParams": {
                "Executable": "cmd.exe",
                "Parameters": "/q /c installwebdeploy.cmd"
            },
            "ExitCodeRegex": "[1-9][0-9]*",
            "MaxOutputSize": 1048576,
            "RebootExitCodeRegex": "{1641}|{3010}|{3011}",
            "RestartOnRetry": false,
            "ScriptBlock": null,
            "ScriptCredential": "domain\\user:password",
            "ScriptType": "PreInstall",
            "StandardErrorPath": "c:\\err.txt",
            "StandardErrorRegex": ".+",
            "StandardInput": null,
            "StandardOutputPath": "c:\\out.txt",
            "StandardOutputRegex": null,
            "TimeoutInSeconds": 900,
            "WorkingDirectory": null
        }
    ],

    "DeploymentName": "Deployment1",
    "ApplicationPayloadId": "371ade4c-03a2-492d-9589-b399b940e44f",
    "PackagePassword": "mypassword2",
    "WebDeployParameters": [
        {
            "ParameterName": "CONNECTION_STRING",
            "Value": "[Param.ConnectionString]"
        }
    ]
}

See Also

ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE]
SQLProfile [SPFSDK][VMROLE]
SQLDacApplication [SPFSDK][VMROLE]
ScriptApplication [SPFSDK][VMROLE]
Script [SPFSDK][VMROLE]