Add-SCSQLScriptCommand

Add-SCSQLScriptCommand

Adds a SQL Server script to a SQL Server application deployment.

Syntax

Parameter Set: Default
Add-SCSQLScriptCommand -ApplicationDeployment <ApplicationDeployment> -DeploymentOrder <Int32> -SQLScript <Script> -SQLScriptType <SQLScriptCommandType> {PreInstall | PostInstall | PreService | PostService | PreUninstall | PostUninstall} [-CommandParameters <String> ] [-DatabaseName <String> ] [-EncryptConnection <Boolean]> ] [-ExecutionTimeoutSeconds <Int32> ] [-JobVariable <String> ] [-LoginTimeoutSeconds <Int32> ] [-OutputFilePath <String> ] [-PROTipID <Guid]> ] [-RunAsAccount <VMMCredential> ] [-RunAsynchronously] [-SQLAuthenticationType <String> ] [-WarnAndContinueOnError <Boolean]> ] [ <CommonParameters>]

Detailed Description

The Add-SCSQLScriptCommand cmdlet adds a Microsoft SQL Server script to a SQL Server application deployment.

Parameters

-ApplicationDeployment<ApplicationDeployment>

Specifies an application deployment object.

-CommandParameters<String>

Specifies the parameters for a script or executable program.

-DatabaseName<String>

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

-DeploymentOrder<Int32>

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

-EncryptConnection<Boolean]>

Specifies whether the SQL Server connection is encrypted.

-ExecutionTimeoutSeconds<Int32>

Specifies the amount of time, in seconds, that the SQL Server script command (SQL statement) waits before timing out.

-JobVariable<String>

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

-LoginTimeoutSeconds<Int32>

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

-OutputFilePath<String>

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

-PROTipID<Guid]>

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

-RunAsAccount<VMMCredential>

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

-RunAsynchronously

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

-SQLAuthenticationType<String>

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

-SQLScript<Script>

Specifies a SQL Server script.

-SQLScriptType<SQLScriptCommandType>

Specifies a SQL Server script type. Valid values are:

-- PreInstall
-- PostInstall
-- PreService
-- PostService
-- PreUninstall
-- PostUninstall

-WarnAndContinueOnError<Boolean]>

Indicates whether the script should warn the user and continue if the SQL Server script encounters an error while running.

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

• SQLScriptCommand

Examples

Example 1: Add a SQL Server script to an 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 SQLDataTierApp01 for the SvcWebAppProfile01 application profile, and then stores the object in the $AppDeployment variable.

The third command gets the SQL Server script object named ConfigureDB.sql, release 1.0, from the VMM library and stores the object in the $Script variable.

The last command adds the SQL Server script stored in $Script to the application deployment stored in $AppDeployment and sets the script type, deployment order, and database against which the script runs.

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $AppDeployment = Get-SCApplicationDeployment -ApplicationProfile $AppProfile -Name "SQLDataTierApp01"
PS C:\> $SQLScript = Get-SCScript -Name "ConfigDB.sql" -Release "1.0"
PS C:\> Add-SCSQLScriptCommand -ApplicationDeployment $AppDeployment -SQLScriptType "PreInstall" -DeploymentOrder 1 -DatabaseName "MSSQLSERVER" -SQLScript $SQLScript

Related topics

Get-SCSQLScriptCommand

Remove-SCSQLScriptCommand

Set-SCSQLScriptCommand

Get-SCApplicationProfile

New-SCScriptCommandSetting