DSC-Arkiv resurs

  • Artikel
  • 2 minuter för att läsa

Gäller för: Windows PowerShell 4,0, Windows PowerShell 5. x

Arkiv resursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att packa upp arkiv (zip-filer) vid en angiven sökväg.

Anteckning

Den här dokumentationen för den här DSC-resursen omfattar den version som ingår i PowerShell. PSDscResources-modulen innehåller nya och uppdaterade som stöds officiellt av Microsoft. PSDscResources-modulen är tillgänglig från PowerShell-galleriet.

Mer information och uppdaterad dokumentation finns i VIKTIGT i GitHub lagringsplats.

Syntax

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] ]
}

Egenskaper

Egenskap Beskrivning
Mål Anger den plats där du vill se till att Arkiv innehållet extraheras.
Sökväg Anger Arkiv filens käll Sök väg.
Kontrollsumma Definierar den typ som ska användas för att avgöra om två filer är identiska. Om ingen kontroll Summa anges används bara fil-eller katalog namnet för jämförelse. Giltiga värden är: SHA-1 , SHA-256 , SHA-512 , createdDate , modifiedDate . Om du anger kontroll Summa utan att validera, kommer konfigurationen att Miss förklaras .
Autentiseringsuppgift Autentiseringsuppgifterna för ett användar konto med behörighet att komma åt den angivna Arkiv Sök vägen och målet vid behov.
Force Vissa fil åtgärder (till exempel att skriva över en fil eller ta bort en katalog som inte är tom) resulterar i ett fel. Om du använder Force -egenskapen åsidosätts sådana fel. Standardvärdet är false .
Verifiera Använder egenskapen kontroll Summa för att avgöra om arkivet matchar signaturen. Om du anger kontroll Summa utan att validera, kommer konfigurationen att Miss förklaras . Om du anger Verifiera utan kontroll Summa används en SHA-256- kontrollsumma som standard.

Gemensamma egenskaper

Egenskap Beskrivning
DependsOn Anger att konfigurationen av en annan resurs måste köras innan den här resursen har kon figurer ATS. Exempel: om ID: t för skript blocket för resurs konfigurationen som du vill köra först är ResourceName och dess typ är ResourceType, är syntaxen för att använda den här egenskapen DependsOn = "[ResourceType]ResourceName" .
Kontrol Avgör om du ska kontrol lera om arkivets innehåll finns vid målet . Ange att den här egenskapen finns för att se till att innehållet finns. Ange det som frånvarande för att se till att de inte finns. Standardvärdet finns .
PsDscRunAsCredential Anger autentiseringsuppgifter för att köra hela resursen som.

Anteckning

Den gemensamma egenskapen PsDscRunAsCredential har lagts till i WMF 5,0 för att tillåta körning av DSC-resurser i kontexten för andra autentiseringsuppgifter. Mer information finns i använda autentiseringsuppgifter med DSC-resurser.

Exempel

I följande exempel visas hur du använder Arkiv resursen för att se till att innehållet i en arkivfil som heter Test.zip finns och extraheras vid ett angivet mål med och auktoriseras.

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