IISWebAppDeploymentOnMachineGroup@0 - IIS web app deploy v0 task

Use this task to deploy a website or web application using Web Deploy.

Syntax

# IIS web app deploy v0
# Deploy a website or web application using Web Deploy.
- task: IISWebAppDeploymentOnMachineGroup@0
  inputs:
    WebSiteName: # string. Required. Website Name. 
    #VirtualApplication: # string. Virtual Application. 
    Package: '$(System.DefaultWorkingDirectory)\**\*.zip' # string. Required. Package or Folder. Default: $(System.DefaultWorkingDirectory)\**\*.zip.
  # Advanced Deployment Options
    #SetParametersFile: # string. SetParameters File. 
    #RemoveAdditionalFilesFlag: false # boolean. Remove Additional Files at Destination. Default: false.
    #ExcludeFilesFromAppDataFlag: false # boolean. Exclude Files from the App_Data Folder. Default: false.
    #TakeAppOfflineFlag: false # boolean. Take App Offline. Default: false.
    #AdditionalArguments: # string. Additional Arguments. 
  # File Transforms & Variable Substitution Options
    #XmlTransformation: false # boolean. XML transformation. Default: false.
    #XmlVariableSubstitution: false # boolean. XML variable substitution. Default: false.
    #JSONFiles: # string. JSON variable substitution.

Inputs

WebSiteName - Website Name
string. Required.

Specifies the name of an existing website on the machine group machines.

VirtualApplication - Virtual Application
string.

Specifies the name of an already existing Azure Virtual application on the target machines.

Package - Package or Folder
string. Required. Default value: $(System.DefaultWorkingDirectory)\**\*.zip.

Specifies the file path to the package or folder generated by MSBuild or a compressed archive file. Variables ( Build | Release) and wildcards are supported. For example, $(System.DefaultWorkingDirectory)\**\*.zip.

SetParametersFile - SetParameters File
string.

Optional. Specifies the location of the SetParameters.xml file to use.

RemoveAdditionalFilesFlag - Remove Additional Files at Destination
boolean. Default value: false.

Selects the option to delete files on the Web App that have no matching files in the Web App zip package.

ExcludeFilesFromAppDataFlag - Exclude Files from the App_Data Folder
boolean. Default value: false.

Selects the option to prevent files in the App_Data folder from being deployed to the Web App.

TakeAppOfflineFlag - Take App Offline
boolean. Default value: false.

Selects the option to take the Web App offline by placing an app_offline.htm file in the root directory of the Web App before the sync operation begins. The file will be removed after the sync operation completes successfully.

AdditionalArguments - Additional Arguments
string.

Specifies additional Web Deploy arguments that are applied when deploying the Azure Web App. For example, -disableLink:AppPoolExtension or -disableLink:ContentExtension.

For a list of Web Deploy arguments, see Web Deploy Operation Settings.

XmlTransformation - XML transformation
boolean. Default value: false.

Specifies the config transforms that are run for *.Release.config and *.<EnvironmentName>.config on the *.config file. Config transforms are run prior to the Variable Substitution. XML transformations are only supported on Windows.

XmlVariableSubstitution - XML variable substitution
boolean. Default value: false.

Specifies the variables defined in the build or release pipeline. These variables are matched against the key or name entries in the appSettings, applicationSettings, and connectionStrings sections of any config file and parameters.xml. Variable Substitution is run after config transforms.

Note: If the same variables are defined in the release pipeline and in the environment, then the environment variables will supersede the release pipeline variables.

JSONFiles - JSON variable substitution
string.

Specifies a new line separated list of JSON files to substitute the variable values. File names must be relative to the root folder.

To substitute JSON variables that are nested or hierarchical, specify them using JSONPath expressions. For example, to replace the value of ConnectionString in the sample below, you must define a variable as Data.DefaultConnection.ConnectionString in the build or release pipeline (or in the release pipeline's stage).

{  
  "Data": {  
    "DefaultConnection": {  
      "ConnectionString": "Server=(localdb)\SQLEXPRESS;Database=MyDB;Trusted_Connection=True"  
    }  
  }  
}

Variable Substitution is run after configuration transforms.

Note: Pipeline variables are excluded in substitution.

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Remarks

Use this task to deploy a website or web app using WebDeploy.

Requirements

Requirement	Description
Pipeline types	Classic release
Runs on	Agent, DeploymentGroup
Demands	None
Capabilities	This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions	Any
Settable variables	Any
Agent version	2.104.1 or greater
Task category	Deploy