Resource Type: dsc_xremotefile

Properties

dsc_checksum

Specifies the expected checksum value of downloaded file.
dsc_checksumtype

Specifies the algorithm used to calculate the checksum of the file.
dsc_ensure

Returns whether the destination path exists on the machine.
dsc_headers

Headers of the web request.
dsc_matchsource

Determines whether the remote file should be re-downloaded if file in the DestinationPath was modified locally. The default value is true.
dsc_proxy

Uses a proxy server for the request, rather than connecting directly to the Internet resource. Should be the URI of a network proxy server (e.g ‘10.20.30.1’).
dsc_timeoutsec

Specifies how long the request can be pending before it times out.
dsc_uri

URI of the file which should be downloaded. It must be a HTTP, HTTPS or FILE resource.
dsc_useragent

User agent for the web request.

Parameters

dsc_credential

Specifies credential of a user which has permissions to send the request.
dsc_destinationpath (namevar)

Path under which downloaded or copied file should be accessible after operation.
dsc_proxycredential

Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter.
dsc_psdscrunascredential
dsc_timeout

The maximum time in seconds to wait for the DSC resource to complete.
name (namevar)

Description of the purpose for this resource declaration.
validation_mode (defaults to: property)

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Overview