Get publish settings from Azure and import into Visual Studio

Applies to: yesVisual Studio noVisual Studio for Mac

You can use the Publish tool to import publish settings and then deploy your app. In this article, we use publish settings for Azure App Service. These steps apply to ASP.NET and ASP.NET Core web apps.

Note

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

Prerequisites

  • You must have Visual Studio 2019 installed and the ASP.NET and web development workload.

    If you haven't already installed Visual Studio, go to the Visual Studio downloads page to install it for free.

  • You must have Visual Studio 2017 installed and the ASP.NET and web development workload.

    If you haven't already installed Visual Studio, go to the Visual Studio downloads page to install it for free.

Create a new ASP.NET project in Visual Studio

  1. On the computer running Visual Studio, create a new project.

    Choose the correct template. In this example, choose either ASP.NET Web Application (.NET Framework) or (for C# only) ASP.NET Core Web Application, and then select OK.

    If you don't see the specified project templates, go to the Open Visual Studio Installer link in the left pane of the New Project dialog box. The Visual Studio Installer launches. Install the ASP.NET and web development workload.

    The project template you choose (ASP.NET or ASP.NET Core) must correspond to the version of ASP.NET installed on the web server.

  2. Choose either MVC (.NET Framework) or Web Application (Model-View-Controller) (for .NET Core), and make sure that No Authentication is selected, and then select OK.

  3. Type a name like MyWebApp and select OK.

    Visual Studio creates the project.

  4. Choose Build > Build Solution to build the project.

Create the publish settings file in Azure App Service

  1. In the Azure portal, open the Azure App Service.

  2. Go to Get publish profile and save the profile locally.

    Get the publish profile

    A file with a .publishsettings file extension has been generated in the location where you saved it. The following code shows a partial example of the file (in a more readable formatting).

    <publishData>
      <publishProfile
        profileName="DeployASPDotNetCore - Web Deploy"
        publishMethod="MSDeploy"
        publishUrl="deployaspdotnetcore.scm.azurewebsites.net:443"
        msdeploySite="DeployASPDotNetCore"
        userName="$DeployASPDotNetCore"
        userPWD="abcdefghijklmnopqrstuzwxyz"
        destinationAppUrl="http://deployaspdotnetcore2021.azurewebsites.net"
        SQLServerDBConnectionString=""
        mySQLDBConnectionString=""
        hostingProviderForumLink=""
        controlPanelLink="http://windows.azure.com"
        webSystem="WebSites">
        <databases />
      </publishProfile>
    </publishData>
    

    Typically, the preceding *.publishsettings file contains two publishing profiles that you can use in Visual Studio, one to deploy using Web Deploy, and one to deploy using FTP. The preceding code shows the Web Deploy profile. Both profiles will be imported later when you import the profile.

Import the publish settings in Visual Studio and deploy

  1. 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.

  2. Select the option to import a profile.

    In the Publish dialog box, click Import Profile.

    In the Pick a publish target dialog box, click Import Profile.

    Choose Publish

  3. Navigate to the location of the publish settings file that you created in the previous section.

  4. In the Import Publish Settings File dialog, navigate to and select the profile that you created in the previous section, and click Open.

    Click Finish to save the publishing profile, and then click Publish.

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

    If you get an any deployment errors, click Edit 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.

    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.

    Edit settings in the Publish tool

Next steps

In this tutorial, you created a publish settings file, imported it into Visual Studio, and deployed an ASP.NET app to Azure App Service. You may want an overview of publishing options in Visual Studio.