存档

  • 项目

摘要

展开或删除存档 () .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

可选属性

校验和

指定对存档验证扩展内容时要使用的校验和方法。 如果为校验和验证$false指定值，则资源将引发无效的参数异常。

如果将 Validate 指定为 $true验证， 则校验和 的默认值为 ModifiedDate。

注意

使用 校验和 或 验证 意味着另一个。 尽管可以指定没有校验和的验证，但最佳做法是同时指定这两者。

指定的方法确定资源如何针对存档验证扩展内容：

  • 使用 ModifiedDate时，资源检查每个扩展文件的 LastWriteTime 属性是否与存档中该文件的 LastWriteTime 属性匹配。
  • 使用 CreatedDate时，资源检查每个扩展文件的 CreationTime 属性是否与存档中的该文件的 CreationTime 属性匹配。
  • SHA-256SHA-512资源SHA-1使用指定的 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。

验证时$true，目标处的文件与存档中的文件不匹配：

  • 如果“确保”为Present“和”强制$false“，则资源错误显示一条消息，指出目标上的文件无法覆盖。
  • 如果 Ensure 是且 Force 为$truePresent，则资源将覆盖该文件。
  • 如果 确保 为 Absent，则资源不会删除该文件。
Type: System.Boolean
Default Value: false

示例