Expand an archive with SHA-256 file validation and file overwrite allowed
Description
This example shows how you can use the Archive
resource to ensure a .zip
file is expanded to a
specific directory and the expanded contents match the contents in the .zip
file.
With Ensure set to Present
, the Path set to C:\ExampleArchivePath\Archive.zip
, and the
Destination set to C:\ExampleDestinationPath\Destination
, the resource expands the contents of
Archive.zip
to the Destination
folder if they're not already there.
With Validate set to $true
and Checksum set to SHA-256
, the resource compares the SHA256
checksum of every expanded file against the relevant file in Archive.zip
. If the checksum for any
expanded file doesn't match the checksum of that file in Archive.zip
, the resource is out of the
desired state.
With Force set to $true
, the resource overwrites any expanded files with an incorrect
checksum. If Force was set to $false
, the resource would throw an exception instead of
overwriting the files.
With Invoke-DscResource
This script shows how you can use the Archive
resource with the Invoke-DscResource
cmdlet to
ensure Archive.zip
is expanded to the Destination
folder with SHA256 checksum validation.
[CmdletBinding()]
param()
begin {
$SharedParameters = @{
Name = 'Archive'
ModuleName = 'PSDscResource'
Properties = @{
Path = 'C:\ExampleArchivePath\Archive.zip'
Destination = 'C:\ExampleDestinationPath\Destination'
Validate = $true
Force = $true
Ensure = 'Present'
}
}
$NonGetProperties = @(
'Validate'
'Force'
'Ensure'
)
}
process {
$TestResult = Invoke-DscResource -Method Test @SharedParameters
if ($TestResult.InDesiredState) {
$QueryParameters = $SharedParameters.Clone()
foreach ($Property in $NonGetProperties) {
$QueryParameters.Properties.Remove($Property)
}
Invoke-DscResource -Method Get @QueryParameters
} else {
Invoke-DscResource -Method Set @SharedParameters
}
}
With a Configuration
This snippet shows how you can define a Configuration
with an Archive
resource block to ensure
Archive.zip
is expanded to the Destination
folder with SHA256 checksum validation.
Configuration ExpandArchiveDefaultValidationAndForce {
Import-DscResource -ModuleName 'PSDscResources'
Node localhost {
Archive ExampleArchive {
Path = 'C:\ExampleArchivePath\Archive.zip'
Destination = 'C:\ExampleDestinationPath\Destination'
Validate = $true
Force = $true
Ensure = 'Present'
}
}
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for