設定関数を作成する
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
設定関数とは、SIF設定内で呼び出して値を計算し、それをタスクに渡すことができるPowerShell関数のことです。
設定関数はPowerShell関数として実装されるため、PowerShellが提供するすべての機能の恩恵を受けられます。これにはパラメータ検証、厳密モード、要求などが含まれます。
設定関数は常に値を返す必要があり、その値は他の設定関数や構成内のタスクで利用されます。
構成関数パラメータ
設定関数のパラメータは通常のPowerShellパラメータとして宣言されます。検証や型を使って渡せる値を制限できます。これにはパラメータを必須としてマークしたり、複数のパラメータセットをサポートしたりすることが含まれます。
設定関数が設定から呼び出されると、パラメータは宣言された順序で適用されます。異なる順序で適用したい場合は、Positionの引数を使って順序を指定します。
Invoke-JoinConfigFunction関数は以下のパラメータを宣言します:
Function Invoke-JoinConfigFunction { param( Parameter(Mandatory=$true) psobject$Values = @(), Parameter(Mandatory=$false) string$Delimiter = "," )
# function code }
構成では、次のように使えます:
{ "Parameters": { "Values": { "Type": "string", "DefaultValue": 1,2,3,4,5 }, "Variables": { "Joined": "join(parameter('Values'), '-') } }
Joined変数を評価すると、次の値が得られます
。構成に設定関数を含める
設定関数を書き終えたら、SIFに登録しなければなりません。設定関数はPowerShellモジュールとしてパッケージ化し、構成のModulesセクションに追加することで構成に組み込めます。
Register-SitecoreInstallExtensionコマンドレットを使用することで、設定関数が構成で利用可能になります。例えば、以下のコマンドレットはGet-CustomJoinコマンドレットをCustomJoin設定関数として登録しています:
Register-SitecoreInstallExtension -Command Get-CustomJoin -As CustomJoin -Type ConfigFunction
!注既存の登録済み設定関数を置き換えるために -Forceパラメータを使うこともできます。以下の例では、デフォルトのジョイン設定関数がカスタムコマンドレットに置き換えられています:
Register-SitecoreInstallExtension -command Get-CustomJoin -As join -Type ConfigFunction –Force