DSC WindowsOptionalFeature リソース

適用先:Windows PowerShell 5.x

Windows PowerShell Desired State Configuration (DSC) の WindowsOptionalFeature リソースは、オプション機能をターゲット ノードで有効にするためのメカニズムを備えています。

注意

WindowsOptionalFeature は、Windows 10 などの Windows クライアント コンピューターでのみ機能します。

注意

この DSC リソースのこのドキュメントでは、バージョン 7.2 より前の PowerShell に含まれているバージョンについて説明します。 PSDscResources モジュールには、Microsoft によって正式にサポートされている新規および更新された DSC リソースが含まれています。 PSDscResources モジュールは、PowerShell ギャラリーから入手できます。

詳細と更新されたドキュメントについては、 PSDscResources リファレンス ドキュメントを参照してください。

構文

WindowsOptionalFeature [string] #ResourceName
{
    Name = [string]
    [ NoWindowsUpdateCheck = [bool] ]
    [ RemoveFilesOnDisable = [bool] ]
    [ LogLevel = [string] { ErrorsOnly | ErrorsAndWarning | ErrorsAndWarningAndInformation }  ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Enable | Disable }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Properties

プロパティ	説明
名前	有効または無効にする機能の名前を示します。
NoWindowsUpdateCheck	機能を有効にするソース ファイルを検索するとき、DISM が Windows Update (WU) を確認するかどうかを指定します。 $true の場合、DISM は WU に接続しません。
RemoveFilesOnDisable	Ensure が Absent に設定されているときに、$true に設定すると、その機能に関連付けられているすべてのファイルが削除されます。
LogLevel	ログに表示される最大の出力レベル。 有効な値はErrorsOnly、ErrorsAndWarning、ErrorsAndWarningAndInformation です。
LogPath	リソース プロバイダーの操作を記録するログ ファイルへのパス。

共通プロパティ

プロパティ	説明
DependsOn	このリソースを構成する前に、他のリソースの構成を実行する必要があることを示します。 たとえば、最初に実行するリソース構成スクリプト ブロックの ID が ResourceName で、そのタイプが ResourceType である場合、このプロパティを使用する構文は DependsOn = "[ResourceType]ResourceName" になります。
Ensure	機能が有効かどうかを指定します。 機能を確実に有効にするには、このプロパティを Enable に設定します。 機能を確実に無効にするには、このプロパティを Disable に設定します。 既定値は Enable です。
PsDscRunAsCredential	リソース全体を実行するための資格情報を設定します。

注意

PsDscRunAsCredential という共通プロパティは、他の資格情報という文脈の中であらゆる DSC リソースを実行するために WMF 5.0 で追加されました。 詳細については、「DSC リソースに対して資格情報を使用する」を参照してください。