Get publish settings from IIS and import into Visual Studio

Artículo
10/22/2021

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can use the Publish tool to import publish settings and then deploy your app. In this article, we use publish settings for IIS.

These steps apply to ASP.NET and ASP.NET Core web applications.

Note

A publish settings file (*.publishsettings) is different than a publishing profile (*.pubxml). A publish settings file is created in IIS, and then it can be imported into Visual Studio. Visual Studio creates the publishing profile.

Prerequisites

Visual Studio installed with the ASP.NET and web development workload. If you've already installed Visual Studio:
- Install the latest updates in Visual Studio by selecting Help > Check for Updates.
- Add the workload by selecting Tools > Get Tools and Features.
On your server, you must be running Windows Server 2012, Windows Server 2016, or Windows Server 2019, and you must have the IIS Web Server role correctly installed (required to generate the publish settings file (*.publishsettings)). Either ASP.NET 4.5 or ASP.NET Core must also be installed on the server.
- To set up ASP.NET Core, see Host ASP.NET Core on Windows with IIS. For ASP.NET Core, make sure you configure the Application Pool to use No Managed Code, as described in the article.
- To set up ASP.NET 4.5, see IIS 8.0 Using ASP.NET 3.5 and ASP.NET 4.5.
Note

IIS on Windows does not support generating the publish settings. You can, however, still publish to IIS using the Publish tool in Visual Studio.

Install and configure Web Deploy on Windows Server

Web Deploy 3.6 for Hosting Servers provides additional configuration features that enable the creation of the publish settings file from the UI.

The Web Platform Installer for IIS allows installation of version 3.6, not 4.0, so that is the version we recommend in this article.

If you have Web Deploy already installed on Windows Server, uninstall it using Control Panel > Programs > Uninstall a Program.
Next, install Web Deploy 3.6 for Hosting Servers on Windows Server.

To install Web Deploy for Hosting Servers, use the Web Platform Installer (WebPI). (To find the Web Platform Installer link from IIS, select IIS in the left pane of Server Manager. In the server pane, right-click the server and select Internet Information Services (IIS) Manager. Then use the Get New Web Platform Components link in the Actions window.) You can also obtain the Web Platform Installer (WebPI) from downloads.

In the Web Platform Installer, you find Web Deploy 3.6 for Hosting Servers in the Applications tab.
If you did not already install IIS Management Scripts and Tools, install it now.

Go to Select server roles > Web Server (IIS) > Management Tools, and then select the IIS Management Scripts and Tools role, click Next, and then install the role.

The scripts and tools are required to enable the generation of the publish settings file.
(Optional) Verify that Web Deploy is running correctly by opening Control Panel > System and Security > Administrative Tools > Services, and then make sure that:
- Web Deployment Agent Service is running (the service name is different in older versions).
- Web Management Service is running.
If one of the agent services is not running, restart the Web Deployment Agent Service.

If the Web Deployment Agent Service is not present at all, go to Control Panel > Programs > Uninstall a program, find Microsoft Web Deploy <version>. Choose to Change the installation and make sure that you choose Will be installed to the local hard drive for the Web Deploy components. Complete the change installation steps.

Create the publish settings file in IIS on Windows Server

Close and reopen the IIS Management Console to show updated configuration options in the UI.
In IIS, right-click the Default Web Site, choose Deploy > Configure Web Deploy Publishing.

If you don't see the Deploy menu, see the preceding section to verify that Web Deploy is running.
In the Configure Web Deploy Publishing dialog box, examine the settings.
Click Setup.

In the Results panel, the output shows that access rights are granted to the specified user, and that a file with a .publishsettings file extension has been generated in the location shown in the dialog box.
```
<?xml version="1.0" encoding="utf-8"?>
<publishData>
  <publishProfile
    publishUrl="https://myhostname:8172/msdeploy.axd"
    msdeploySite="Default Web Site"
    destinationAppUrl="http://myhostname:80/"
    mySQLDBConnectionString=""
    SQLServerDBConnectionString=""
    profileName="Default Settings"
    publishMethod="MSDeploy"
    userName="myhostname\myusername" />
</publishData>
```
Depending on your Windows Server and IIS configuration, you see different values in the XML file. Here are a few details about the values that you see:
- The msdeploy.axd file referenced in the publishUrl attribute is a dynamically generated HTTP handler file for Web Deploy. (For testing purposes, http://myhostname:8172 generally works as well.)
- The publishUrl port is set to port 8172, which is the default for Web Deploy.
- The destinationAppUrl port is set to port 80, which is the default for IIS.
- If, in later steps, you are unable to connect to the remote host from Visual Studio using the host name, test the server's IP address in place of the host name.
  
  Note
  
  If you are publishing to IIS running on an Azure VM, you must open an inbound port for Web Deploy and IIS in the Network Security group. For detailed information, see Open ports to a virtual machine.
Copy this file to the computer where you are running Visual Studio.

Import the publish settings in Visual Studio and deploy

On the computer where you have the ASP.NET project open in Visual Studio, right-click the project in Solution Explorer, and choose Publish.

If you have previously configured any publishing profiles, the Publish pane appears. Click New or Create new profile.
Select the option to import a profile.

In the Pick a publish target dialog box, click Import Profile.
Navigate to the location of the publish settings file that you created in the previous section.
In the Import Publish Settings File dialog, navigate to and select the profile that you created in the previous section, and click Open.

Visual Studio begins the deployment process, and the Output window shows progress and results.

If you get an any deployment errors, click Settings to edit settings. Modify settings and click Validate to test new settings. If the host name is not found, try the IP address instead of the host name in the Server and Destination URL fields.

After the app deploys successfully, it should start automatically.

Common issues

First, check the Output window in Visual Studio for status information, and check your error messages. In addition:

If you can't connect to the host using the host name, try the IP address instead.
Make sure the required ports are open on the remote server.
For ASP.NET Core, in IIS you need to make sure that the Application pool field for the DefaultAppPool is set to No Managed Code.
Verify that the version of ASP.NET used in your app is the same as the version you installed on the server. For your app, you can view and set the version in the Properties page. To set the app to a different version, that version must be installed.
If the app tried to open, but you see a certificate warning, choose to trust the site. If you already closed the warning, you can edit the *.pubxml file in your project and add the following element: <AllowUntrustedCertificate>true</AllowUntrustedCertificate>. This setting is for testing only!
If the app does not start from Visual Studio, start the app in IIS to test that it deployed correctly.