Set-SCSQLScriptCommand

Modifies the properties of a SQL Server script.

Syntax

Set-SCSQLScriptCommand [-SQLScriptCommand] <SCSQLScriptCommand> [-CommandParameters <String>]
 [-DatabaseName <String>] [-DeploymentOrder <Int32>] [-EncryptConnection <Boolean>]
 [-ExecutionTimeoutSeconds <Int32>] [-JobVariable <String>] [-LoginTimeoutSeconds <Int32>]
 [-OutputFilePath <String>] [-PROTipID <Guid>] [-RunAsAccount <VMMCredential>] [-RunAsynchronously]
 [-SQLAuthenticationType <String>] [-SQLScript <Script>] [-SQLScriptType <SQLScriptCommandType>]
 [-WarnAndContinueOnError <Boolean>] [<CommonParameters>]

Description

The Set-SCSQLScriptCommand cmdlet modifies the properties of a SQL Server script associated with an application deployment.

Examples

Example 1: Modify a SQL Server script command

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $AppDeployment = Get-SCApplicationDeployment -ApplicationProfile $AppProfile -Name "SQLDataTierApp01"
PS C:\> $SQLScript = Get-SCSQLScriptCommand -ApplicationDeployment $AppDeployment | where {$_.DeploymentOrder -eq "1" -and $_.SQLScriptType -eq "PreInstall"}
PS C:\> Set-SCSQLScriptCommand -SQLScriptCommand $SQLScript -DatabaseName "MSOrders"

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

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

The third command gets the first PreInstall SQL Server script object associated with the application deployment stored in $AppDeployment, and then stores the object in the $SQLScript variable. The cmdlet selects the correct object by specifying a deployment order of 1 and a script type of PreInstall.

The last command modifies the database against which the SQL Server script stored $SQLScript will run.

Parameters

-CommandParameters

Specifies the parameters for a script or executable program.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DatabaseName

Specifies the name of a database for a SQL Server script.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentOrder

Specifies the order in which a computer tier, application host, or application is deployed.

Type:Int32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EncryptConnection

Indicates whether the SQL Server connection is encrypted.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExecutionTimeoutSeconds

Specifies the amount of time, in seconds, that the SQL Server script command waits before it times out.

Type:Int32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

Specifies a variable in which job progress is tracked and stored.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LoginTimeoutSeconds

Specifies the amount of time, in seconds, that a SQL Server login waits before it times out.

Type:Int32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OutputFilePath

Specifies a file path to store output data from a SQL Server script.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunAsAccount

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

Type:VMMCredential
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.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SQLAuthenticationType

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

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SQLScript

Specifies a SQL Server script.

Type:Script
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SQLScriptCommand

Specifies a SQL Server script command object.

Type:SCSQLScriptCommand
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-SQLScriptType

Specifies a SQL Server script type. The acceptable values for this parameter are:

- PreInstall

  • PostInstall
  • PreService
  • PostService
  • PreUninstall
  • PostUninstall

Type:SQLScriptCommandType
Parameter Sets:PreInstall, PostInstall, PreService, PostService, PreUninstall, PostUninstall
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WarnAndContinueOnError

Indicates whether the script warns the user and continues if the SQL Server script encounters an error while it runs.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

SQLScriptCommand

This cmdlet returns a **SQLScriptCommand** object.