DSC ServiceSet リソース

適用先:Windows PowerShell 4.0、Windows PowerShell 5.x

PowerShell Desired State Configuration (DSC) の ServiceSet リソースは、ターゲット ノード上でサービスを管理するためのメカニズムを備えています。 このリソースは複合リソースであり、Name プロパティに指定されているサービスごとに Service リソースを呼び出します。

サービスの数を同じ状態に構成するときにこのリソースを使用します。

注意

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

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

構文

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

Properties

プロパティ	説明
名前	サービス名を示します。 これは表示名とは異なることがあります。 Get-Service コマンドレットを使用すると、サービスとその現在の状態の一覧を取得できます。
StartupType	サービスのスタートアップの種類を示します。 このプロパティで有効な値は、Automatic、Disabled、Manual です。
BuiltInAccount	サービスに使用するサインイン アカウントを示します。 このプロパティで有効な値は、LocalService、LocalSystem、NetworkService です。
State	サービスの状態 (停止または実行中) を示します。
資格情報	サービス リソースを実行するアカウントの資格情報を示します。 このプロパティおよび BuiltinAccount プロパティを同時に使用することはできません。

共通プロパティ

プロパティ	説明
DependsOn	このリソースを構成する前に、他のリソースの構成を実行する必要があることを示します。 たとえば、最初に実行するリソース構成スクリプト ブロックの ID が ResourceName で、そのタイプが ResourceType である場合、このプロパティを使用する構文は DependsOn = "[ResourceType]ResourceName" になります。
Ensure	サービスがシステムに存在するかどうかを示します。 サービスが存在しないようにするには、このプロパティを [Absent] に設定します。 対象サービスの存在を保証するには、これを Present に設定します 既定値は Present です。
PsDscRunAsCredential	リソース全体を実行するための資格情報を設定します。

注意

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

例

次の構成で "Windows オーディオ" サービスと "リモート デスクトップ サービス" サービスが開始します。

configuration ServiceSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {
        ServiceSet ServiceSetExample
        {
            Name        = @("TermService", "Audiosrv")
            StartupType = "Manual"
            State       = "Running"
        }
    }
}