Recurso de archivo de DSC

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.x

El recurso Archive en La configuración de estado deseado (DSC) de Windows PowerShell proporciona un mecanismo para desempaquetar archivos de archivo (.zip) en una ruta de acceso específica.

Nota

Esta documentación de este recurso de DSC trata la versión que se incluye con PowerShell antes de la versión 7.2. El módulo psDscResources de contiene recursos de DSC nuevos y actualizados que microsoft admite oficialmente. El módulo de PSDscResources está disponible en la Galería de PowerShell.

Para obtener más información y documentación actualizada, consulte la documentación de referencia de PSDscResources.

Sintaxis

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

Propiedades

Propiedad	Descripción
Destino	Especifica la ubicación en la que desea asegurarse de que se extraiga el contenido del archivo.
Camino	Especifica la ruta de acceso de origen del archivo de archivo.
Checksum	Define el tipo que se va a usar al determinar si dos archivos son los mismos. Si no se especifica checksum, solo se usa el nombre de archivo o directorio para la comparación. Los valores válidos incluyen: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Si especifica de suma de comprobación sin Validar, se producirá un error en la configuración.
Credencial	Credencial de una cuenta de usuario con permisos para acceder a la ruta de acceso de archivo y el destino especificados si es necesario.
Fuerza	Ciertas operaciones de archivo (como sobrescribir un archivo o eliminar un directorio que no está vacío) producirán un error. El uso de la propiedad Force invalida estos errores. El valor predeterminado es False.
Validar	Usa la propiedad checksum de para determinar si el archivo coincide con la firma. Si especifica de suma de comprobación sin Validar, se producirá un error en la configuración. Si especifica Validate sin Checksum, se usa de forma predeterminada un SHA-256Checksum.

Propiedades comunes

Propiedad	Descripción
DependsOn	Indica que la configuración de otro recurso debe ejecutarse antes de configurar este recurso. Por ejemplo, si el identificador del bloque de script de configuración de recursos que desea ejecutar primero es ResourceName y su tipo es ResourceType, la sintaxis para usar esta propiedad es DependsOn = "[ResourceType]ResourceName".
Asegurar	Determina si se debe comprobar si el contenido del archivo existe en el Destino. Establezca esta propiedad en Presente para asegurarse de que el contenido existe. Establézcalo en absent para asegurarse de que no existen. El valor predeterminado es Present.
PsDscRunAsCredential	Establece la credencial para ejecutar todo el recurso como.

Nota

El psDscRunAsCredential propiedad común se agregó en WMF 5.0 para permitir la ejecución de cualquier recurso de DSC en el contexto de otras credenciales. Para obtener más información, consulte Usar credenciales con recursos de DSC.

Ejemplo

En el ejemplo siguiente se muestra cómo usar el recurso Archive para asegurarse de que el contenido de un archivo denominado Test.zip existen y se extraen en un destino determinado mediante y autorizado.

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