DSC WindowsFeature 资源。

适用于：Windows PowerShell 4.0 和 Windows PowerShell 5.x

Windows PowerShell Desired State Configuration (DSC) 中的 WindowsFeature 资源提供了在目标节点上添加或删除角色和功能的机制。

注意

此 DSC 资源的文档介绍了 PowerShell 版本 7.2 之前随附的版本。 PSDscResources 模块包含 Microsoft 正式支持的新的和更新的 DSC 资源。 PowerShell 库中提供了 PSDscResources 模块。

有关详细信息和更新的文档，请参阅 PSDscResources 参考文档。

语法

WindowsFeature [string] #ResourceName
{
    Name = [string]
    [ Credential = [PSCredential] ]
    [ IncludeAllSubFeature = [bool] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

属性

属性	说明
名称	指示想确保添加或删除的角色或功能的名称。 此参数与来自 Get-WindowsFeature cmdlet 的 Name 属性一样，并非该角色或功能的显示名称。
凭据	指示要用于添加或删除角色或功能的凭据。
IncludeAllSubFeature	将此属性设置为 $true 以确保所有必需的子功能的状态为通过 Name 属性指定的功能的状态。
LogPath	指示你希望资源提供程序在其中记录操作的日志文件的路径。

公共属性

properties	说明
DependsOn	指示必须先运行其他资源的配置，再配置此资源。 例如，如果想要首先运行 ID 为 ResourceName、类型为 ResourceType 的资源配置脚本块，则使用此属性的语法为 DependsOn = "[ResourceType]ResourceName"。
Ensure	指示是否已添加角色或功能。 若要确保添加角色或功能，请将此属性设置为 Present。 若要确保删除角色或功能，请将此属性设置为 Absent。 默认值为 Present。
PsDscRunAsCredential	设置用于运行整个资源的身份的凭据。

注意

在 WMF 5.0 中添加了 PsDscRunAsCredential 公共属性，用于允许在其他凭据上下文中运行任何 DSC 资源。 有关详细信息，请参阅将凭据与 DSC 资源配合使用。

示例

WindowsFeature RoleExample
{
    Ensure = "Present"
    # Alternatively, to ensure the role is uninstalled, set Ensure to "Absent"
    Name = "Web-Server" # Use the Name property from Get-WindowsFeature
}