サービス

[アーティクル]
05/05/2023

構文

Windows サービスを管理します。

構文

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

説明

リソース Service を使用すると、サービスの追加、更新、削除を行うことができます。

要件

[なし] :

キーのプロパティ

名前

サービス名を文字列として指定します。

注意

この値が表示名と異なる場合があります。 Get-Service コマンドレットを使用すると、サービスとその現在の状態の一覧を取得できます。

Type: System.String

省略可能なプロパティ

BuiltInAccount

サービスを実行するコンピューターアカウントの名前を指定します。サービスを開始するには、 Path で指定された実行可能ファイルへのアクセス権がアカウントに必要です。

Credential プロパティでこのプロパティを指定しないでください。

Type: System.String
Accepted Values:
  - LocalService
  - LocalSystem
  - NetworkService
Default Value: Null

資格情報

サービスを実行するアカウントの資格情報を指定します。サービスを開始するには、パスで指定された実行可能ファイルへのアクセス権がアカウントに必要です。リソースは、このアカウントに "サービスとしてログオン" 権限を自動的に付与します。

BuiltInAccount プロパティでこのプロパティを指定しないでください。

Type: System.Management.Automation.PSCredential
Default Value: None

依存関係

このサービスを実行するために必要なサービスの名前を文字列の配列として指定します。

Type: System.String[]
Default Value: None

説明

サービスの説明を文字列として指定します。サービスの説明は、 コンピューターの管理、サービスに表示されます。

Type: System.String
Default Value: None

DesktopInteract

サービスがデスクトップ上のウィンドウを作成または通信できるかどうかを指定します。このプロパティは、$falseBuiltInAccount が次のようにLocalSystem指定されていない場合に指定する必要があります。

既定値は $false です。

Type: System.Boolean
Default Value: false

DisplayName

サービスのわかりやすい表示名を文字列として指定します。

Type: System.String
Default Value: None

Ensure

サービスを存在させるかどうかを指定します。サービスを追加または更新するには、このプロパティを Present. サービスを削除するには、このプロパティを Absent.

既定値は Present です。

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

パス

サービスの実行可能ファイルへのパスを文字列として指定します。このプロパティは、サービスが存在しない場合に必要です。

Type: System.String
Default Value: None

StartupTimeout

サービスの開始をミリ秒単位で待機する時間を指定します。

既定値は 30000 です。

Type: System.UInt32
Default Value: 30000

StartupType

システムの起動時にサービスがどのように動作するかを指定します。値は、次のいずれかである必要があります。

Automatic - サービスは、システムの起動時にオペレーティングシステムによって開始されます。自動的に開始されたサービスが手動で開始されたサービスに依存している場合、手動で開始されたサービスもシステムの起動時に自動的に開始されます。
Disabled - サービスは無効になっており、ユーザーまたはアプリケーションが開始することはできません。
Manual - サービスは、手動、ユーザー、Service Control Manager、またはアプリケーションによってのみ開始されます。

サービスが存在しない場合、既定値は Automatic.

Type: System.String
Behavior: Write
Accepted Values:
  - Automatic
  - Disabled
  - Manual
Default Value: None

State

サービスを実行するかどうかを指定します。値は、次のいずれかである必要があります。

Running - まだ開始されていない場合は、リソースによってサービスが開始されます。
Stopped - リソースが実行中の場合、サービスは停止します。
Ignore - リソースがサービスを開始または停止しません。

既定値は Running です。

Type: System.String
Accepted Values:
  - Running
  - Stopped
  - Ignore
Default Value: Running

TerminateTimeout

サービスが停止するまで待機する時間をミリ秒単位で指定します。既定値は 30000 です。

Type: System.UInt32
Default Value: 30000

次の方法で共有