使用PowerShell从SharePoint Online下载文件

时间:2013-09-18 08:08:29

标签: sharepoint powershell-v3.0 csom

我需要使用powershell

从sharepoint在线文档库下载文件

我已经设法达到下载应该发生但没有运气的程度。

我知道它与我如何使用流/编写器

有关

任何提示都将不胜感激

*编辑 在我的本地目录中只有0个长度的文件不会抛出任何错误消息

$SPClient =  [System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Client")
$SPRuntime = [System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Client.Runtime")

$webUrl =  Read-Host -Prompt "HTTPS URL for your SP Online 2013 site" 
$username = Read-Host -Prompt "Email address for logging into that site" 
$password = Read-Host -Prompt "Password for $username" -AsSecureString
$folder = "PoSHTest" 
$destination = "C:\\test"

$ctx = New-Object Microsoft.SharePoint.Client.ClientContext($webUrl) 
$ctx.Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($username, $password)
$web = $ctx.Web
$lists = $web.Lists.GetByTitle($folder)
$query = [Microsoft.SharePoint.Client.CamlQuery]::CreateAllItemsQuery(10000) 
$result = $lists.GetItems($query)
$ctx.Load($Lists)
$ctx.Load($result)
$ctx.ExecuteQuery()

#Edited the foreach as per @JNK
foreach ($File in $result) {
         Write-host "Url: $($File["FileRef"]), title: $($File["FileLeafRef"]) "
        $binary = [Microsoft.SharePoint.Client.File]::OpenBinaryDirect($ctx,$File["FileRef"])
        $Action = [System.IO.FileMode]::Create 
        $new = $destination + "\\" + $File["FileLeafRef"]
        $stream = New-Object System.IO.FileStream $new, $Action 
        $writer = New-Object System.IO.BinaryWriter($stream)
        $writer.write($binary)
        $writer.Close()

}

6 个答案:

答案 0 :(得分:5)

您还可以通过提供WebClient.DownloadFile Method从SharePoint Online下载资源来利用SharePoint Online credentials,如下所示。

先决条件

必须在运行脚本的计算机上安装

SharePoint Online Client Components SDK

如何在PowerShell中的SharePoint Online / O365中下载文件

Download-File.ps1功能:

[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Client")
[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Client.Runtime")


 Function Download-File([string]$UserName, [string]$Password,[string]$FileUrl,[string]$DownloadPath)
 {
    if([string]::IsNullOrEmpty($Password)) {
      $SecurePassword = Read-Host -Prompt "Enter the password" -AsSecureString 
    }
    else {
      $SecurePassword = $Password | ConvertTo-SecureString -AsPlainText -Force
    }
    $fileName = [System.IO.Path]::GetFileName($FileUrl)
    $downloadFilePath = [System.IO.Path]::Combine($DownloadPath,$fileName)


    $client = New-Object System.Net.WebClient 
    $client.Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($UserName, $SecurePassword)
    $client.Headers.Add("X-FORMS_BASED_AUTH_ACCEPTED", "f")
    $client.DownloadFile($FileUrl, $downloadFilePath)
    $client.Dispose()
}

用法

Download-File -UserName "username@contoso.onmicrosoft.com" -Password "passowrd" -FileUrl https://consoto.sharepoint.com/Shared Documents/SharePoint User Guide.docx -DownloadPath "c:\downloads"

答案 1 :(得分:4)

我能够使用以下相关代码段成功下载该文件。你应该能够根据你的情况扩展它。

Add-Type –Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\15\ISAPI\Microsoft.SharePoint.Client.dll"
Add-Type –Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\15\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"
$siteUrl = Read-Host -Prompt "Enter web URL"
$username = Read-Host -Prompt "Enter your username"
$password = Read-Host -Prompt "Enter password" -AsSecureString
$source = "/filepath/sourcefilename.dat" #server relative URL here
$target = "C:/detinationfilename.dat" #URI of the file locally stored

$ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteUrl)
$credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($username, $password)
$ctx.Credentials = $credentials

[Microsoft.SharePoint.Client.FileInformation] $fileInfo = [Microsoft.SharePoint.Client.File]::OpenBinaryDirect($ctx,$source);
[System.IO.FileStream] $writeStream = [System.IO.File]::Open($target,[System.IO.FileMode]::Create);

$fileInfo.Stream.CopyTo($writeStream);
$writeStream.Close();

答案 2 :(得分:3)

虽然上面的CSOM代码可能会起作用,但我发现使用Web客户端方法更容易。

(来自http://soerennielsen.wordpress.com/2013/08/25/use-csom-from-powershell/

我使用下面的代码,将一堆文件(来自CSOM查询的元数据)检索到一个文件夹(使用$ result集合,其他参数应该稍微调整一下):

#$siteUrlString site collection url
#$outPath path to export directory


$siteUri = [Uri]$siteUrlString
$client = new-object System.Net.WebClient
$client.UseDefaultCredentials=$true

if ( -not (Test-Path $outPath) ) {
    New-Item $outPath -Type Directory  | Out-Null
}

$result |% {
    $url = new-object Uri($siteUri, $_["FileRef"])
    $fileName = $_["FileLeafRef"]
    $outFile = Join-Path $outPath $fileName
    Write-Host "Downloading $url to $outFile"

    try{
        $client.DownloadFile( $url, $outFile )      
    }
    catch{
        #one simple retry...
        try{
            $client.DownloadFile( $url, $outFile )      
        }
        catch{
            write-error "Failed to download $url, $_"
        }
    }
}   

这里的诀窍是     的 $ client.UseDefaultCredentials = $真

将为您验证webclient(作为当前用户)。

答案 3 :(得分:1)

所以我放弃了这一点。事实证明,编写SSIS脚本组件来完成工作要容易得多。 我已经授予了Soeren,因为他发布了一些适用于常规网站的代码,但没有使用SharePoint Online。

谢谢Sorean!

答案 4 :(得分:1)

简短的一种从在线共享点下载文件的简单方法,仅使用 powershell 和共享点在线网址 (无 pnp powershell )

此方法也可用于执行 Sharepoint REST 查询,只需使用 powershell 和 sharepoint REST api

# required MS dependencies
# feel free to download them from here https://www.microsoft.com/en-us/download/details.aspx?id=42038

Add-Type -Path 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll' -ErrorAction Stop
Add-Type -Path 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll' -ErrorAction Stop

# prepare passwords
$spCredential = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($user, $(ConvertTo-SecureString -AsPlainText $pass -Force))
    
# prepare and perform rest api query
$Context = New-Object Microsoft.SharePoint.Client.ClientContext($targetSiteUrl)
$Context.Credentials = $spCredential
    try {
        #this may return an error, but still will finish context setup
        $Context.ExecuteQuery()    
    }
    catch {
        write-host "TODO: fix executeQuery() err 400 bug" -ForegroundColor Yellow
    }
$AuthenticationCookie = $Context.Credentials.GetAuthenticationCookie($targetSiteUrl, $true)
    
$WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession
$WebSession.Credentials = $Context.Credentials
$WebSession.Cookies.SetCookies($targetSiteUrl, $AuthenticationCookie)
$WebSession.Headers.Add("Accept", "application/json;odata=verbose")

Invoke-WebRequest  -Uri $spFileUrl -OutFile $outputFilePath -WebSession $WebSession -errorAction Stop

哪里

  • $outputFilePath 是您要保存远程文件的目标输出文件。
  • $targetSiteUrl 是目标 sp 站点 url。
  • $spFileUrl 是“[sharepoint 文件完整网址]”
  • $user 纯文本 sp 用户电子邮件
  • $pass 纯文本 sp 用户密码

答案 5 :(得分:0)

问题的直接和几乎最短的答案很简单:

$url = 'https://the.server/path/to/the/file.txt'
$outfile = "$env:userprofile\file.txt"
Invoke-WebRequest -Uri $url -OutFile $outfile -Credential (Get-Credential)

这至少在Powershell 5.1中起作用......