< Back

Get-RemoteFile

Mon Jan 13, 2020 1:31 am

NAME Get-RemoteFile



SYNOPSIS

Download a file from url using specified proxy settings.





SYNTAX

Get-RemoteFile [[-url] <String>] [[-file] <String>] [[-ProxyLocation] <Uri>] [[-ProxyCredential] <PSCredential>]

[-IgnoreProxy] [<CommonParameters>]





DESCRIPTION

Helper function to Download a file from a given url

using specified proxy settings.





PARAMETERS

-url <String>

URL of the file to download



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-file <String>

File path and name to save the downloaded file to.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProxyLocation <Uri>

Proxy uri to use for the download.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProxyCredential <PSCredential>

Credential to use for authenticating to the proxy.

By default it will try to load cached credentials.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IgnoreProxy [<SwitchParameter>]

Bypass the proxy for this request.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-RemoteFile -Url https://chocolatey.org/api/v2/0.10.8/ -file C:\\chocolatey.zip















RELATED LINKS