Recurso de DSC ServiceDSC Service Resource

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

El recurso Service de la configuración de estado deseado (DSC) de Windows PowerShell ofrece un mecanismo para administrar servicios en el nodo de destino.The Service resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage services on the target node.

Nota

Esta documentación de este recurso de DSC abarca la versión que se incluye con PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. El módulo PSDscResources contiene recursos nuevos y actualizados que Microsoft admite oficialmente.The PSDscResources module contains new and updated that are officially supported by Microsoft. El módulo PSDscResources está disponible en la Galería de PowerShell.The PSDscResources module is available from the PowerShell Gallery.

Para obtener más información y documentación actualizada, consulte el archivo Léame en el repositorio de GitHub.For more information and updated documentation, see the README in the GitHub repository.

SintaxisSyntax

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

PropiedadesProperties

PropiedadProperty DescripciónDescription
NombreName Indica el nombre del servicio.Indicates the service name. Tenga en cuenta que a veces es distinto del nombre para mostrar.Note that sometimes this is different from the display name. Con el cmdlet Get-Service puede obtener una lista de los servicios y sus estados actuales.You can get a list of the services and their current state with the Get-Service cmdlet.
BuiltInAccountBuiltInAccount Indica la cuenta de inicio de sesión que se utilizará para el servicio.Indicates the sign-in account to use for the service. Los valores permitidos para esta propiedad son: LocalService , LocalSystem y NetworkService .The values that are allowed for this property are: LocalService , LocalSystem , and NetworkService .
Credential:Credential Indica las credenciales de la cuenta en la que se ejecutará el servicio.Indicates credentials for the account that the service will run under. Esta propiedad no se puede utilizar junto con la propiedad BuiltinAccount .This property and the BuiltinAccount property cannot be used together.
StartupTypeStartupType Indica el tipo de inicio del servicio.Indicates the startup type for the service. Los valores permitidos para esta propiedad son: Automatic , Disabled y Manual .The values that are allowed for this property are: Automatic , Disabled , and Manual .
StateState Indica el estado que quiere garantizar para el servicio.Indicates the state you want to ensure for the service. Los valores son: Running o Stopped .The values are: Running or Stopped .
DependenciasDependencies Matriz con los nombres de las dependencias que debe tener el servicio.An array of the names of the dependencies the service should have.
DescripciónDescription Indica la descripción del servicio de destino.Indicates the description of the target service.
DisplayNameDisplayName Indica el nombre para mostrar del servicio de destino.Indicates the display name of the target service.
PathPath Indica la ruta de acceso al archivo binario para un nuevo servicio.Indicates the path to the binary file for a new service.

Propiedades comunesCommon properties

PropiedadProperty DescripciónDescription
DependsOnDependsOn Indica que la configuración de otro recurso debe ejecutarse antes de que se configure este recurso.Indicates that the configuration of another resource must run before this resource is configured. Por ejemplo, si el elemento ID del bloque del script de configuración del recurso que quiere ejecutar primero es ResourceName y su tipo es ResourceType, la sintaxis para usar esta propiedad es DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
EnsureEnsure Indica si el servicio de destino existe en el sistema.Indicates whether the target service exists on the system. Establezca esta propiedad en Absent para asegurarse de que el servicio de destino no exista.Set this property to Absent to ensure that the target service does not exist. Si la establece en Present , se asegura de que el servicio de destino existe.Setting it to Present ensures that target service exists. El valor predeterminado es Present .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Establece la credencial con la que se ejecutará todo el recurso.Sets the credential for running the entire resource as.

Nota

Se ha agregado la propiedad común PsDscRunAsCredential en WMF 5.0 para permitir la ejecución de cualquier recurso de DSC en el contexto de otras credenciales.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Para obtener más información, vea Uso de las credenciales con recursos de DSC.For more information, see Use Credentials with DSC Resources.

EjemploExample

configuration ServiceTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Node localhost
    {

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