Ресурс архива DSC

Область применения: Windows PowerShell 4.0, Windows PowerShell 5.x

Ресурс архива в Windows PowerShell Desired State Configuration (DSC) предоставляет механизм распаковки файлов (.zip) по определенному пути.

Заметка

Эта документация по этому ресурсу DSC охватывает версию, включенную в PowerShell до версии 7.2. Модуль PSDscResources содержит новые и обновленные ресурсы DSC, которые официально поддерживаются корпорацией Майкрософт. Модуль PSDscResources доступен из коллекции PowerShell.

Дополнительные сведения и обновленную документацию см. в справочной документации 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, созданная, измененная. Если указать контрольной суммы без Проверить, конфигурация завершится ошибкой.
Мандат	Учетные данные учетной записи пользователя с разрешениями на доступ к указанному пути архива и назначению при необходимости.
Сила	Некоторые операции с файлами (например, перезапись файла или удаление каталога, который не пуст) приведет к ошибке. При использовании свойства Force переопределяется такие ошибки. Значение по умолчанию — False.
Обосновывать	Использует свойство Контрольная сумма, чтобы определить, соответствует ли архив сигнатуре. Если указать контрольной суммы без Проверить, конфигурация завершится ошибкой. Если указать Проверить без Контрольная сумма, по умолчанию используется SHA-256Контрольная сумма.

Общие свойства

Свойство	Описание
DependsOn	Указывает, что конфигурация другого ресурса должна выполняться перед настройкой этого ресурса. Например, если идентификатор блока скрипта конфигурации ресурсов, который вы хотите запустить сначала, — ResourceName, а его тип — ResourceType, синтаксис для использования этого свойства DependsOn = "[ResourceType]ResourceName".
Обеспечивать	Определяет, существует ли содержимое архива в назначения. Задайте для этого свойства значение Present, чтобы убедиться, что содержимое существует. Установите для него значение Отсутствующие, чтобы убедиться, что они не существуют. Значение по умолчанию — Present.
PsDscRunAsCredential	Задает учетные данные для запуска всего ресурса как.

Заметка

PsDscRunAsCredential общее свойство было добавлено в WMF 5.0, чтобы разрешить запуск любого ресурса DSC в контексте других учетных данных. Дополнительные сведения см. в разделе Использование учетных данных сресурсов DSC.

Пример

В следующем примере показано, как использовать ресурс архива, чтобы убедиться, что содержимое архивного файла, называемого Test.zip, существует и извлекается в заданном месте назначения с помощью и авторизовано.

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