DSC Service 资源

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

Windows PowerShell Desired State Configuration (DSC) 中的 Service 资源提供了在目标节点上管理服务的机制。

注意

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

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

语法

Service [string] #ResourceName
{
    Name = [string]
    [ BuiltInAccount = [string] { LocalService | LocalSystem | NetworkService }  ]
    [ Credential = [PSCredential] ]
    [ StartupType = [string] { Automatic | Disabled | Manual }  ]
    [ State = [string] { Running | Stopped }  ]
    [ Dependencies = [string[]] ]
    [ Description = [string] ]
    [ DisplayName = [string] ]
    [ Path = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present } ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

属性

属性	说明
名称	指示服务名称。 请注意，有时它与显示名称不同。 可使用 Get-Service cmdlet 获取服务及其当前状态的列表。
BuiltInAccount	指示要用于服务的登录帐户。 允许用于此属性的值有：LocalService 、LocalSystem 和 NetworkService 。
凭据	指示服务将在其下运行的帐户的凭据。 此属性与 BuiltinAccount 属性不能一起使用。
StartupType	设置服务的启动类型。 允许用于此属性的值有：Automatic、Disabled 和 Manual。
状态	指示你想要确保服务所处的状态。 有效值为：Running 或 Stopped。
依赖项	服务应具有的依赖项名称的数组。
说明	指示目标服务的说明。
DisplayName	指示目标服务的显示名称。
路径	指示新服务的二进制文件的路径。

公共属性

properties	说明
DependsOn	指示必须先运行其他资源的配置，再配置此资源。 例如，如果想要首先运行 ID 为 ResourceName、类型为 ResourceType 的资源配置脚本块，则使用此属性的语法为 DependsOn = "[ResourceType]ResourceName"。
Ensure	指示目标服务是否在系统中存在。 将此属性设置为 Absent 可确保目标服务不存在。 将其设置为 Present 可确保目标服务存在。 默认值为 Present。
PsDscRunAsCredential	设置用于运行整个资源的身份的凭据。

注意

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

示例

configuration ServiceTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {

        Service ServiceExample
        {
            Name        = "TermService"
            StartupType = "Manual"
            State       = "Running"
        }
    }
}