Release Management tools to deploy an app

Each release action uses a release management tool. For example, Command Line Runner is a tool that runs a specific executable for an action. If you need to perform a task that the provided tools do not support, you can create your own custom tool and add that to a custom release action. Tools can also be used to deploy a component of your app.

Here's a list of the tools and their parameters that are provided with Release Management:

Database Deployment Agent – Execute Script

This tool executes a SQL query in a specific database. It is based on the standard sqlcmd executable distributed with SQL Server. Refer to the sqlcmd documentation for further information about this executable. The configuration variables for this tool are:

Parameter	Variable	Mandatory	Description
-S	ServerName	Yes	The server name of the SQL database.
-i	ScriptName	Yes	The name of the script to be executed.
-b	N/A	No	This parameter is a switch. If present, it means that if an error occurs, the batch will be aborted.

Reporting Services Deployment Agent

This tool deploys reporting services reports and related objects. It is based on a custom release management executable. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-s	serverUrl	Yes	The complete URL of the reporting services server.
-l	itemLocation	Yes if multiple items	The location of the items. If specified, the folder must be provided (-f).
-f	folder	Yes if multiple items	The folder of the items. If specified, the item location must be provided (-l).
-t		Yes	The item type to be processed. The allowed values are: Report Picture
-sp		No	List of search patterns to use to filter the items. Each search pattern must be separated by a comma or a semicolon (for example, *.bmp;*.jpg). If not specified, the search pattern will be as follows based on the selected item type (-t): Report: *.rdl Picture: *.bmp,*.gif,*.jpg,*.jpeg,*.png
-i		Yes if single items	Item file. If specified, the item name must be provided (-n). This parameter is used when a single item must be deployed. If so, the item location (-l) and folder (-f) parameters must not be present.
-n		Yes if single items	Item name. If specified, the item file must be provided (-i). This parameter is used when a single item must be deployed. If so, the item location (-l) and folder (-f) parameters must not be present.
-log		No	A log file with this given name will be generated in the physical directory.
-o	N/A	No	This parameter is a switch. If present, it means that the destination will be overwritten if it already exists.
-ds ds1,...,dsN			Comma-delimited fully qualified name of all data sources to associate with the item. These are case-sensitive. This option only applies to reports. The data source can be in the format [name:] reference. Name is the name of the data source, as specified in the report where the references are to be replaced. Reference is the fully qualified reference to the data source in the target server to use for the report.

MSI Deployment Agent

This tool deploys an MSI. It uninstalls the previous installation of the product before it installs the new one. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./msiexec.ps1.
-MsiFileName	Installer	Yes	The complete path (if required) and name of the .msi file to install.
-MsiCustomArgs	MsiCustomArgs	No	The custom arguments to use to install the .msi file. These arguments will be passed directly to the msiexec executable. If no custom arguments are needed, the parameter will have to be removed from the arguments.
-PrevProductName		No	Allows the user to specify the previous product name to be uninstalled prior to installing the .msi file. By default, the system will use the product name in the .msi file to install.

XCopy Deployment Agent

This tool copies a package location to a specific destination. It is based on a custom release management batch script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-source	N/A	Yes	Fixed value indicating that all the source location must be copied
-destination	Installation Path	Yes	The destination of the copy.

Command Line Runner

This tool runs a specific executable. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-file	N/A	Yes	Fixed value ./RunCommandLine.ps1.
-FilePath	FilePath	Yes	The complete path (if required) and filename of the executable to be run.
-Arguments	Arguments	No	The arguments needed when the executable is run.
-UserDomain	UserDomain	No	The domain of the user to use if the executable has to be run under a specific identity. If not provided, the local user will be used (.\localuser).
-UserName	UserName	No	The name of the user to use if the executable has to be run under a specific identity.
-UserPassword	UserPassword	No	The password of the user to use if the executable has to be run under a specific identity.

Windows Registry Manager

This tool manipulates registry information in Windows. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./ManageWindowsRegistry.ps1.
-Action	Action	Yes	The action to be performed. The allowed values are: CreateKey : Create a new registry key ModifyKey : Modify a registry key or its data DeleteKey : Delete a registry key with all its values and sub keys CreateValue : Create a new registry value located under a key ModifyValue : Modify a registry value located under a key DeleteValue : Delete a registry value located under a key
-OperatingSystemType		No	Indicates if the key / value is accessed in the 32-bit or 64-bit registry. If not provided, the default is 32-bit.
-RegistryKey	RegistryKey	Yes	Path and name of the registry key (for example, HKLM\Software\MyKey).
-RegistryValue		No*	Registry value to which changes will be applied (for example, MyValue). Required for CreateValue, ModifyValue and DeleteValue.
-ValueType		No	Type of the value being affected. The accepted values are: REG_SZ : String (default value if not specified) REG_QWORD_LITTLE_ENDIAN : A 64-bit number in little-endian format REG_QWORD : A 64-bit number REG_NONE : No value REG_MULTI_SZ : Multi-line string (separated by \0) REG_LINK : Symbolic Link REG_EXPAND_SZ : String with unexpanded references to environment variables REG_DWORD_BIG_ENDIAN : A 32-bit number in big-endian format REG_DWORD_LITTLE_ENDIAN : A 32-bit number in little-endian format REG_DWORD : A 32-bit number REG_BINARY : Binary data in any form
-RegistryData		No	The data to apply to either the value (if using CreateValue or ModifyValue) or to the default value of the key (if using CreateKey or ModifyKey).
-RegistryKeyDestination		No*	The registry key name to use when using the ModifyKey action to rename a registry key. For example: RegistryKey = HKLM\Software\MyKey RegistryKeyDestination = HKLM\Software\MyModifiedKey Required for ModifyKey.

Windows Common IO

This tool performs common IO under Windows. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./ManageWindowsIO.ps1.
-Action	Action	Yes	Indicate the action to be performed: Create : Create a new folder Delete : Delete files or folder Rename : Rename a file or folder Move : Move a file or folder Attrib : Modify the attributes (including ownership) of files or folder
-FileFolderName	FileFolderName	Yes	The file or folder path and name.
-DestinationName		No*	The destination name (for rename action) or the folder path and name (for move action). Required for Rename and Move actions.
-ReadOnly		No	Allow the user to set or reset the files or folder read-only attribute. + : Set the flag - : Reset the flag Any other value : Leave the flag as it is
-Archive		No	Allow the user to set or reset the files or folder archive attribute. + : Set the flag - : Reset the flag Any other value : Leave the flag as it is
-System		No	Allow the user to set or reset the files or folder system attribute. + : Set the flag - : Reset the flag Any other value : Leave the flag as it is
-Hidden		No	Allow the user to set or reset the files or folder hidden attribute. + : Set the flag - : Reset the flag Any other value : Leave the flag as it is
-OwnerDomain		No	Represent the domain of the new owner for the file or folder.
-OwnerName		No	Represent the name of the new owner for the file or folder.

Windows Service Manager

This tool manages Windows services. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./ManageWindowsServices.ps1.
-Action	Action	Yes	Indicate the action to be performed: Create : Create a new service Config : Configure an existing service Delete : Delete an existing service Start : Start a service Stop : Stop a service Restart: Stop and start the service
-ServiceName	ServiceName	Yes	Name of the service.
-ServerName		No	The name of the server where this action will be performed. If not specified, the current server will be used.
-BinPath		No*	Binary path and name of the service. Required for Create action, optional for Config action and ignored by all others.
-DisplayName		No	Display name that will be used for this service. Optional for Create and Config actions and ignored by all others.
-Description		No	Description that will be given to the service. Optional for Create and Config actions and ignored by all others.
-UserName		No	User name that will be used for the credentials to start the service (must be in the form DOMAIN\USER). If provided, the parameter –Password must also be provided. If not provided, the LocalSystem account will be used by default. Optional for Create and Config actions and ignored by all others. To reset the credentials to the LocalSystem, enter LocalSystem as the user and "" as the password.
-Password		No	Password of the user name specified to start the service. Optional for Create and Config actions and ignored by all others.
-StartMode		No	Start mode of the service. By default, the service will be created with Automatic. The choices are: Manual : Service is started only manually Automatic : Service will be started automatically next time the computer is restarted Disabled : Service is disabled Optional for Create and Config actions and ignored by all others.

DACPAC Database Deployment Agent

This tool deploys a DACPAC package. It is based on a SQL Server command line utility. There are a lot of possible parameters for this executable but this is the list of parameters that are used for this tool. Please refer to the SQL package command line utility for further information. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
/Action:		Yes	Fixed value: Publish – specifies that the package will be published.
/SourceFile:	FileName	Yes	The complete path (if required) and file name of the DACPAC.
/TargetServerName:	ServerName	Yes	The name of the SQL Server to publish the package to.
/TargetDatabaseName:	DatabaseName	Yes	The name of the SQL Server database to publish the package to.

IIS Deployment Agent

This tool manipulates IIS objects and settings. It is based on a custom release management executable. The configuration variables of this tool vary depending of the type of actions to perform.

For application pool actions:

Parameter	Variable	Mandatory	Description
-Action		Yes	Indicate the action to be performed: CreateApplicationPool ConfigureApplicationPool DropApplicationPool StartApplicationPool StopApplicationPool RecycleApplicationPoo
-ap		Yes	Application Pool name.
-apAllow32Bit		No	Flag that indicates if the application pool must allow 32 bit applications. This parameter is allowed only for IIS 7.0, 7.5, 8.0, and 8.5. The allowed values are: 1 or True: 32 bit applications are allowed 0 or False: 32 bit applications are not allowed
-apIdentUserDomain		No	Domain of the user to use as the identity of the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. If not defined and the “IdentityUserName” is defined, the user will be considered as a local user (.\localuser).
-apIdentUserName		No	User name to use as the identity of the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. If not defined, “IdentityUserDomain” and “IdentityUserPassword” will be ignored and the default value of IIS will be used (ApplicationPoolIdentity).
-apIdentUserPassword		No	The password of the user to use as the identity of the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5.
-apNetVers		No	The .NET Framework version to use for the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. The allowed values are: v1.0, v1.1, v2.0, v4.0
-apPipelineMode		No	The managed pipeline mode to use in the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. The allowed values are: Classic Integrated
-apProcessIdleTimeout		No	The number of minutes a process can be idle in the application pool. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5.
-apRecycleKbMemory		No	The maximum number of KB of memory that be used before the application pool is recycled. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5.
-apRecycleMinutes		No	A fixed number of minutes after which the application pool is recycled. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5.
- apRecycleSpecificTime		No	A fixed time at which the application pool is recycled. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. The required format is HH:MM (for example, 23:58 or 01:23).
-apStartMode		No	The start mode to be used for the application pool. This parameter is allowed only for IIS 8.0 and 8.5. The allowed values are: OnDemand AlwaysRunning
-AutoStart		No	Flag that indicates if the application pool must be started automatically. This parameter is allowed only for IIS 7.0, 7.5, 8.0 and 8.5. The allowed values are: 1 or True: The application pool will be started automatically when Windows starts. 0 or False: The application pool will not be started automatically when Windows starts.
-log		No

For Web Site actions:

Parameter	Variable	Mandatory	Description
-Action		Yes	Indicate the action to be performed: CreateWebSite ConfigureWebSite DropWebSite StartWebSite StopWebSite RestartWebSite
-sn		Yes	Web site name.
-port		No*	The port number of the website. Mandatory for create action and optional in configure.
-pd		No*	The full path routing to the location where the application was published. Mandatory for create action and optional in configure. Note Ensure that there is no trailing slash in the path.
-ap		No	Name of the application pool. If not defined when creating an application pool, the default application pool will be used. Optional in Create and Configure actions.
-EnablePreload		No	Allowed on IIS 7.0, 7.5, 8.0 and 8.5. Flag that indicates if the web site must be preloaded. Optional in Create and Configure actions. Allowed values are: 1 or True: Preload enabled 0 or false: Preload disabled
-AutoStart		No	Allowed on IIS 7.0, 7.5, 8.0 and 8.5. Flag that indicates if the web site must be automatically started. Optional in Create and Configure actions. Allowed values are: 1 or True: Start Automatically 0 or false: Do not Start Automatically
-log		No	A log file with this given name will be generated in the physical directory.

For Web Application actions:

Parameter	Variable	Mandatory	Description
-Action		Yes	Indicate the action to be performed: CreateWebApplication ConfigureWebApplication DropWebApplication
-ws		Yes	Name of the application to create.
-pd		No*	The full path routing to the location where the application was published. Mandatory for create action and optional in configure.
-sn		No	Website name. If not specified, the system will use Default web site when creating a new application. Optional in Create and Configure actions.
-ap		No	Name of the application pool. If not defined when creating an application pool, the default application pool will be used. Optional in Create and Configure actions.
-EnablePreload		No	Allowed on IIS 7.0, 7.5, 8.0 and 8.5. Flag that indicates if the web site must be preloaded. Optional in Create and Configure actions. Allowed values are: 1 or True: Preload enabled 0 or false: Preload disabled
-log		No	A log file with this name will be generated in the physical directory.

For virtual directory actions:

Parameter	Variable	Mandatory	Description
-Action		Yes	Indicate the action to be performed: CreateVirtualDirectory ConfigureVirtualDirectory DropVirtualDirectory
-vd		Yes	Name of the virtual directory.
-pd		No*	The full path of the virtual directory. Mandatory for create action and optional in configure.
-sn		No	Website name. If not specified, the system will use Default web site when creating a new application. Optional in Create and Configure actions.
-ws		No	Web application name. If not specified, the system will use the root web application when creating a new virtual directory. Optional in Create and Configure actions.
-log		No	A log file with this name will be generated in the physical directory.

Microsoft Azure VM Manager

This tool manages a VM in Microsoft Azure. It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./ControlAzureVM.ps1.
-Command		Yes	Indicate the action to be performed: Start: Start the VM Stop: Stop the VM
-ServiceName	ServiceName	Yes	The name of the Microsoft Azure service in which the VM exists.
-Name	Name	Yes	The name of the Microsoft Azure VM.

XBAP Deployer

This tool deploys an XBAP application. It is based on a custom release management executable. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-pn	ProjectName	Yes	The XBAP project name to be deployed.
-d	Installation Path	Yes	The installation path for the XBAP application.
-ml		No	The complete path to the mage utility executable. If not defined, the tool will use the one provided as a resource in the tool.
-pl		No	The complete path where the XBAP project to deploy is located. If not specified, the tool will use the package location where it is executed.
-url		No	If specified, the system will replace the URL of the setup.exe file with the one specified.
-cf		No	If specified, this will be used as the certification name when updating the manifest.
-pwd		No	If specified, this will be used as the certification password when updating the manifest.
-log		No	A log file with this name will be generated in the physical directory.

Microsoft Test Manager (MTM) Command-Line Utility

This tool creates and launches automated tests run on MTM (Microsoft Test Manager). It is based on a custom release management PowerShell script. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./TcmExec.ps1.
-Title	TestRunTitle	Yes	The name that will be used when creating the test run.
-PlanId	PlanId	Yes	The identifier of the Test Plan under which the tests must run (Unique ID as defined in Test Manager).
-SuiteId	SuiteId	Yes	The identifier of the Suite that you want to run (Unique ID as defined in Test Manager).
-ConfigId	ConfigId	Yes	The identifier of the Test Configuration under which the tests must run (Unique ID as defined in Test Manager).
-Collection	TFSCollection	Yes	The Team Foundation Server Collection URL for which the automated tests will execute.
-TeamProject	TeamProject	Yes	The name of the Team Project in which the automated tests were configured.
-TestEnvironment	TestEnvironment	Yes	The Test Environment in which the Tests are to be executed (the test environment is associated to a corresponding test controller).
-BuildDirectory	BuildDirectory	No*	The location of the automated tests. In MTM 2010, this parameter is required. In MTM 2012, 2013 this parameter is still supported, but users should preferably use BuildDefinition and BuildNumber parameters.
-BuildDefinition		No*	Allows the user to specify the build definition in which the automated tests are included. This parameter can only be used with MTM 2012. If defined, the BuildNumber parameter must also be specified. If not specified, the field "build" visible in the details of a test run will not be affected by the test run.
-BuildNumber		No*	Allows the user to specify the build number whose drop location will contain the automated tests. This parameter can only be used under MTM 2012. If defined, the BuildDefinition parameter must also be specified. If not specified, the field "build" visible in the details of a test run, will not be affected by the test run.
-SettingsName		No	Allows the user to specify the settings to use for the test run. If not specified, the default test settings will be used.
-TestRunWaitDelay		No	Allows the user to specify the delay, in seconds, between each call to the test controller. This is required to allow the test run to complete before processing the test results. If not specified, it will default to 10 seconds.
-InconclusiveFailsTests	N/A	No	When this flag is set, the existence of inconclusive tests will fail the deployment. By default, an inconclusive test will not fail the deployment.
-RemoveIncludeParameter	N/A	No	When this flag is set, the /include parameter will not be appended to the test creation command. This means that any tests that have a status different than Active will not be included in the test run.

If the automated tests are included in the same build process as the application being deployed, it is possible to use metadata as the variable value and it will be automatically replaced at release time. The following is the currently available metadata that can be used with configuration variables.

Variable	Variable Value Metadata
BuildDirectory	$(PackageLocation)
BuildNumber	$(BuildNumber)
BuildDefinition	$(BuildDefinition)
TFSCollection	$(TFSUrlWithCollection)
TeamProject	$(TeamProject)

INI File Manager

This tool modifies the content of a .ini file and can create a new .ini file if specified. It is based on a custom release management executable. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-Action		Yes	Indicate the action to be performed: ModifySection RemoveSection CreateKeyValue ModifyKeyValue RemoveKeyValue
-INIFile	INIFileName	Yes	The .ini file name and path (if required)
-SectionName	SectionName	No	The section name to affect. If not specified, the root section will be considered (all keys that are at the beginning of the file before the first section are considered in the root).
-NewSectionName		No	The new section name. If not specified, the root section will be considered (all keys that are at the beginning of the file before the first section are considered in the root). Required for ModifySection action.
-KeyName		No	The key name to affect. Required for CreateKeyValue, ModifyKeyValue and RemoveKeyValue.
-KeyValue		No	The value to use for the key. When using the ModifyKeyValue action and this parameter is not specified and the NewKeyName is specified, the system will use the actual value. If not specified and the NewKeyName is not specified, the value will be empty.
-NewKeyName		No	The new name to give to the key. Used only in the ModifyKeyValue action.
-CreateFileIfNotExists		No	Indicate to the tool that a file must be created if it does not exist.

Windows Process

This tool can kill a Windows Process. The configuration variables of this tool are:

Parameter	Variable	Mandatory	Description
-command	N/A	Yes	Fixed value ./WindowsProcess.ps1.
-ProcessName		Yes	The name of the Windows process to kill.
-UserName		No	The user account running the process. If not specified, the process will be killed for all users.
-IsKillProcessTree		No	Flag that indicates if the process tree must be killed. Allowed values are: 1: Kill process tree 0 or empty: Do not kill process tree