DSC アーカイブ リソース

  • [アーティクル]

適用対象: Windows PowerShell 4.0、Windows PowerShell 5.x

Windows PowerShell Desired State Configuration (DSC) のアーカイブ リソースは、アーカイブ (.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] ]
}

プロパティ

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

共通プロパティ

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

手記

PsDscRunAsCredential 共通プロパティが WMF 5.0 に追加され、他の資格情報のコンテキストで DSC リソースを実行できるようになります。 詳細については、「DSC リソースで資格情報を使用する」を参照してください。

例

次の例は、アーカイブ リソースを使用して、Test.zip というアーカイブ ファイルの内容が存在し、特定の宛先で使用および承認されていることを確認する方法を示しています。

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