Functions/Get-OneDriveFileSharingLink.ps1
|
<#
.SYNOPSIS This function gets the sharing link of a file from OneDrive. .DESCRIPTION. This function gets the sharing link of a file from OneDrive. https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createlink?view=odsp-graph-online #> function Get-OneDriveFileSharingLink { [CmdletBinding(PositionalBinding=$false)] [OutputType([String])] param ( # The path of the file on OneDrive. [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$filePath, # The User Principal Name of the user whose OneDrive account the file is from. [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$userPrincipalName, # The MSPComplete Endpoint containing the Microsoft Graph credentials. [Parameter(Mandatory=$true, ParameterSetName="endpoint", ValueFromPipeline=$true)] [ValidateNotNull()] $endpoint, # The Microsoft Graph authentication token. [Parameter(Mandatory=$true, ParameterSetName="token")] [ValidateNotNullOrEmpty()] [String]$token, # The type of sharing link to create. Either view, edit, or embed. Defaults to 'edit'. # BUG # 'view' only works for plain text files like txt and csv files, # but does not prevent the user from editing the files like Excel files. [Parameter(Mandatory=$false)] [ValidateSet("view", "edit", "embed")] [String]$type = "edit", # The scope of link to create. Either anonymous or organization. Defaults to 'anonymous'. [Parameter(Mandatory=$false)] [ValidateSet("anonymous", "organization")] [String]$scope = "anonymous", # Select the stream where the messages will be directed. [Parameter(Mandatory=$false)] [ValidateSet("Information", "Warning", "Error", "None")] [String]$outputStream = "Error" ) # Retrieve the Microsoft Graph authentication token if ($PSCmdlet.ParameterSetName -eq "endpoint") { Write-Information "Retrieving the Microsoft Graph authentication token using the provided endpoint." $token = Get-MicrosoftGraphAuthenticationToken -Endpoint $endpoint if ([String]::IsNullOrWhiteSpace($token)) { Write-OutputMessage "Failed to retrieve the Microsoft Graph authentication token using the provided endpoint." -OutputStream $outputStream -ReturnMessage:$false return $null } } # Set the protocol to TLS 1.2 [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12 # Remove any "\" or "/" at the start of the OneDrive file path if ($filePath.StartsWith("\")) { $filePath = $filePath.TrimStart("\") } if ($filePath.StartsWith("/")) { $filePath = $filePath.TrimStart("/") } # Verify that the file path is valid if ([String]::IsNullOrWhiteSpace($filePath)) { Write-OutputMessage "Failed to retrieve a valid file path from '$($filePath)'." -OutputStream $outputStream -ReturnMessage:$false return $null } # Verify that the UserPrincipalName is valid if (!(Test-EmailAddressValidity -EmailAddress $userPrincipalName)) { Write-OutputMessage "The UserPrincipalName '$($userPrincipalName)' is not valid." -OutputStream $outputStream -ReturnMessage:$false return $null } # Prepare the POST Request $invokeRestMethodParams = @{ Uri = "https://graph.microsoft.com/v1.0/users/$($userPrincipalName)/drive/root:/$($filePath):/createLink" Method = "POST" Headers = @{ Accept = "application/json" Authorization = "Bearer $($token)" "Content-type" = "application/json" } Body = @{ type = $type scope = $scope } | ConvertTo-Json } # Try to retrieve the sharing link of the file on OneDrive Write-Information "Retrieving the sharing link of the file '$($filePath)'." try { $response = Invoke-RestMethod @invokeRestMethodParams } catch { Write-OutputMessage "Exception occurred while retrieving the sharing link of the file '$($filePath)' from OneDrive.`r`n$($_.Exception.Message)" -OutputStream $outputStream -ReturnMessage:$false return $null } # Get the sharing link of the file from the response $sharingLink = $response.link.webUrl if ([String]::IsNullOrWhiteSpace($sharingLink)) { Write-OutputMessage "Failed to retrieve sharing link of the file '$($filePath)'." -OutputStream $outputStream -ReturnMessage:$false return $null } return $sharingLink } |