タスク作成
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
タスクはSIF設定から呼び出せるPowerShell関数です。設定を呼び出すと、各タスクが1つのアクションを実行します。タスクはPowerShell関数として実装されているため、PowerShellが提供するすべての機能の恩恵を受けられます。
CmdletBinding属性
タスクを作成する際にはCmdletBinding属性を使用しなければなりません。これにより、エラー処理を制御する一般的なPowerShellパラメータのサポートが得られます。
ユーザーがタスクのアクションを適用せずにテストできるように、SupportsShouldProcessパラメータを使用するのがベストプラクティスです。以下の例はInvoke-UnpackTaskコマンドレットのCmdletBinding属性を使用しています。
Function Invoke-UnpackTask { CmdletBinding(SupportsShouldProcess=$true) param(
Parameters
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
) # function code }
CmdletBinding属性の詳細については、Microsoft PowerShellドキュメントの「About Functions CmdletBindingAttribute」をご覧ください。
タスクパラメータ
タスクパラメータは通常のPowerShellパラメータとして宣言されます。検証や型を使ってコマンドレットに渡せる値を制限できます。これにはパラメータを必須としてマークしたり、複数のパラメータセットをサポートしたりすることが含まれます。
設定からタスクが呼び出されると、ParamsプロパティはPowerShell関数で宣言されたパラメータにマッピングされます。例えば、Invoke-CopyTaskコマンドレットは以下のパラメータを宣言します。
Function Invoke-CopyTask { CmdletBinding(SupportsShouldProcess=$true) param( Parameter(Mandatory=$true) ValidateScript({ Test-Path $_ }) string$Source, Parameter(Mandatory=$true) ValidateScript({ Test-Path $_ -IsValid }) string$Destination )
function code
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
}
- Sourceパラメータは必須で、与えられた値が存在する経路を指す文字列であることを検証します。
- Destinationパラメータは必須で、与えられた値が有効なファイルパスである文字列かどうかを確認します。
以下は、必須パラメータのみを使用する構成でCopyタスクを宣言する方法の例です:
{ "Tasks": { "CopySomeFiles": { "Type": "Copy", "Params": { "Source":"c:\somefile\example.txt", "Destination":"c:\copied\" } } } }
タスクからの返還価値
タスクは返却値を必要としません。設定を通じてタスクを呼び出す場合、タスクから返された値は直接取得または処理されません。しかし、タスクから返した値はインストールログに表示されます。
ログに書き込み
以前のSIFバージョンでは、情報を記録するためにWrite-TaskInfo関数を使用していました。この関数は現在非推奨となり、今後のバージョンで削除される予定です。代わりに、Write-Information関数を使用してください。
Write-Information -MessageData task "Info Updated"
サイレント出力
すべてのストリームを $nullにリダイレクトすることでサイレント出力を指定する
Install-SitecoreConfiguration -Path MyConfig.json *> $null
ログファイルの作成
SIFバージョン1.xでは、組み込みのPowerShellトランスクリプト機能を使ってInstall-SitecoreConfigurationを呼び出すたびに、ログファイルが自動的に作成されていました。
この機能は、異なるホストやログファイルに記録された情報の問題により削除されました。インストール用のログファイルを作成するには、以下の構文を使用します。
c:\> Install-SitecoreConfiguration
*>&1情報や警告などのすべてのストリームを出力ストリームに統合します。
| Tee-Object
構成にタスクを含める
タスクが書き込まれたら、SIFに登録しなければなりません。タスクを構成に含めるには、PowerShellモジュールとしてパッケージ化し、構成のModulesセクションに追加し、構成内で直接登録するか、autoregisterextensions機能を有効にする必要があります。
Register-SitecoreInstallExtensionコマンドレットを使うと、タスクを構成で使用できます。例えば、Copy-CustomItemsコマンドレットをCustomCopyタスクとして登録するには、以下のコマンドレットを使用します。
Register-SitecoreInstallExtension -Command Copy-CustomItems -As CustomCopy -Type Task
!注既存の登録タスクは -Forceパラメータを使って置き換えることができます。以下のカスタムコマンドレットはデフォルトのコピータスクを置き換えます: Register-SitecoreInstallExtension -Command Copy-CustomItems -As Copy -Type Task –Force。