Set-SCApplicationDeployment

Article
01/03/2016

Set-SCApplicationDeployment

Modifies an application deployment.

Syntax

Parameter Set: Default
Set-SCApplicationDeployment [-ApplicationDeployment] <ApplicationDeployment> [-ApplicationPackage <ApplicationPackage> ] [-BlockOnChanges <Boolean]> ] [-CommandParameters <String> ] [-DACInstanceName <String> ] [-EnvironmentVariables <Hashtable> ] [-Executable <String> ] [-FailDeploymentIfDBExists <Nullable [System.Boolean]> ] [-IgnoreDataLoss <Boolean]> ] [-JobVariable <String> ] [-LibraryResource <CustomResource> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RollbackOnFailure <Boolean]> ] [-RunAsAccount <VMMCredential> ] [-RunAsynchronously] [-Scriptblock <String> ] [-ScriptCommandSetting <SCScriptCommandSetting> ] [-SkipPolicyValidation <Boolean]> ] [-SQLAuthenticationType <String> ] [-SQLDeploymentRunAsAccount <VMMCredential> ] [-SQLInstanceName <String> ] [-StandardInput <String> ] [-TimeoutSeconds <Int32> ] [-UninstallMode <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCApplicationDeployment cmdlet modifies an application deployment.

Parameters

-ApplicationDeployment<ApplicationDeployment>

Specifies an application deployment object.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-ApplicationPackage<ApplicationPackage>

Specifies an application package object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-BlockOnChanges<Boolean]>

Indicates that the SQL data-tier application (DAC) update is blocked if the database schema is different than that defined in the previous DAC.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CommandParameters<String>

Specifies the parameters for a script or executable program.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DACInstanceName<String>

Specifies the name of a DAC instance.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnvironmentVariables<Hashtable>

Specifies a hashtable that contains the environment variables for the application.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Executable<String>

Specifies the name of an executable program.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FailDeploymentIfDBExists<Nullable [System.Boolean]>

Indicates whether to proceed with deployment if a database with the same name already exists.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IgnoreDataLoss<Boolean]>

Indicates whether data loss that may occur when updating the SQL Server database is ignored.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LibraryResource<CustomResource>

Specifies a resource stored in the VMM library.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of a VMM object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RollbackOnFailure<Boolean]>

Indicates whether to roll back changes if the SQL Server database update fails.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunAsAccount<VMMCredential>

Specifies a Run As account that contains credentials with permission to perform this action.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Scriptblock<String>

Specifies, as a string, a script block for a script application.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ScriptCommandSetting<SCScriptCommandSetting>

Specifies a script command setting object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SkipPolicyValidation<Boolean]>

Indicates whether policy validation against the SQL Server database should occur.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SQLAuthenticationType<String>

Specifies the SQL Server authentication type. Valid values are: SQLServerAuthentication, WindowsAuthentication.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SQLDeploymentRunAsAccount<VMMCredential>

Specifies a Run As account to use to communicate with a SQL Server deployment.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SQLInstanceName<String>

Specifies the name of a SQL Server instance.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StandardInput<String>

Specifies a path to a file that contains standard input information to use with the script command.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TimeoutSeconds<Int32>

Specifies the amount of time, in seconds, that a process waits before timing out.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UninstallMode<String>

Specifies the uninstall mode. Valid values are:

-- MakeUnmanaged
-- DetachDatabase
-- DropDatabase

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

ApplicationDeployment

Examples

Example 1: Update application package for a web application deployment

The first command gets the application profile object named SvcWebAppProfile01, and then stores the object in the $AppProfile variable.

The second command gets the application deployment object named SvcWebDeployment01 for the application profile stored in $AppProfile, and then stores the object in the $AppDeployment variable.

The third command gets the application package object named WebApp02.zip from the VMM library and stores the object in the $AppPackage variable.

The last command updates the application deployment stored in $AppDeployment by replacing the previous application package with the one stored in $AppPackage.

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $AppDeployment = Get-SCApplicationDeployment -Name "SvcWebDeployment01" -ApplicationProfile $AppProfile
PS C:\> $AppPackage = Get-SCApplicationPackage -Name "WebApp02.zip"
PS C:\> Set-SCApplicationDeployment -ApplicationDeployment $AppDeployment -ApplicationPackage $AppPackage

Add-SCApplicationDeployment

Get-SCApplicationDeployment

Get-SCApplicationPackage

Get-SCApplicationProfile

Remove-SCApplicationDeployment

Set-SCApplicationDeployment