DSC ファイルリソース

[アーティクル]
04/06/2023

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

Windows PowerShell Desired State Configuration (DSC) の File リソースは、ターゲットノード上でファイルとフォルダーを管理するためのメカニズムを備えています。 DestinationPath と SourcePath は両方ともターゲットノードからアクセスできる必要があります。

注意

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

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

構文

File [string] #ResourceName
{
    DestinationPath = [string]
    [ Attributes = [string[]] { Archive | Hidden | ReadOnly | System }]
    [ Checksum = [string] { CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 } ]
    [ Contents = [string] ]
    [ Credential = [PSCredential] ]
    [ Force = [bool] ]
    [ Recurse = [bool] ]
    [ SourcePath = [string] ]
    [ Type = [string] { Directory | File } ]
    [ MatchSource = [bool] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present } ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Properties

プロパティ	説明
DestinationPath	Ensure で Present または Absent であることを保証するターゲットノード上の場所。
属性	対象となるファイルまたはディレクトリの属性の望ましい状態。有効な値は、Archive、Hidden、ReadOnly、System です。
Checksum	2 つのファイルが同じであるかどうかを決定するときに使用するチェックサムタイプ。有効な値は、次のとおりです。SHA-1、SHA-256、SHA-512、createdDate、modifiedDate。
内容	File型に使用した場合にのみ有効です。 Ensure (保証) するコンテンツがターゲットファイルで Present または Absent であることを示します。
資格情報	ソースファイルなどのリソースにアクセスするために必要な資格情報。
Force	結果としてエラーになるアクセス操作 (ファイルの上書き、空でないディレクトリの削除など) をオーバーライドします。既定値は `$false` です。
Recurse	Directory型に使用した場合にのみ有効です。すべてのディレクトリコンテンツ、サブディレクトリ、およびサブディレクトリコンテンツに対して状態操作を再帰的に実行します。既定値は `$false` です。
SourcePath	ファイルまたはフォルダーリソースのコピー元のパス。
Type	構成されるリソースの種類。有効な値は Directory と File です。既定値は File です。
MatchSource	最初のコピー後にソースディレクトリに追加された新しいファイルをリソースで監視するかどうかを決定します。 `$true` の値は、最初のコピー後、すべての新しいソースファイルが指定した場所にコピーされることを示します。 `$false` に設定した場合、リソースではソースディレクトリの内容がキャッシュされ、最初のコピー後に追加されたファイルはすべて無視されます。既定値は `$false` です。

警告

Credential または PSRunAsCredential の値を指定しない場合、リソースはターゲットノードのコンピューターアカウントを使用して SourcePath にアクセスします。 SourcePath が UNC 共有の場合、"アクセスが拒否されました" エラーが発生する可能性があります。アクセス許可が適切に設定されていることを保証するか、Credential または PSRunAsCredential プロパティを使用して、使用するアカウントを指定します。

共通プロパティ

プロパティ	説明
DependsOn	このリソースを構成する前に、他のリソースの構成を実行する必要があることを示します。たとえば、最初に実行するリソース構成スクリプトブロックの ID が ResourceName で、そのタイプが ResourceType である場合、このプロパティを使用する構文は `DependsOn = "[ResourceType]ResourceName"` になります。
Ensure	Destination にファイルと Contents が存在するか、しないかを判断します。ファイルが存在することを保証するには、このプロパティを Present に設定します。コンテンツが存在しないことを保証するには、Absent に設定します。既定値は Present です。
PsDscRunAsCredential	リソース全体を実行するための資格情報を設定します。

注意

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

例

次の例では、ファイルリソースを使用して、ディレクトリとそのサブディレクトリをプルサーバーからターゲットノードにコピーします。操作が成功すると、Log リソースで確認メッセージがイベントログに書き込まれます。

ソースディレクトリは、プルサーバーから共有されている UNC パス (\\PullServer\DemoSource) です。 Recurse プロパティを使用すると、すべてのサブディレクトリも確実にコピーされます。

重要

ターゲットノード上の LCM は、既定でローカルシステムアカウントのコンテキストで実行されます。 SourcePath へのアクセスを許可するには、ターゲットノードのコンピューターアカウントに適切なアクセス許可を付与します。 Credential と PSDSCRunAsCredential のいずれでも、LCM が SourcePath にアクセスするために使用するコンテキストが変更されます。それでも SourcePath へのアクセスに使用されるアカウントへのアクセスを許可する必要があります。

Configuration FileResourceDemo
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Node "localhost"
    {
        File DirectoryCopy
        {
            Ensure = "Present" # Ensure the directory is Present on the target node.
            Type = "Directory" # The default is File.
            Recurse = $true # Recursively copy all subdirectories.
            SourcePath = "\\PullServer\DemoSource"
            DestinationPath = "C:\Users\Public\Documents\DSCDemo\DemoDestination"
        }

        Log AfterDirectoryCopy
        {
            # The message below gets written to the Microsoft-Windows-Desired State Configuration/Analytic log
            Message = "Finished running the file resource with ID DirectoryCopy"
            DependsOn = "[File]DirectoryCopy" # Depends on successful execution of the File resource.
        }
    }
}

DSC で資格情報を使用する方法の詳細については、実行ユーザーまたはデータの資格情報の構成に関する記事を参照してください。

DSC ファイルリソース

構文

Properties

共通プロパティ

関連情報

例

フィードバック

その他のリソース

DSC ファイル リソース

構文

Properties

共通プロパティ

関連情報

例

フィードバック

その他のリソース

DSC ファイルリソース