Invoke-DscResource

リファレンス

モジュール:: PSDesiredStateConfiguration

指定した DSC リソースのメソッドを実行します。

構文

Invoke-DscResource
      [-Name] <String>
      [-Method] <String>
      -ModuleName <ModuleSpecification>
      -Property <Hashtable>
      [<CommonParameters>]

説明

Invoke-DscResource コマンドレットは、指定された Windows PowerShell Desired State Configuration (DSC) リソースのメソッドを実行します。このコマンドレットを実行する前に、ローカル構成マネージャー (LCM) の更新モードを [無効] に設定します。

このコマンドレットは、構成ドキュメントを作成せずに DSC リソースを直接呼び出します。このコマンドレットを使用すると、構成管理製品は DSC リソースを使用してウィンドウを管理できます。このコマンドレットでは、DSC エンジンまたは LCM がデバッグを有効にして実行されている場合に、リソースのデバッグも有効になります。

このコマンドレットは複合リソースでは機能しません。複合リソースは、パラメーター化された構成です。複合リソースを使用するには、LCM が必要です。

例

例 1: 必須プロパティを指定してリソースの Set メソッドを呼び出す

Invoke-DscResource -Name Log -Method Set -Property @{Message = 'Hello World'} -ModuleName PSDesiredStateConfiguration

このコマンドは、Log という名前のリソースの Set メソッドを呼び出し、Message プロパティを指定します。

例 2: 指定したモジュールのリソースの Test メソッドを呼び出す

Invoke-DscResource -Name WindowsProcess -Method Test -Property @{Path = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'; Arguments = ''} -ModuleName PSDesiredStateConfiguration

このコマンドは、PSDesiredStateConfiguration という名前のモジュール内にある WindowsProcess という名前のリソースの Test メソッドを呼び出します。

パラメーター

-Method

このコマンドレットが呼び出すリソースのメソッドを指定します。このパラメーターに使用できる値は次のとおりです。

Get
Set
Test

型:	String
指定可能な値:	Get, Set, Test
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ModuleName

このコマンドレットが指定したリソースを呼び出すモジュールの名前を指定します。

型:	ModuleSpecification
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

開始する DSC リソースの名前を指定します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Property

ハッシュテーブル内のリソースプロパティ名とその値をそれぞれキーと値として指定します。 Get-DscResource コマンドレットを使用して、リソースのプロパティとその種類を検出します。

型:	Hashtable
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

出力

Microsoft.Management.Infrastructure.CimInstance, System.Boolean