Deploy: IIS Web App Manage

VSTS

icon Manage an IIS Website.

Use this task to create or update, start or stop, and recycle IIS Websites, IIS Web Applications, Virtual Directories, and IIS Application Pools. Supports adding application pools, and configuring bindings and authentication.

To use this task, you must first install the IIS Web App Deployment Using WinRM extension from Visual Studio Marketplace.

Basic options

Argument Description
Configuration type Choose whether you want to manage an IIS Website, an IIS Web Application, an IIS Virtual Directory, or an IIS Application Pool. An IIS Virtual Directory or an IIS Web Application is created as a child of an existing IIS Website.
Action Available when Configuration type is IIS Website or IIS Application Pool. Select the action to be performed. Create or Update, Start, Stop, and Recycle actions are supported based on the Configuration type selected.

Parameters for IIS Website configuration

Argument Description
Website name The display name of the IIS Website to create or reconfigure.
Physical path The physical path where the content of the website will be stored. The content can reside on the local computer, in a remote directory, or on a network share. Examples: C:\Fabrikam and \ContentShare\Fabrikam
Physical path authentication Select the authentication mechanism that will be used to access the physical path of the website. Options are Application User (Pass-through) and Windows Authentication (which requires a username and password).
Username The Windows or domain account that will be used to access the physical path. Example: YOURDOMAIN\YourAccount
Password The password for the account. Good practice is to create a variable in the build or release definition, mark it as 'Secret' to secure it, and use it here. Example: $(userCredentials). Note: special characters in passwords are interpreted as described in Parsing C Command-Line Arguments.
Add binding Set this option to add a port binding for the website. See Binding arguments
Create or update app pool Set this option to create or update the application pool. If checked, the website will be created in the specified application pool. See IIS Application pool arguments.
Configure authentication Set this option to configure authentication for the website. See Authentication options.

Also see Advanced options and Control options

Parameters for IIS Application configuration

Argument Description
Parent website name The display name of the parent IIS Website under which the application will be created or updated.
Virtual path Enter the virtual path in IIS relative to the parent website. The parent website must already exist. Example: to create an application named Site/Application enter /Application.
Physical path The physical path where the content of the web application will be stored. The content can reside on the local computer, in a remote directory, or on a network share. Examples: C:\Fabrikam and \ContentShare\Fabrikam
Physical path authentication Select the authentication mechanism that will be used to access the physical path of the web application. Options are Application User (Pass-through) and Windows Authentication (which requires a username and password).
Username The Windows or domain account that will be used to access the physical path. Example: YOURDOMAIN\YourAccount
Password The password for the account. Good practice is to create a variable in the build or release definition, mark it as 'Secret' to secure it, and use it here. Example: $(userCredentials). Note: special characters in passwords are interpreted as described in Parsing C Command-Line Arguments.
Add binding Set this option to add a port binding for the application. See Binding arguments
Create or update app pool Set this option to create or update the application pool. If checked, the application will be created in the specified application pool. See IIS Application pool arguments.

Also see Advanced options and Control options

Parameters for IIS Virtual Directory configuration

Argument Description
Parent website name The display name of the parent IIS Website under which the virtual directory will be created or updated.
Virtual path Enter the virtual path in IIS relative to the parent website. The parent website and application must already exist. Example: to create a virtual directory named Site/Application/VDir enter /Application/Vdir.
Physical path The physical path where the content of the virtual directory will be stored. The content can reside on the local computer, in a remote directory, or on a network share. Examples: C:\Fabrikam and \ContentShare\Fabrikam
Physical path authentication Select the authentication mechanism that will be used to access the physical path of the virtual directory. Options are Application User (Pass-through) and Windows Authentication (which requires a username and password).
Username The Windows or domain account that will be used to access the physical path. Example: YOURDOMAIN\YourAccount
Password The password for the account. Good practice is to create a variable in the build or release definition, mark it as 'Secret' to secure it, and use it here. Example: $(userCredentials). Note: special characters in passwords are interpreted as described in Parsing C Command-Line Arguments.

Also see Advanced options and Control options

IIS Application Pool arguments for all configurations

Argument Description
Name The display name of the application pool to create or update.
.NET version The version of the .NET common language runtime that is loaded by the application pool. Choose v2.0 for applications built against .NET 2.0, 3.0 or 3.5. Choose v4.0 for .NET 4.0 or 4.5. If the applications assigned to this application pool do not contain managed code, select No Managed Code.
Managed pipeline mode Select the mode that specifies how IIS processes requests for managed content. Use Classic mode only when the applications in the application pool cannot run in the Integrated mode.
Identity Configure the built-in account under which an application pool's worker process runs. Select one of the predefined security accounts or configure a custom account.
Username The Windows or domain account that the application pool will run under. Ensure that this account has permission to run as an application pool. Example: YOURDOMAIN\YourAccount.
Password The password for the account. Good practice is to create a variable in the build or release definition, mark it as 'Secret' to secure it, and use it here. Example: $(userCredentials). Note: special characters in passwords are interpreted as described in Parsing C Command-Line Arguments.

Also see Advanced options and Control options

Binding arguments for all configurations

Argument Description
Protocol Select HTTP or HTTPS
IP address Enter an IP address that can be used to access this website or application. If All Unassigned is selected, the website or application will respond to requests for all IP addresses on the port and for the host name, unless another website on the server has a binding on the same port but with a specific IP address.
Port Specify the port where the Hypertext Transfer Protocol Stack (HTTP.sys) will listen for requests.
Server Name Indication required Set this option to specify Server Name Indication (SNI) for the website or application. SNI extends the SSL and TLS protocols to indicate the host name that the clients are attempting to connect to. It allows multiple secure websites with different certificates to use the same IP address.
Host name Enter a host name (or domain name) for the website or application. Leave empty to use any host header. If a host name is specified, clients can use the host name instead of the IP address to access the website. Example: www.contoso.com.
SSL certificate thumbprint The thumbprint of the certificate that the website or application will use for the HTTPS communication, as a 40-character hexadecimal string. The certificate must already be installed on the computer in the Local Computer - Personal store.

Authentication options for all configurations

Argument Description
Anonymous authentication Set this option to enable anonymous authentication for the website.
Basic authentication Set this option to enable basic authentication for the website.
Windows authentication Set this option to enable Windows authentication for the website.

Advanced options

Argument Description
Additional appcmd.exe commands Enter any additional AppCmd.exe commands. For more than one command, place each on a new line. Examples: list apppools, list sites, recycle apppool /apppool.name:ExampleAppPoolName

Control options

Argument Description
Control options See Control options

This task is contained in the IIS Web App Deployment Using WinRM extension available from Visual Studio Marketplace. For an example of it's use, see:

Q&A

Do I need an agent?

You need at least one agent to run your build or release. Get an agent.

I can't select a default agent queue and I can't queue my build or release. How do I fix this?

See queues.

Help and support