DSC Archive リソース

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

Windows PowerShell Desired State Configuration (DSC) の Archive リソースは、特定のパスでアーカイブ (.zip) ファイルをアンパックするメカニズムを備えています。

注意

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

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

構文

Archive [string] #ResourceName
{
    Destination = [string]
    Path = [string]
    [ Checksum = [string] { CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 } ]
    [ Credential = [PSCredential] ]
    [ Force = [bool] ]
    [ Validate = [bool] ]
    [ Ensure = [string] { Absent | Present } ]
    [ DependsOn = [string[]] ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Properties

プロパティ	説明
宛先	アーカイブ コンテンツが抽出されることを保証する場所を指定します。
Path	アーカイブ ファイルのソース パスを指定します。
Checksum	2 つのファイルが同じであるかどうかを決定するときに使用するタイプを定義します。 Checksum が指定されていない場合、ファイルまたはディレクトリ名のみが比較に使用されます。 有効な値は、次のとおりです。SHA-1、SHA-256、SHA-512、createdDate、modifiedDate。 Validate を指定せずに Checksum を指定した場合、構成は失敗します。
資格情報	必要に応じて、指定されたアーカイブ パスと宛先にアクセスするためのアクセス許可を持つユーザー アカウントの資格情報。
Force	特定のファイル操作 (ファイルの上書き、空でないディレクトリの削除など) によって、エラーが発生します。 Force プロパティを使用すると、このようなエラーがオーバーライドされます。 既定値は Falseです。
検証	Checksum プロパティを使用して、アーカイブが署名と一致するかどうかを確認します。 Validate を指定せずに Checksum を指定した場合、構成は失敗します。 Checksum を指定せずに Validate を指定した場合、SHA-256チェックサムが既定で使用されます。

共通プロパティ

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

注意

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

例

次の例は、使用されている承認済みの指定した宛先に、Test.zip という名前のアーカイブ ファイルのコンテンツが存在し、抽出され、承認されていることを、Archive リソースを使用して確実にする方法を示しています。

Archive ArchiveExample {
    Ensure = "Present"
    Path = "C:\Users\Public\Documents\Test.zip"
    Destination = "C:\Users\Public\Documents\ExtractionPath"
}