スクリプト
概要
PowerShell スクリプト ブロックを実行します。
構文
Script [String] #ResourceName
{
GetScript = [string]
SetScript = [string]
TestScript = [string]
[Credential = [PSCredential]]
[DependsOn = [string[]]]
[PsDscRunAsCredential = [PSCredential]]
}
説明
リソース Script
を使用すると、特定の DSC リソースが使用できない場合にリソースを取得、テスト、設定するための PowerShell コードを記述できます。 これらのメソッドのコードを指定し、すべての依存関係を処理し、コードがべき等であることを確認する必要があります。
ヒント
可能であれば、このリソースの代わりに定義済みの DSC リソースを使用することをお勧めします。 この Script
リソースには、テスト、保守、予測がより困難になる欠点があります。
他の DSC リソースとは異なり、リソースのすべてのプロパティ Script
はキー プロパティであり、このリソースの Get メソッドは現在の状態の 1 つの文字列のみを返すことができます。 このリソースがべき等に実装されていること、またはカスタム コードを使用しているため、どのシステムでも期待どおりに動作するという保証はありません。 ターゲット システムで呼び出されないとテストできません。
リソースを使用する前に Script
、代わりに リソースを作成 できるかどうかを検討してください。
適切に定義された DSC リソースを使用すると、構成の読み取りと保守が容易になります。
要件
[なし] :
プロパティ
キーのプロパティ
GetScript
リソースの現在の状態を取得する PowerShell スクリプトブロックを指定します。 このスクリプトブロックは、このリソースの Get メソッドが呼び出されたときに実行されます。
このスクリプトブロックは、文字列値を持つ という名前 Result
の 1 つのキーを含むハッシュ テーブルを返す必要があります。
Type: System.String
SetScript
リソースを目的の状態に構成する PowerShell スクリプトブロックを指定します。 このスクリプト ブロックは、このリソースの Set メソッドが呼び出されたときに実行されます。
このスクリプト ブロックでは、オブジェクトを出力しないでください。 Set メソッドを 2 回呼び出すと、ターゲットが 1 回呼び出されるのと同じ状態になるように、このスクリプト ブロックはべき等に記述する必要があります。
Type: System.String
TestScript
リソースが目的の状態であるかどうかを検証する PowerShell スクリプトブロックを指定します。 このスクリプト ブロックは、このリソースの Test メソッドが呼び出されたときに実行されます。
このスクリプト ブロックは、リソースが目的の状態であり、$false
目的の状態でない場合は を返す$true
必要があります。
Type: System.String
省略可能なプロパティ
資格証明
必要に応じて、スクリプトブロックを実行するアカウントの資格情報を指定します。
Type: System.Management.Automation.PSCredential
Default Value: None
読み取り専用プロパティ
結果
GetScript スクリプト ブロックからの結果。
Type: System.String