This module is a wrapper for OneDrive API 2.0.
To use this module, please follow the instructions on the OneDrive authentication and sign-in page.
A temporary application token can be obtained on that page to test this module. If using it permanently, then you can register a new API application:
- Go to https://apps.dev.microsoft.com and log in
- Click on 'Add an app'
- Enter a name - PSOD
- Click on 'Add Platform' > Web
- Tick the 'Allow Implicit Flow' box and enter
http://localhost:8080in the 'Redirect URIs' box - Tick the 'Live SDK support' box at the bottom of the page
- Click Save
- Copy the 'Application Id' at the top of the page and save it in the PSOD module directory in a file called
onedrive.opt
The module uses the Token Flow for authentication and stores the token in a module variable, renewing it once it expires.
The module has a configuration file PSOD.config.json. The configuration is set up for OneDrive personal. It's possible to change the path and item roots if using a non-default drive. Currently, no testing has been done with OneDrive for Business.
The Application Id obtained during setup can be added directly to this file, however to avoid it from being committed to Git, use the onedrive.opt file.
| Function | Alias | Description |
|---|---|---|
Copy-OneDriveItem |
odcp, odcopy |
Copies an item from one path to another. |
Get-OneDriveAuthToken |
Gets an authorization token for the application defined in the PSOD.config.json or onedrive.opt file.By default, onedrive.readwrite permissions are requested. |
|
Get-OneDriveChildItem |
odgci, odls |
Gets all items in the specified Path, or that are children of the specified ItemId. By default, gets items in the default drive's root. |
Get-OneDriveContent |
odgc |
Downloads the contents of an item and saves it to the specified Destination. If no destination is specified, the current directory is used. Can be used with files or folders. If used with a folder, will recreate the folder structure locally. |
Get-OneDriveItem |
odgi |
Gets item (folder/file) details from the OneDrive API. By default gets the default drive's root. Can be used with either a Path, or an ItemId. |
Invoke-OneDriveApiCall |
Wrapper for Invoke-RestMethod to send commands to the OneDrive API. | |
Move-OneDriveItem |
odmv,odmove |
Move an item from one path to another. |
New-OneDriveFolder |
odnf, odmkdir |
Create a new folder in the specified location. Can be used with either a Path, or with a Name and ParentId. If used with path, will recursively create all folders. If folder already exists, returns the item details. |
New-OneDriveToken |
odnt |
Creates a new OneDrive Authentication token from an API response. |
Remove-OneDriveItem |
odrm, oddel |
Deletes the specified item from OneDrive. |
Set-OneDriveContent |
odsc |
Uploads a new file, or updates the contents of an existing file. Currently works with files only. Recursively creates all folders in Path. Add a '/' to the end of the Path if you're uploading to a directory that does not exist; otherwise, the path leaf is used as the remote file name. |
Get-OneDriveItem -Path Documents
# or
odgi 'Documents'will output:
PS> odgi 'Documents'
Path: /drive/root:
Type LastModifiedTime Length Name
---- ---------------- ------ ----
folder 26/08/2016 01:15 54854799 Documents
Get-OneDriveChildItem -Path Documents -Recurse
# or
odgci 'Documents' -rec# Download to the current directory
Get-OneDriveContent -Path "Documents/document.docx"
# Download to a specific directory
Get-OneDriveContent -Path "Documents/document.docx" -Destination "c:\local\dir"
# or
"Documents/document.docx", "Documents/workbook.xlsx" | odgc
# Recursively download an entire directory - same as a file
Get-OneDriveContent -Path "Documents" -Destination "c:\local\dir"Set-OneDriveContent -Path "OneDrive/Remote/Path" -Source "c:\path\to\file.txt"
# or
odsc "OneDrive/Remote/Path" "c:\path\to\file.txt"Note that if the remote directory does not exist, the script will treat the leaf of the Path as the remote file name. So in this example, if 'OneDrive/Remote/Path' does not exist, then the script will create a new file called 'Path' in 'OneDrive/Remote' and upload the contents of file.txt to it. To avoid this, add a '/' to the end of the Path.
$FolderToUpload = 'C:\Temp\Folder1'
$DestinationPath = 'PSOD/Test'
Get-ChildItem $folderToUpload -Recurse -File | % {
$relativePath = Join-Path $DestinationPath $_.FullName.Replace($folderToUpload, '')
Set-OneDriveContent -Path $relativePath -Source $_.FullName
}The local directory structure:
PS> Get-ChildItem $folderToUpload -Recurse -File
Directory: C:\Temp\Folder1
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 17/07/2016 18:48 405935 test1.pdf
-a---- 17/07/2016 18:48 445694 test2.pdf
Directory: C:\Temp\Folder1\Folder2
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 17/07/2016 18:48 405935 test3.pdf
The output from running the upload script:
Path: /drive/root:/PSOD/Test
Type LastModifiedTime Length Name
---- ---------------- ------ ----
file 04/09/2016 15:16 405935 test1.pdf
file 04/09/2016 15:16 445694 test2.pdf
Path: /drive/root:/PSOD/Test/Folder2
Type LastModifiedTime Length Name
---- ---------------- ------ ----
file 04/09/2016 15:16 405935 test3.pdf
Move-OneDriveItem -Path Documents/psod.docx -Destination Documents/PSOD
# or
'Documents/psod.docx' | odmv -Destination Documents/PSODThe tests folder contains Pester tests for all the functions. There is a setup-test.ps1 file that is run before a Describe block to set up the module and helper functions. If testing.bootstrap is set to true in the PSOD.config.json file, then this file also sets up the required folders and dummy files in OneDrive. The test folder structure is:
┬ PSOD
├──┬ odcp
│ ├─── DestinationFolder
│ ├──┬ Folder1
│ │ ├─── doc1.docx
│ │ └─── excel1.xlsx
│ └─── Folder2
├──┬ odgci
│ ├──┬ Subfolder1
│ │ ├──┬ Subfolder2
│ │ │ └─── doc1.docx
│ │ ├─── doc1.docx
│ │ └─── excel1.xlsx
│ ├─── doc1.docx
│ └─── excel1.xlsx
├─── odrm
└─── odsc
Once an Application Id has been obtained, navigate to the tests directory and run Invoke-Pester to ensure that the module is working correctly.
