modules/Utilities/private/Copy-FileFromRemoteComputerSMB.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

function Copy-FileFromRemoteComputerSMB {
    <#
    .SYNOPSIS
        Copies an item from one location to another using FromSession
    .PARAMETER Path
        Specifies, as a string array, the path to the items to copy. Wildcard characters are permitted.
    .PARAMETER ComputerName
        Type the NetBIOS name, an IP address, or a fully qualified domain name of the remote computer.
    .PARAMETER Destination
        Specifies the path to the new location. The default is the current directory.
        To rename the item being copied, specify a new name in the value of the Destination parameter.
    .PARAMETER Recurse
        Indicates that this cmdlet does a recursive copy.
    .PARAMETER Force
        Indicates that this cmdlet copies items that can't otherwise be changed, such as copying over a read-only file or alias.
    #>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [System.String[]]$Path,

        [Parameter(Mandatory = $true)]
        [System.String]$ComputerName,

        [Parameter(Mandatory = $false)]
        [System.IO.FileInfo]$Destination = (Get-WorkingDirectory),

        [Parameter(Mandatory = $false, ValueFromPipeline = $false)]
        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential = [System.Management.Automation.PSCredential]::Empty,

        [Parameter(Mandatory = $false)]
        [Switch]$Recurse,

        [Parameter(Mandatory = $false)]
        [Switch]$Force
    )

    $arrayList = [System.Collections.ArrayList]::new()

    # set this to suppress the information status bar from being displayed
    $ProgressPreference = 'SilentlyContinue'

    $testNetConnection = Test-NetConnection -ComputerName $ComputerName -Port 445 -InformationLevel Quiet

    # set this back to default now that Test-NetConnection has completed
    $ProgressPreference = 'Continue'

    if (-NOT ($testNetConnection)) {
        $msg = "Unable to establish TCP connection to {0}:445" -f $ComputerName
        throw New-Object System.Exception($msg)
    }

    foreach ($subPath in $Path) {
        $remotePath = Convert-FileSystemPathToUNC -ComputerName $ComputerName -Path $subPath
        if (-NOT (Test-Path -Path $remotePath)) {
            "Unable to access {0}" -f $remotePath | Trace-Output -Level:Error
        }
        else {
            [void]$arrayList.Add($remotePath)
        }
    }

    foreach ($object in $arrayList) {
        "Copying {0} to {1}" -f $object, $Destination.FullName | Trace-Output
        Copy-Item -Path $object -Destination $Destination.FullName -Force:($Force.IsPresent) -Recurse:($Recurse.IsPresent) -ErrorAction:Continue
    }
}