Set-SCSQLScriptCommand
SQL Server スクリプトのプロパティを変更します。
構文
Default (既定)
Set-SCSQLScriptCommand
[-SQLScriptType <SQLScriptCommandType>]
[-DeploymentOrder <Int32>]
[-LoginTimeoutSeconds <Int32>]
[-ExecutionTimeoutSeconds <Int32>]
[-RunAsAccount <VMMCredential>]
[-SQLAuthenticationType <String>]
[-SQLScriptCommand] <SCSQLScriptCommand>
[-SQLScript <Script>]
[-CommandParameters <String>]
[-OutputFilePath <String>]
[-EncryptConnection <Boolean>]
[-DatabaseName <String>]
[-WarnAndContinueOnError <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
説明
Set-SCSQLScriptCommand コマンドレットは、アプリケーションの展開に関連付けられている 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-SCSQLScriptCommand -ApplicationDeployment $AppDeployment | where {$_.DeploymentOrder -eq "1" -and $_.SQLScriptType -eq "PreInstall"}
PS C:\> Set-SCSQLScriptCommand -SQLScriptCommand $SQLScript -DatabaseName "MSOrders"
最初のコマンドは、SvcWebAppProfile01 という名前のアプリケーション プロファイル オブジェクトを取得し、それを $AppProfile 変数に格納します。
2 番目のコマンドは、$ApplicationProfile に格納されているアプリケーション・プロファイルの SQLDataTierApp01 という名前のアプリケーション・デプロイメント・オブジェクトを取得し、そのオブジェクトを $AppDeployment 変数に格納します。
3 番目のコマンドは、$AppDeployment に格納されているアプリケーションのデプロイに関連付けられている最初の PreInstall SQL Server スクリプト オブジェクトを取得し、そのオブジェクトを $SQLScript 変数に格納します。
コマンドレットは、デプロイ順序を 1 に、スクリプトの種類を PreInstall に指定して、正しいオブジェクトを選択します。
最後のコマンドは、$SQLScriptに格納された SQL Server スクリプトの実行対象となるデータベースを変更します。
パラメーター
-CommandParameters
スクリプトまたは実行可能プログラムのパラメータを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DatabaseName
SQL Server スクリプトのデータベースの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DeploymentOrder
コンピューター層、アプリケーション ホスト、またはアプリケーションをデプロイする順序を指定します。
パラメーターのプロパティ
| 型: | Int32
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EncryptConnection
SQL Server 接続が暗号化されているかどうかを示します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExecutionTimeoutSeconds
SQL Server スクリプト コマンドがタイムアウトするまでに待機する時間を秒単位で指定します。
パラメーターのプロパティ
| 型: | Int32
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JobVariable
ジョブの進行状況を追跡および格納する変数を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LoginTimeoutSeconds
SQL Server ログインがタイムアウトするまでに待機する時間を秒単位で指定します。
パラメーターのプロパティ
| 型: | Int32
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OutputFilePath
SQL Server スクリプトからの出力データを格納するファイル パスを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。
このパラメーターを使用すると、PRO のヒントを監査できます。
パラメーターのプロパティ
| 型: | Guid
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RunAsAccount
このアクションを実行するためのアクセス許可を持つ資格情報を含む実行アカウントを指定します。
パラメーターのプロパティ
| 型: | VMMCredential
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RunAsynchronously
コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SQLAuthenticationType
SQL Server の認証の種類を指定します。
有効な値は SQLServerAuthentication と WindowsAuthentication です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SQLScript
SQL Server スクリプトを指定します。
パラメーターのプロパティ
| 型: | Script
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SQLScriptCommand
SQL Server スクリプト コマンド オブジェクトを指定します。
パラメーターのプロパティ
| 型: | SCSQLScriptCommand
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SQLScriptType
SQL Server スクリプトの種類を指定します。
このパラメーターに使用できる値は次のとおりです。
- プレインストール
- ポストインストール
- プリサービス
- ポストサービス
- プレアンインストール
- ポストアンインストール
パラメーターのプロパティ
| 型: | SQLScriptCommandType
|
| 規定値: | None |
| 指定可能な値: | PreInstall, PostInstall, PreService, PostService, PreUninstall, PostUninstall |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WarnAndContinueOnError
スクリプトがユーザーに警告し、SQL Server スクリプトの実行中にエラーが発生した場合に続行するかどうかを示します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
SQLScriptCommand
このコマンドレットは SQLScriptCommand オブジェクトを返します。