Invoke-DscResource
指定した DSC リソースのメソッドを実行します。
構文
Invoke-DscResource
[-Name] <String>
[-Method] <String>
-ModuleName <ModuleSpecification>
-Property <Hashtable>
[<CommonParameters>]
説明
コマンドレットはInvoke-DscResource
、指定したWindows PowerShell Desired State Configuration (DSC) リソースのメソッドを実行します。 このコマンドレットを実行する前に、ローカル Configuration Manager (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
Type: | String |
Accepted values: | Get, Set, Test |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ModuleName
このコマンドレットが指定したリソースを呼び出すモジュールの名前を指定します。
Type: | ModuleSpecification |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
開始する DSC リソースの名前を指定します。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Property
ハッシュ テーブルで、リソースのプロパティ名と値を、それぞれキーと値として指定します。
コマンドレットを Get-DscResource
使用して、リソースのプロパティとその型を検出します。
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
出力
Microsoft.Management.Infrastructure.CimInstance, System.Boolean