ASP.NET Web Deployment

https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment
Admin
ASP.NET Web Deployment documentation covers tools and techniques for deploying ASP.NET web...
Tokens:66,241
Snippets:962
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Complete Production .pubxml File Example

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/deploying-to-production

This is an example of a complete .pubxml file for a production deployment, including settings for MSDeploy, connection strings, and file exclusion.

```xml
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <WebPublishMethod>MSDeploy</WebPublishMethod>
    <LastUsedBuildConfiguration>Release</LastUsedBuildConfiguration>
    <LastUsedPlatform>Any CPU</LastUsedPlatform>
    <SiteUrlToLaunchAfterPublish>http://contosou-staging.azurewebsites.net</SiteUrlToLaunchAfterPublish>
    <ExcludeApp_Data>True</ExcludeApp_Data>
    <MSDeployServiceURL>waws-prod-bay-001.publish.azurewebsites.windows.net:443</MSDeployServiceURL>
    <DeployIisAppPath>contosou-staging</DeployIisAppPath>
    <RemoteSitePhysicalPath />
    <SkipExtraFilesOnServer>True</SkipExtraFilesOnServer>
    <MSDeployPublishMethod>WMSVC</MSDeployPublishMethod>
    <UserName>[username]</UserName>
    <_SavePWD>True</_SavePWD>
    <PublishDatabaseSettings>
      <!-- database settings removed -->
    </PublishDatabaseSettings>
    <ExcludeFilesFromDeployment>
        robots.txt
    </ExcludeFilesFromDeployment>
  </PropertyGroup>
  <ItemGroup>
    <MSDeployParameterValue Include="$(DeployParameterPrefix)DefaultConnection-Web.config Connection String">
      <ParameterValue>Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User Id=CU-staging-admin@sk0264hvc9;Password=</ParameterValue>
    </MSDeployParameterValue>
    <MSDeployParameterValue Include="$(DeployParameterPrefix)SchoolContext-Web.config Connection String">
      <ParameterValue>Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User Id=CU-staging-admin@sk0264hvc9;Password=</ParameterValue>
    </MSDeployParameterValue>
  </ItemGroup>
</Project>
```

--------------------------------

### Example PowerShell Script Execution

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/running-windows-powershell-scripts-from-msbuild-project-files

An example demonstrating how to call a specific PowerShell script with parameters.

```powershell
powershell.exe –command 
  "& { C:\LogDeploy.ps1 'C:\DeployLogs\log.txt' 'TESTWEB1' }"
```

--------------------------------

### Complete Publish Profile (.pubxml) Example

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/deploying-extra-files

This is a complete example of a Visual Studio publish profile file (`.pubxml`) that includes the custom targets for deploying extra files. It demonstrates the typical configuration settings for web publishing, including deployment method, site URL, and database connection settings, along with the custom MSBuild targets.

```xml
<?xml version="1.0" encoding="utf-8"?>
<!--
This file is used by the publish/package process of your Web project. You can customize the behavior of this process
by editing this MSBuild file. In order to learn more about this please visit https://go.microsoft.com/fwlink/?LinkID=208121. 
-->
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <WebPublishMethod>MSDeploy</WebPublishMethod>
    <LastUsedBuildConfiguration>Release</LastUsedBuildConfiguration>
    <LastUsedPlatform>Any CPU</LastUsedPlatform>
    <SiteUrlToLaunchAfterPublish>http://contosou-staging.azurewebsites.net</SiteUrlToLaunchAfterPublish>
    <ExcludeApp_Data>True</ExcludeApp_Data>
    <MSDeployServiceURL>waws-prod-bay-001.publish.azurewebsites.windows.net:443</MSDeployServiceURL>
    <DeployIisAppPath>contosou-staging</DeployIisAppPath>
    <RemoteSitePhysicalPath />
    <SkipExtraFilesOnServer>False</SkipExtraFilesOnServer>
    <MSDeployPublishMethod>WMSVC</MSDeployPublishMethod>
    <UserName>$contosou-staging</UserName>
    <_SavePWD>True</_SavePWD>
    <PublishDatabaseSettings>
      <Objects xmlns="">
        <ObjectGroup Name="SchoolContext" Order="1" Enabled="True">
          <Destination Path="Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User ID=CU-staging-admin@sk0264hvc9;Password=" Name="Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User Id=CU-staging-admin@sk0264hvc9;Password=" />
          <Object Type="DbCodeFirst">
            <Source Path="DBMigration" DbContext="ContosoUniversity.DAL.SchoolContext, ContosoUniversity.DAL" MigrationConfiguration="ContosoUniversity.DAL.Migrations.Configuration, ContosoUniversity.DAL" Origin="Configuration" />
          </Object>
        </ObjectGroup>
        <ObjectGroup Name="DefaultConnection" Order="2" Enabled="False">
          <Destination Path="Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User ID=CU-staging-admin@sk0264hvc9;Password=" Name="Data Source=tcp:sk0264hvc9.database.windows.net,1433;Initial Catalog=ContosoUniversity-staging;User Id=CU-staging-admin@sk0264hvc9;Password=" />
          <Object Type="DbDacFx">

```

--------------------------------

### Complete .wpp.targets File Example

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/excluding-files-and-folders-from-deployment

This example shows a complete .wpp.targets file that excludes both specific folders and files from the web package. Ensure this file is named '[project name].wpp.targets' and placed in the project's root.

```xml
<Project ToolsVersion="4.0" 
         xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <ItemGroup>   
    <ExcludeFromPackageFolders Include="Internal">
      <FromTarget>ContactManager.Mvc.wpp.targets</FromTarget>
    </ExcludeFromPackageFolders>
    <ExcludeFromPackageFiles Include="Scripts\jquery-1.4.4-
vsdoc.js;Scripts\jquery-1.4.4.js;Scripts\jquery-ui.js;Scripts\jquery.unobtrusive-ajax.js;Scripts\jquery.validate-vsdoc.js;Scripts\jquery.validate.js;Scripts\jquery.validate.unobtrusive.js;Scripts\MicrosoftAjax.debug.js;Scripts\MicrosoftMvcValidation.debug.js">
      <FromTarget>ContactManager.Mvc.wpp.targets</FromTarget>
    </ExcludeFromPackageFiles>
  </ItemGroup>
</Project>
```

--------------------------------

### Install ASP.NET 4 in IIS using aspnet_regiis.exe

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/deploying-to-iis

Use this command in an elevated command prompt to install ASP.NET 4 in IIS. For 32-bit systems, adjust the path accordingly.

```batch
cd %windir%\Microsoft.NET\Framework64\v4.0.30319
aspnet_regiis.exe –i

```

--------------------------------

### Install ASP.NET 4.0 in IIS

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/troubleshooting

Run this command in an elevated command prompt to install ASP.NET 4.0 in IIS if the default .NET 4.0 application pool does not exist.

```batch
cd %windir%\Microsoft.NET\Framework\v4.0.30319
aspnet_regiis.exe –iru
```

--------------------------------

### Web.Release.config Transformation Example

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/web-config-transformations

This example shows how to use Web.config transformations in `Web.Release.config` to modify settings for a release build. It includes transformations for connection strings, removing debug attributes, replacing custom error sections, and inserting location-specific authorization rules.

```XML
<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
  <!--
    In the example below, the "SetAttributes" transform will change the value of 
    "connectionString" to use "ReleaseSQLServer" only when the "Match" locator 
    finds an attribute "name" that has a value of "MyDB".
    
    <connectionStrings>
      <add name="MyDB" 
        connectionString="Data Source=ReleaseSQLServer;Initial Catalog=MyReleaseDB;Integrated Security=True"
        xdt:Transform="SetAttributes" xdt:Locator="Match(name)"/>
    </connectionStrings>
  -->
  <system.web>
    <compilation xdt:Transform="RemoveAttributes(debug)" />
    <!--
      In the example below, the "Replace" transform will replace the entire 
      <customErrors> section of your web.config file.
      Note that because there is only one customErrors section under the 
      <system.web> node, there is no need to use the "xdt:Locator" attribute.
      
      <customErrors defaultRedirect="GenericError.htm"
        mode="RemoteOnly" xdt:Transform="Replace">
        <error statusCode="500" redirect="InternalError.htm"/>
      </customErrors>
    -->
  </system.web>
  <location path="elmah.axd" xdt:Transform="Insert">
    <system.web>
      <authorization>
        <allow roles="Administrator" />
        <deny users="*" />
      </authorization>
    </system.web>
  </location>
</configuration>
```

--------------------------------

### Get Help for enable-migrations Command

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/preparing-databases

Use this command to view the syntax and options for the `enable-migrations` PowerShell command.

```powershell
get-help enable-migrations
```

--------------------------------

### Configure Deployment to Web Deploy Handler Endpoint

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/configuring-server-environments-for-web-deployment/configuring-deployment-properties-for-a-target-environment

Configure deployment to the Web Deploy Handler service endpoint, using basic authentication and SQL Server authentication for database deployment. This example also shows how to specify impersonation credentials.

```XML
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <MSDeployComputerName Condition=" '$(MSDeployComputerName)'=='' ">
      https://STAGEWEB1:8172/MSDeploy.axd?site=DemoSite
    </MSDeployComputerName>
    <MSDeployAuth Condition=" '$(MSDeployAuth)'=='' ">Basic</MSDeployAuth>
    <MSDeployUsername Condition=" '$(MSDeployUsername)'=='' ">
      FABRIKAM\stagingdeployer
    </MSDeployUsername>
    <MSDeployPassword Condition=" '$(MSDeployPassword)'=='' ">
      Pa$$w0rd
    </MSDeployPassword>
    <ContactManagerTargetUrl Condition =" '$(ContactManagerTargetUrl)'=='' ">
      http://localhost:85/ContactManagerService/ContactService.svc
    </ContactManagerTargetUrl>
    <ContactManagerIisPath Condition=" '$(ContactManagerIisPath)'=='' ">
      DemoSite/ContactManager
    </ContactManagerIisPath>
    <ContactManagerServiceIisPath 
      Condition=" '$(ContactManagerServiceIisPath)'=='' ">
        DemoSite/ContactManagerService
    </ContactManagerServiceIisPath>
    <CmDatabaseConnectionString Condition=" '$(CmDatabaseConnectionString)'=='' ">
      Data Source=STAGEDB1;User ID=sa;'$($CREDENTIAL_PLACEHOLDER$)'
    </CmDatabaseConnectionString>
    <CmTargetDatabase Condition=" '$(CmTargetDatabase)'=='' ">
      ContactManager
    </CmTargetDatabase>
  </PropertyGroup>
</Project>
```

--------------------------------

### Install ASP.NET 4 in IIS

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/troubleshooting

Run these commands from an elevated command prompt on the target server to register ASP.NET 4 with IIS. This is necessary if your application requires .NET Framework 4.0.

```batch
cd %windir%\Microsoft.NET\Framework\v4.0.30319
aspet_regiis.exe –i
```

--------------------------------

### Example Log Entry Format

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/running-windows-powershell-scripts-from-msbuild-project-files

This shows the expected format of a log entry created by the LogDeployment PowerShell script.

```text
Deployed package to TESTWEB1 on 02/11/2012 09:28:18

```

--------------------------------

### Automatic Parameterization Example

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/configuring-parameters-for-web-package-deployment

This XML file is automatically generated by the WPP to define parameters for IIS web application path and connection strings.

```XML
<parameters>
  <setParameter 
    name="IIS Web Application Name" 
    value="Default Web Site/ContactManager.Mvc_deploy" />  
  <setParameter 
    name="ApplicationServices-Web.config Connection String" 
    value="Data Source=DEVWORKSTATION\SQLEXPRESS;Initial Catalog=CMAppServices;
           Integrated Security=true;" />
</parameters>
```

--------------------------------

### Group Related Items in Project File

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/understanding-the-project-file

Organize build inputs into named lists using multiple Item elements with the same name within an ItemGroup. This example shows references, compilation files, and content resources.

```xml
<ItemGroup>
   <Reference Include="Microsoft.CSharp" />
   <Reference Include="System.Runtime.Serialization" />
   <Reference Include="System.ServiceModel" />
   ...
</ItemGroup>
<ItemGroup>
   <Compile Include="Controllers\AccountController.cs" />
   <Compile Include="Controllers\ContactsController.cs" />
   <Compile Include="Controllers\HomeController.cs" />
   ...
</ItemGroup>
<ItemGroup>
   <Content Include="Content\Custom.css" />
   <Content Include="CreateDatabase.sql" />
   <Content Include="DropDatabase.sql" />
   ...
</ItemGroup>
```

--------------------------------

### Deploy Web Package using deploy.cmd

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/deploying-web-packages

Use this command to deploy a web package using the generated deploy.cmd file. Specify /T for a trial run or /Y for a live deployment. Optional flags include /M for the destination server, /A for authentication type, /U and /P for user credentials, /L for local IIS Express deployment, and /G for tempAgent provider setting.

```console
[project name].deploy.cmd [/T | /Y] [/M:<computer name>] [/A:<Basic | NTLM>] [/U:<user name>] [/P:</pass/word>] [/L] [/G:<true | false>] [Additional MSDeploy.exe flags]
```

--------------------------------

### Deploy Web Application with Access Token using MSDeploy.exe

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/deploying-web-packages

Deploys a web application using MSDeploy.exe with an access token for authentication. Ensure the web application is built, packaged, and parameters are configured. This command uses the package source, auto destination with specific computer name and authentication details, sync verb, and specifies parameter files and link extensions to disable.

```bash
MSDeploy.exe
  -source:package="[path]\ContactManager.Mvc.zip"
  -dest:auto,
        computerName="https://stageweb1:8172/MSDeploy.axd?site=DemoSite",
        username="FABRIKAM\stagingdeployer",
        $CREDENTIAL_PLACEHOLDER$,
        authtype="Bearer",
        includeAcls="False",
        Password="{-token:}"
  -verb:sync
  -disableLink:AppPoolExtension
  -disableLink:ContentExtension
  -disableLink:CertificateExtension
  -setParamFile:'[path]\ContactManager.Mvc.SetParameters.xml'
  -allowUntrusted
```

--------------------------------

### Create a Deployment Command File (.cmd)

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/creating-and-running-a-deployment-command-file

This command file automates the MSBuild deployment process. It includes the MSBuild command with logging enabled (/fl) and prompts the user to pause after execution. The %windir% variable ensures the correct .NET Framework version is used.

```console
%windir%\Microsoft.NET\Framework\v4.0.30319\msbuild.exe Publish.proj /fl /p:TargetEnvPropsFile=EnvConfig\Env-Dev.proj
echo 
pause
```

--------------------------------

### Execute SQL Statement in Migration

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/preparing-databases

Use the `Sql` method within the `Up` method of a migration class to execute raw SQL statements. This example initializes the Budget column for all departments.

```C#
Sql("UPDATE Department SET Budget = 1000");
```

--------------------------------

### Deploy Web Application using .deploy.cmd

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/deploying-web-packages

Use the .deploy.cmd file to deploy a web application package to a test environment. The /Y flag performs the actual deployment, /M specifies the target server, and /A indicates the authentication method.

```console
ContactManager.Mvc.deploy.cmd /Y /M:TESTWEB1 /A:NTLM

```

--------------------------------

### Get Absolute Path for App_offline File in MSBuild

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/taking-web-applications-offline-with-web-deploy

Use the ConvertToAbsolutePath task within an MSBuild target to resolve the relative path of the App_offline template file to an absolute path.

```xml
<Target Name="GetAppOfflineAbsolutePath" BeforeTargets="DeployAppOffline">
  <ConvertToAbsolutePath Paths="$(AppOfflineSourcePath)">
    <Output TaskParameter="AbsolutePaths"       
            PropertyName="AppOfflineAbsoluteSourcePath" />
  </ConvertToAbsolutePath>
</Target>
```

--------------------------------

### Sample PowerShell Script for Logging Deployments

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/running-windows-powershell-scripts-from-msbuild-project-files

This script defines a function to log deployment details to a specified file. It accepts the log file path and deployment destination as parameters.

```PowerShell
function LogDeployment
{
  param([string]$filepath,[string]$deployDestination)
  $datetime = Get-Date
  $filetext = "Deployed package to " + $deployDestination + " on " + $datetime
  $filetext | Out-File -filepath $filepath -Append
}

LogDeployment $args[0] $args[1]

```

--------------------------------

### Configure Connection Strings in Web.config

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/troubleshooting

If connection strings in the deployed Web.config file start with '$(ReplaceableToken_', edit the project file to add this property to the PropertyGroup element for all build configurations.

```xml
<connectionStrings>
  <add name="DefaultConnection" connectionString="$(ReplaceableToken_DefaultConnection-Web.config Connection String_0)" providerName="System.Data.SqlServerCe.4.0" />
  <add name="SchoolContext" connectionString="$(ReplaceableToken_SchoolContext-Web.config Connection String_0)" providerName="System.Data.SqlServerCe.4.0" />
</connectionStrings>
```

```xml
<AutoParameterizationWebConfigConnectionStrings>False</AutoParameterizationWebConfigConnectionStrings>
```

--------------------------------

### Execute "What If" Deployment via MSBuild

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/performing-a-what-if-deployment

Run a "what if" deployment for all project components by providing the WhatIf property from the command line.

```console
MSBuild.exe Publish.proj /p:WhatIf=true;TargetEnvPropsFile=EnvConfig\Env-Dev.proj
```

--------------------------------

### Add Item-Specific Metadata

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/understanding-the-project-file

Include ItemMetadata child elements within an Item to define user-defined key-value pairs specific to that item. This example shows the DependentUpon metadata for a code file.

```xml
<Compile Include="Global.asax.cs">
   <DependentUpon>Global.asax</DependentUpon>
</Compile>
```

--------------------------------

### Specifying Publish Profile by Full Path

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/command-line-deployment

This command deploys a solution by specifying the full path to the publish profile file. This method is useful when the publish profile is not located in the default properties directory or has a custom name.

```console
msbuild C:\ContosoUniversity\ContosoUniversity\ContosoUniversity.sln /p:DeployOnBuild=true /p:PublishProfile=C:\ContosoUniversity\ContosoUniversity\Properties\PublishProfiles\Test.pubxml

```

--------------------------------

### Create Web Deployment Package with MSBuild Command Line

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/manually-installing-web-packages

Use this command to create a web deployment package from the command line by invoking the Package target on your web application project.

```console
MSBuild.exe [Path to your project].[csproj/vbproj] /T:Package
```

--------------------------------

### Execute PowerShell Script from MSBuild Command Line

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/running-windows-powershell-scripts-from-msbuild-project-files

Execute a PowerShell script remotely from an MSBuild command line. This example includes necessary switches like -NonInteractive and -executionpolicy, and properly escapes characters for XML.

```Console
powershell.exe -NonInteractive -executionpolicy Unrestricted 
               -command &quot;&amp; Invoke-Command 
                 –ComputerName &apos;REMOTESERVER1&apos;
                 -ScriptBlock { &amp;&apos;C:\Path With Spaces\LogDeploy.ps1&apos; 
                                &apos; C:\Path With Spaces\Log.txt &apos;  
                                &apos;TESTWEB1&apos; } &quot;
```

--------------------------------

### MSBuild Target to Execute PowerShell Script

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/running-windows-powershell-scripts-from-msbuild-project-files

Define an MSBuild target to execute a PowerShell script, either locally or remotely. This example uses properties to define the PowerShell executable path and script locations, making it configurable.

```XML
<Target Name="WriteLogEntry" Condition=" '$(WriteLogEntry)'!='false' ">
  <PropertyGroup>
    <PowerShellExe Condition=" '$(PowerShellExe)'==' ' ">
      %WINDIR%\System32\WindowsPowerShell\v1.0\powershell.exe
    </PowerShellExe>
    <ScriptLocation Condition=" '$(ScriptLocation)'==' ' ">
      C:\Path With Spaces\LogDeploy.ps1
    </ScriptLocation>
    <LogFileLocation Condition=" '$(LogFileLocation)'==' ' ">
      C:\Path With Spaces\ContactManagerDeployLog.txt
    </LogFileLocation>
  </PropertyGroup>
  <Exec Command="$(PowerShellExe) -NonInteractive -executionpolicy Unrestricted 
                 -command &quot;&amp; invoke-command -scriptblock { 
                          &amp;&apos;$(ScriptLocation)&apos; 
                          &apos;$(LogFileLocation)&apos;  
                          &apos;$(MSDeployComputerName)&apos;}
                          &quot;"/>
</Target>
```

--------------------------------

### Register ASP.NET 4.0 with IIS (32-bit)

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/configuring-server-environments-for-web-deployment/configuring-a-web-server-for-web-deploy-publishing-remote-agent

Use this command in an administrator command prompt to register the 32-bit version of ASP.NET 4.0 with IIS. This is necessary if IIS fails to serve ASP.NET content after installing the .NET Framework.

```batch
aspnet_regiis -iru
```

--------------------------------

### Deploy Web Application using MSDeploy.exe

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/deploying-web-packages

Use this command to deploy a web application package. It specifies the package source, destination details including computer name and authentication type, and synchronization verb. It also disables certain link extensions and uses a parameter file for configuration. The -allowUntrusted switch is necessary when using self-signed certificates for the Web Deploy Handler.

```console
MSDeploy.exe
  -source:package="[path]\ContactManager.Mvc.zip"
  -dest:auto,
        computerName="https://stageweb1:8172/MSDeploy.axd?site=DemoSite",
        username="FABRIKAM\stagingdeployer",
        $CREDENTIAL_PLACEHOLDER$,
        authtype="Basic",
        includeAcls="False"
  -verb:sync
  -disableLink:AppPoolExtension
  -disableLink:ContentExtension
  -disableLink:CertificateExtension
  -setParamFile:"[path]\ContactManager.Mvc.SetParameters.xml"
  -allowUntrusted

```

--------------------------------

### Web Deploy Command for Staging Deployment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/configuring-server-environments-for-web-deployment/choosing-the-right-approach-to-web-deployment

This command demonstrates deploying a web package to a staging environment using the Web Deploy Handler. It specifies the package source, destination with site-specific credentials, synchronization verb, parameter file, and allows untrusted certificates.

```console
msdeploy.exe 
  -source:package='…\ContactManager.Mvc.zip' 
  -dest:auto,
        computerName='https://STAGEWEB1:8172/MSDeploy.axd?site=DemoSite',
        userName='FABRIKAM\stagingdeployer',
        password=, 
        authtype='Basic', 
  -verb:sync 
  -setParamFile:'…\ContactManager.Mvc.SetParameters.xml' 
  -allowUntrusted
```

--------------------------------

### Deploying an Individual Project with Visual Studio Version

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/command-line-deployment

Use this command to deploy an individual web project, specifying the Visual Studio version. Ensure the project path, deploy on build flag, publish profile name, and Visual Studio version are correctly set.

```console
msbuild C:\ContosoUniversity\ContosoUniversity\ContosoUniversity.csproj /p:DeployOnBuild=true /p:PublishProfile=Test /p:VisualStudioVersion=11.0

```

--------------------------------

### MSBuild Arguments for Staging Deployment with WhatIf

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/deploying-web-applications-in-enterprise-scenarios/application-lifecycle-management-from-development-to-production

Include the 'WhatIf=true' argument to perform a dry run of the staging deployment, logging changes without applying them.

```console
/p:TargetEnvPropsFile=[path]\Env-Stage.proj;
   OutputRoot=[path to build folder];
   WhatIf=true

```

--------------------------------

### Define Project Entry Point in MSBuild

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/understanding-the-project-file

Specify the initial target for the build process within the root Project element. This is useful for custom build scripts.

```xml
<Project ToolsVersion="4.0" DefaultTargets="FullPublish"
         xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  
</Project>
```

--------------------------------

### Deploy to Staging Environment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/creating-and-running-a-deployment-command-file

Use this MSBuild command in a command file to publish your solution to a staging environment. It specifies the project file and a different environment-specific properties file.

```console
msbuild.exe Publish.proj /p:TargetEnvPropsFile=EnvConfig\Env-Stage.proj

```

--------------------------------

### deploy.cmd Trial Mode Deployment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/performing-a-what-if-deployment

Use the /t flag with deploy.cmd to perform a trial deployment. This simulates the deployment process and reports potential changes without applying them. Replace TESTWEB1 and NTLM with your specific environment details.

```console
ContactManager.Mvc.deploy.cmd /t /m:TESTWEB1 /a:NTLM

```

--------------------------------

### Automate Web Package Deployment with MSBuild

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/deploying-web-packages

This MSBuild target automates the deployment of web packages by executing the _.deploy.cmd_ file. It uses properties and item metadata to construct the command arguments, including authentication and additional MSDeploy parameters.

```xml
<Target Name="PublishWebPackages" Outputs="%(PublishPackages.Identity)">
  ...
  <PropertyGroup>
    <_WhatIfSwitch>/Y</_WhatIfSwitch>
    <_WhatIfSwitch Condition=" '$(_WhatIf)'=='true' ">/T</_WhatIfSwitch>
    <_Cmd>
      %(PublishPackages.FullPath) $(_WhatifSwitch) /M:$(MSDeployComputerName) 
      /U:$(MSDeployUsername) /P:$(Password) /A:$(MSDeployAuth) 
      %(PublishPackages.AdditionalMSDeployParameters)
    </_Cmd>
  </PropertyGroup>
  <Exec Command="$(_Cmd)"/>
</Target>
```

--------------------------------

### MSDeploy.exe "What If" Deployment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/performing-a-what-if-deployment

Use the -whatif flag with MSDeploy.exe to simulate a web package deployment. This command shows what would happen without making any changes on the server. Ensure you replace placeholders like [path] and $CREDENTIAL_PLACEHOLDER$ with actual values.

```console
MSDeploy.exe
  -whatif
  -source:package="[path]\ContactManager.Mvc.zip"
  -dest:auto,
        computerName="https://stageweb1:8172/MSDeploy.axd?site=DemoSite",
        username="FABRIKAM\stagingdeployer",
        password=$CREDENTIAL_PLACEHOLDER$,
        authtype="Basic",
        includeAcls="False"
  -verb:sync
  -disableLink:AppPoolExtension
  -disableLink:ContentExtension
  -disableLink:CertificateExtension
  -setParamFile:[path]\ContactManager.Mvc.SetParameters.xml"
  -allowUntrusted

```

--------------------------------

### deploy.cmd Live Deployment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/advanced-enterprise-web-deployment/performing-a-what-if-deployment

Use the /y flag with deploy.cmd to perform a live deployment after verifying the trial run. This flag indicates that you want to update the destination server with the package contents.

```console
ContactManager.Mvc.deploy.cmd /y /m:TESTWEB1 /a:NTLM

```

--------------------------------

### Define OutputRoot and Deployment Paths in _Publish.proj

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/configuring-team-foundation-server-for-web-deployment/deploying-a-specific-build

This XML snippet defines the OutputRoot property and several derived paths used for locating deployment artifacts like .deploymanifest files and .zip/.cmd packages for web projects.

```xml
<PropertyGroup>
  <!--This is where the .deploymanifest file will be written to during a build-->    
  <_DbDeployManifestPath>
    $(OutputRoot)ContactManager.Database.deploymanifest
  </_DbDeployManifestPath>    
  
  <!-- The folder where the .zip and .cmd file will be located for 
                ContactManager.Mvc Web project -->
  <_ContactManagerDest>
    $(OutputRoot)_PublishedWebsites\ContactManager.Mvc_Package\
  </_ContactManagerDest>
  
  <!-- The folder where the .zip and .cmd file will be located for 
                ContactManager.Service Web project -->
   <_ContactManagerSvcDest>
    $(OutputRoot)_PublishedWebsites\ContactManager.Service_Package\
  </_ContactManagerSvcDest>
  
  <!-- ... -->
</PropertyGroup>
```

--------------------------------

### MSBuild Command Line Options for Deployment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/command-line-deployment

Key MSBuild command-line options for web deployment, including specifying the solution file and setting deployment properties like DeployOnBuild and PublishProfile.

```console
msbuild C:\ContosoUniversity\ContosoUniversity.sln /p:DeployOnBuild=true 
/p:PublishProfile=Test
```

--------------------------------

### Deploy to Development Environment

Source: https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/web-deployment-in-the-enterprise/creating-and-running-a-deployment-command-file

Use this MSBuild command in a command file to publish your solution to a developer or test environment. It specifies the project file and an environment-specific properties file.

```console
msbuild.exe Publish.proj /p:TargetEnvPropsFile=EnvConfig\Env-Dev.proj

```
Tokens:
Raw