Add-SCSQLScriptCommand
SQL Server アプリケーションの展開に SQL Server スクリプトを追加します。
構文
Add-SCSQLScriptCommand
[-LoginTimeoutSeconds <Int32>]
[-ExecutionTimeoutSeconds <Int32>]
[-RunAsAccount <VMMCredential>]
-ApplicationDeployment <ApplicationDeployment>
-SQLScriptType <SQLScriptCommandType>
-SQLScript <Script>
-DeploymentOrder <Int32>
[-CommandParameters <String>]
[-OutputFilePath <String>]
[-EncryptConnection <Boolean>]
[-DatabaseName <String>]
[-SQLAuthenticationType <String>]
[-WarnAndContinueOnError <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
説明
Add-SCSQLScriptCommand コマンドレットは、Microsoft SQL Server スクリプトを SQL Server アプリケーションの展開に追加します。
例
例 1: アプリケーションの展開に SQL Server スクリプトを追加する
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
最初のコマンドは、SvcWebAppProfile01 という名前のアプリケーション プロファイル オブジェクトを取得し、そのオブジェクトを $AppProfile 変数に格納します。
2 番目のコマンドは、SvcWebAppProfile01 アプリケーション プロファイルの SQLDataTierApp01 という名前のアプリケーション配置オブジェクトを取得し、そのオブジェクトを$AppDeployment変数に格納します。
3 番目のコマンドは、virtual Machine Manager (VMM) ライブラリから ConfigureDB.sql リリース 1.0 という名前の SQL Server スクリプト オブジェクトを取得し、そのオブジェクトを $Script 変数に格納します。
最後のコマンドは、$Scriptに格納されている SQL Server スクリプトを、$AppDeploymentに格納されているアプリケーションの展開に追加し、スクリプトを実行するスクリプトの種類、配置順序、およびデータベースを設定します。
パラメーター
-ApplicationDeployment
アプリケーション展開オブジェクトを指定します。
型: | ApplicationDeployment |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-CommandParameters
スクリプトまたは実行可能プログラムのパラメーターを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DatabaseName
SQL Server スクリプトのデータベースの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DeploymentOrder
コンピューター層、アプリケーション ホスト、またはアプリケーションを展開する順序を指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EncryptConnection
SQL Server 接続が暗号化されているかどうかを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExecutionTimeoutSeconds
SQL Server スクリプト コマンドがタイムアウトするまでに待機する時間を秒単位で指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-JobVariable
ジョブの進行状況を追跡して格納する変数を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LoginTimeoutSeconds
SQL Server ログインがタイムアウトするまでの待機時間を秒単位で指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OutputFilePath
SQL Server スクリプトからの出力データを格納するファイル パスを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RunAsAccount
このアクションを実行するアクセス許可を持つ資格情報を含む実行アカウントを指定します。
型: | VMMCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RunAsynchronously
コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SQLAuthenticationType
SQL Server 認証の種類を指定します。 有効な値は、SQLServerAuthentication と WindowsAuthentication です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SQLScript
SQL Server スクリプトを指定します。
型: | Script |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SQLScriptType
SQL Server スクリプトの種類を指定します。 このパラメーターに使用できる値は次のとおりです。
- プレインストール
- PostInstall
- PreService
- PostService
- PreUninstall
- PostUninstall
型: | SQLScriptCommandType |
指定可能な値: | PreInstall, PostInstall, PreService, PostService, PreUninstall, PostUninstall |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WarnAndContinueOnError
スクリプトがユーザーに警告し、実行中に SQL Server スクリプトでエラーが発生した場合に続行するかどうかを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
出力
SQLScriptCommand
このコマンドレットは、SQLScriptCommand オブジェクトを返します。