Archive
構文
アーカイブ (.zip
) ファイルの内容を展開または削除します。
構文
Archive [String] #ResourceName
{
Destination = [string]
Path = [string]
[Checksum = [string]{ CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 }]
[Credential = [PSCredential]]
[DependsOn = [string[]]]
[Ensure = [string]{ Absent | Present }]
[Force = [bool]]
[PsDscRunAsCredential = [PSCredential]]
[Validate = [bool]]
}
説明
リソース Archive
を使用すると、アーカイブ (.zip
) ファイルの展開された内容をべき等に管理できます。 アーカイブの拡張コンテンツが最新であるか、システムから削除されていることを確認できます。
要件
- System.IO.Compression 型アセンブリは、コンピューターで使用できる必要があります。
- System.IO.Compression.FileSystem 型アセンブリは、コンピューターで使用できる必要があります。
キーのプロパティ
宛先
展開されたコンテンツの書き込み先または削除先のフォルダーへのパスを指定します。
Type: System.String
パス
アーカイブ ファイルへのパスを指定します。
Type: System.String
省略可能なプロパティ
Checksum
アーカイブに対して展開されたコンテンツを検証するときに使用するチェックサム メソッドを指定します。 Checksum と Validate as $false
の値を指定すると、リソースは無効な引数例外をスローします。
[Validate as]\(検証\) を$true
指定した場合、チェックサムの既定値は ModifiedDate
.
注意
Checksum または Validate を使用すると、もう一方が意味します。 チェックサムなしで検証を指定することはできますが、両方を一緒に指定することをお勧めします。
指定したメソッドは、リソースがアーカイブに対して展開されたコンテンツを検証する方法を決定します。
- を指定
ModifiedDate
すると、リソースは、展開された各ファイルの LastWriteTime プロパティがアーカイブ内のそのファイルの LastWriteTime プロパティと一致することを確認します。 - を指定
CreatedDate
すると、リソースは、展開された各ファイルの CreationTime プロパティがアーカイブ内のそのファイルの CreationTime プロパティと一致することを確認します。 SHA-1
を指定した場合SHA-256
、またはSHA-512
リソースは、指定された SHA メソッドを使用して、アーカイブ内のそのファイルのハッシュに対して展開された各ファイルのハッシュを検証します。
Type: System.String
Accepted Values:
- ModifiedDate
- CreatedDate
- SHA-1
- SHA-256
- SHA-512
Default Value: ModifiedDate
資格情報
必要に応じて、指定した パス と 宛先 にアクセスするためのアクセス許可を持つユーザー アカウントの資格情報を指定します。
Type: System.Management.Automation.PSCredential
Default Value: None
Ensure
アーカイブ ファイルの展開されたコンテンツを存在させるかどうかを指定します。 アーカイブを展開するには、このプロパティを次のように Present
指定します。 アーカイブの展開されたコンテンツを削除するには、このプロパティを次のように Absent
指定します。 既定値は Present
です。
Type: System.String
Accepted Values:
- Absent
- Present
Default Value: Present
Force
宛先の既存のコンテンツを上書きするかどうかを指定 します。 Force が指定されている場合、$false
宛先の項目を上書きする必要がある場合にリソース エラーが発生します。 既定値は $false
です。
Type: System.Boolean
Default Value: false
検証
指定したチェックサム メソッドによって展開されたコンテンツを検証するかどうかを指定します。 既定値は $false
です。
Validate が指定$true
されていて、コピー先のファイルがアーカイブ内のファイルと一致しない場合:
- Ensure is
Present
と Force が指定されている場合、$false
転送先のファイルを上書きできないことを示すメッセージが表示されたリソース エラー。 - Ensure is
Present
と Force が指定されている場合、リソースは$true
ファイルを上書きします。 - Ensure が
Absent
指定されている場合、リソースはファイルを削除しません。
Type: System.Boolean
Default Value: false