DSC 存档资源

  • 项目

适用于：Windows PowerShell 4.0、Windows PowerShell 5.x

Windows PowerShell Desired State Configuration（DSC）中的存档资源提供了一种在特定路径上解压缩存档（.zip）文件的机制。

注意

此 DSC 资源的本文档介绍 PowerShell 7.2 之前随附的版本。 PSDscResources 模块包含Microsoft正式支持的新的和更新的 DSC 资源。 PowerShell 库中提供了 PSDscResources 模块。

有关详细信息和更新的文档，请参阅 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] ]
}

性能

财产 描述
目的地 指定要确保提取存档内容的位置。
路径 指定存档文件的源路径。
校验和 定义在确定两个文件是否相同时要使用的类型。 如果未指定 校验和，则仅使用文件或目录名称进行比较。 有效值包括：SHA-1、SHA-256、SHA-512、createdDate、modifiedDate。 如果在未 验证的情况下指定 校验和，则配置将失败。
凭据 有权访问指定存档路径和目标的用户帐户的凭据（如果需要）。
力 某些文件操作（例如覆盖文件或删除不为空的目录）将导致错误。 使用 Force 属性将替代此类错误。 默认值为 false。
驗證 使用 校验和 属性来确定存档是否与签名匹配。 如果在未 验证的情况下指定 校验和，则配置将失败。 如果在未 校验和的情况下指定 验证，则默认使用 SHA-256校验和。

通用属性

财产 描述
DependsOn 指示在配置此资源之前，必须运行另一个资源的配置。 例如，如果要首先运行的资源配置脚本块的 ID 为 ResourceName，其类型为 ResourceType，则使用此属性的语法 DependsOn = "[ResourceType]ResourceName"。
确保 确定是否检查存档内容是否存在于 目标。 将此属性设置为 Present，以确保内容存在。 将其设置为 Absent，以确保它们不存在。 默认值为 Present。
PsDscRunAsCredential 设置用于运行整个资源的凭据。

注意

PsDscRunAsCredential common 属性已添加到 WMF 5.0 中，以允许在其他凭据的上下文中运行任何 DSC 资源。 有关详细信息，请参阅 将凭据用于 DSC 资源。

例

以下示例演示如何使用存档资源来确保 Test.zip 的存档文件的内容存在，并在给定的目标使用和授权提取。

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