Ressource Service dans DSC

S’applique à : Windows PowerShell 4.0, Windows PowerShell 5.x

La ressource Service dans la configuration d’état souhaité (DSC) Windows PowerShell fournit un mécanisme pour gérer des services sur un nœud cible.

Notes

Cette documentation de cette ressource DSC couvre la version incluse avec PowerShell antérieure à la version 7.2. Le module PSDscResources contient des ressources DSC nouvelles et mises à jour qui sont officiellement prises en charge par Microsoft. Le module PSDscResources est disponible à partir de PowerShell Gallery.

Pour plus d’informations et la documentation mise à jour, consultez la documentation de référence PSDscResources.

Syntaxe

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] ]
}

Propriétés

Propriété	Description
Nom	Indique le nom du service Notez qu’il peut être différent du nom d’affichage. Vous pouvez obtenir une liste des services et leur état actuel avec l’applet de commande Get-Service.
BuiltInAccount	Indique le compte de connexion à utiliser pour le service. Sont autorisées pour cette propriété les valeurs suivantes : LocalService, LocalSystem et NetworkService.
Informations d'identification	Indique les informations d’identification pour le compte sous lequel s’exécute le service. Cette propriété et la propriété BuiltinAccount ne peuvent pas être utilisées ensemble.
StartupType	Indique le type de démarrage du service. Sont autorisées pour cette propriété les valeurs suivantes : Automatic, Disabled et Manual.
State	Indique l’état que vous voulez assurer pour le service. Les valeurs sont : Running ou Stopped.
Les dépendances	Tableau des noms des dépendances que le service doit avoir.
Description	Indique la description du service cible.
DisplayName	Indique le nom complet du service cible.
Chemin d’accès	Indique le chemin du fichier binaire d’un nouveau service.

Propriétés communes

Propriété	Description
DependsOn	Indique que la configuration d’une autre ressource doit être exécutée avant celle de cette ressource. Par exemple, si vous voulez exécuter en premier le bloc de script de configuration de ressource ayant l’ID ResourceName et le type ResourceType, utilisez la syntaxe suivante pour cette propriété : DependsOn = "[ResourceType]ResourceName".
Ensure	Indique si le service cible existe sur le système. Affectez la valeur Absent à cette propriété pour vous assurer que le service cible n’existe pas. Définissez-la sur Present pour être assuré que le service cible n’existe pas. La valeur par défaut est Present.
PsDscRunAsCredential	Définit les informations d’identification pour l’exécution de l’ensemble de la ressource.

Notes

La propriété commune PsDscRunAsCredential a été ajoutée à WMF 5.0 pour permettre l’exécution d’une ressource DSC dans le contexte d’autres informations d’identification. Pour plus d’informations, consultez Utiliser des informations d’identification avec des ressources DSC.

Exemple

configuration ServiceTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {

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