mirror of
https://github.com/admindroid-community/powershell-scripts.git
synced 2025-12-17 16:35:19 +00:00
334 lines
11 KiB
PowerShell
334 lines
11 KiB
PowerShell
|
<#
|
|||
|
|
=============================================================================================
|
|||
|
|
Name: Remove SharePoint Sharing Links using PowerShell
|
|||
|
|
Description: Finds and Removes SharePoint Online files & folders sharing links based on 20+ real time criterias.
|
|||
|
|
Version: 1.0
|
|||
|
|
Website: o365reports.com
|
|||
|
|
|
|||
|
|
~~~~~~~~~~~~~~~~~~
|
|||
|
|
Script Highlights:
|
|||
|
|
~~~~~~~~~~~~~~~~~~
|
|||
|
|
1. Includes report generation to preview links before removal.
|
|||
|
|
2. Removes files & folders' sharing links based on 20+ filtering criteria.
|
|||
|
|
3. Supports removing sharing links by link types: Anonymous, Company, and Specific People links.
|
|||
|
|
4. Allows to revoke sharing permission for- active links, expired links, never expires links, links with expiration, soon-to-expire links.
|
|||
|
|
5. Targets specific SharePoint sites for scoped cleanup actions.
|
|||
|
|
6. Automatically installs the required PnP PowerShell module with your confirmation if it’s missing.
|
|||
|
|
7. Supports authentication using certificate-based login, MFA and non-MFA accounts.
|
|||
|
|
8. It is scheduler-friendly, making it ideal for automating regular audits and link cleanup tasks.
|
|||
|
|
|
|||
|
|
For detailed script execution: https://o365reports.com/2025/07/01/remove-sharing-links-sharepoint-online-powershell/
|
|||
|
|
|
|||
|
|
=============================================================================================
|
|||
|
|
|
|||
|
|
|
|||
|
|
#>
|
|||
|
|
Param
|
|||
|
|
(
|
|||
|
|
[Parameter(Mandatory = $false)]
|
|||
|
|
[string]$AdminName,
|
|||
|
|
[string]$Password,
|
|||
|
|
[String]$ClientId,
|
|||
|
|
[String]$CertificateThumbprint,
|
|||
|
|
[string]$TenantName,
|
|||
|
|
[string]$ImportCsv,
|
|||
|
|
[Switch]$ActiveLinks,
|
|||
|
|
[Switch]$ExpiredLinks,
|
|||
|
|
[Switch]$LinksWithExpiration,
|
|||
|
|
[Switch]$NeverExpiresLinks,
|
|||
|
|
[int]$SoonToExpireInDays,
|
|||
|
|
[Switch]$GetAnyoneLinks,
|
|||
|
|
[Switch]$GetCompanyLinks,
|
|||
|
|
[Switch]$GetSpecificPeopleLinks,
|
|||
|
|
[Switch]$RemoveSharingLinks
|
|||
|
|
)
|
|||
|
|
|
|||
|
|
#Check for module availability
|
|||
|
|
Function Installation-Module
|
|||
|
|
{
|
|||
|
|
$Module = Get-InstalledModule -Name PnP.PowerShell -MinimumVersion 1.12.0 -ErrorAction SilentlyContinue
|
|||
|
|
If($Module -eq $null){
|
|||
|
|
Write-Host SharePoint PnP PowerShell Module is not available -ForegroundColor Yellow
|
|||
|
|
$Confirm = Read-Host Are you sure you want to install module? [Yy] Yes [Nn] No
|
|||
|
|
If($Confirm -match "[yY]")
|
|||
|
|
{
|
|||
|
|
Write-Host "Installing PnP PowerShell module..."
|
|||
|
|
Install-Module PnP.PowerShell -Force -AllowClobber -Scope CurrentUser
|
|||
|
|
Import-Module -Name Pnp.Powershell
|
|||
|
|
}
|
|||
|
|
Else
|
|||
|
|
{
|
|||
|
|
Write-Host PnP PowerShell module is required to connect SharePoint Online.Please install module using Install-Module PnP.PowerShell cmdlet.
|
|||
|
|
Exit
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
Write-Host `nConnecting to SharePoint Online...
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#SPO Site connection
|
|||
|
|
Function Connection-Module
|
|||
|
|
{
|
|||
|
|
param
|
|||
|
|
(
|
|||
|
|
[Parameter(Mandatory = $true)]
|
|||
|
|
[String] $Url
|
|||
|
|
)
|
|||
|
|
if(($AdminName -ne "") -and ($Password -ne "") -and ($ClientId -ne ""))
|
|||
|
|
{
|
|||
|
|
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
|
|||
|
|
$Credential = New-Object System.Management.Automation.PSCredential $AdminName,$SecuredPassword
|
|||
|
|
Connect-PnPOnline -Url $Url -Credential $Credential -ClientId $ClientId
|
|||
|
|
}
|
|||
|
|
elseif($TenantName -ne "" -and $ClientId -ne "" -and $CertificateThumbprint -ne "")
|
|||
|
|
{
|
|||
|
|
Connect-PnPOnline -Url $Url -ClientId $ClientId -Thumbprint $CertificateThumbprint -Tenant "$TenantName.onmicrosoft.com"
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
Connect-PnPOnline -Url $Url -Interactive -ClientId $ClientId
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
Function Get-SharedLinks
|
|||
|
|
{
|
|||
|
|
$ExcludedLists = @("Form Templates","Style Library","Site Assets","Site Pages", "Preservation Hold Library", "Pages", "Images",
|
|||
|
|
"Site Collection Documents", "Site Collection Images")
|
|||
|
|
$DocumentLibraries = Get-PnPList | Where-Object {$_.Hidden -eq $False -and $_.Title -notin $ExcludedLists -and $_.BaseType -eq "DocumentLibrary"}
|
|||
|
|
Foreach($List in $DocumentLibraries){
|
|||
|
|
$ListItems = Get-PnPListItem -List $List -PageSize 2000
|
|||
|
|
ForEach ($Item in $ListItems)
|
|||
|
|
{
|
|||
|
|
$FileName=$Item.FieldValues.FileLeafRef
|
|||
|
|
$ObjectType=$Item.FileSystemObjectType
|
|||
|
|
Write-Progress -Activity ("Site Name: $Site") -Status ("Processing Item: "+ $FileName )
|
|||
|
|
$HasUniquePermissions = Get-PnPProperty -ClientObject $Item -Property HasUniqueRoleAssignments
|
|||
|
|
|
|||
|
|
If ($HasUniquePermissions)
|
|||
|
|
{
|
|||
|
|
$FileUrl=$Item.FieldValues.FileRef
|
|||
|
|
if($ObjectType -eq "File")
|
|||
|
|
{
|
|||
|
|
$FileSharingLinks= Get-PnPFileSharingLink -Identity $FileUrl
|
|||
|
|
}
|
|||
|
|
elseif($ObjectType -eq "Folder")
|
|||
|
|
{
|
|||
|
|
$FileSharingLinks= Get-PnPFolderSharingLink -Folder $FileUrl
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
continue
|
|||
|
|
}
|
|||
|
|
foreach ($FileSharingLink in $FileSharingLinks)
|
|||
|
|
{
|
|||
|
|
$Link=$FileSharingLink.Link
|
|||
|
|
$Scope= $Link.Scope
|
|||
|
|
#Filter links based on it's type
|
|||
|
|
if($GetAnyoneLinks.IsPresent -and ($Scope -ne "Anonymous"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
elseif($GetCompanyLinks.IsPresent -and ($Scope -ne "Organization"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
elseif($GetSpecificPeopleLinks.IsPresent -and ($Scope -ne "Users"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
$Permission=$Link.Type
|
|||
|
|
$SharedLink=$Link.WebUrl
|
|||
|
|
$FileSharingId=$FileSharingLink.Id
|
|||
|
|
$PasswordProtected=$FileSharingLink.HasPassword
|
|||
|
|
$BlockDownload=$Link.PreventsDownload
|
|||
|
|
$RoleList = $FileSharingLink.Roles -join ","
|
|||
|
|
$ExpirationDate=$FileSharingLink.ExpirationDateTime
|
|||
|
|
$Users=$FileSharingLink.GrantedToIdentitiesV2.User.Email
|
|||
|
|
$DirectUsers= $Users -join ","
|
|||
|
|
$CurrentDateTime = (Get-Date).Date
|
|||
|
|
If($ExpirationDate -ne $null)
|
|||
|
|
{
|
|||
|
|
$ExpiryDate = ([DateTime]$ExpirationDate).ToLocalTime()
|
|||
|
|
$ExpiryDays= (New-TimeSpan -Start $CurrentDateTime -End $ExpiryDate).Days
|
|||
|
|
If($ExpiryDate -lt $CurrentDateTime)
|
|||
|
|
{
|
|||
|
|
$LinkStatus = "Expired"
|
|||
|
|
$ExpiryDateCalculation=$ExpiryDays * (-1)
|
|||
|
|
$FriendlyExpiryTime="Expired $ExpiryDateCalculation days ago"
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
$LinkStatus="Active"
|
|||
|
|
$FriendlyExpiryTime="Expires in $ExpiryDays days"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
$LinkStatus="Active"
|
|||
|
|
$ExpiryDays="-"
|
|||
|
|
$ExpiryDate="-"
|
|||
|
|
$FriendlyExpiryTime="Never Expires"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Filter for active links
|
|||
|
|
If(($ActiveLinks.IsPresent) -and ($LinkStatus -ne "Active"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Filter for expired links
|
|||
|
|
elseif(($ExpiredLinks.IsPresent) -and ($LinkStatus -ne "Expired"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Filter for finding links with expiration
|
|||
|
|
elseif(($LinksWithExpiration.IsPresent) -and ($ExpirationDate -eq $null))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Filter for finding links with no expiry
|
|||
|
|
elseif(($NeverExpiresLinks.IsPresent) -and ($FriendlyExpiryTime -ne "Never Expires"))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Filter for finding soon-to-expire links
|
|||
|
|
elseif(($SoonToExpireInDays -ne "") -and (($ExpirationDate -eq $null) -or ($SoonToExpireInDays -lt $ExpiryDays) -or ($ExpiryDays -lt 0)))
|
|||
|
|
{
|
|||
|
|
Continue
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Check for removal sharing links
|
|||
|
|
If($RemoveSharingLinks.IsPresent)
|
|||
|
|
{
|
|||
|
|
if($ObjectType -eq "File")
|
|||
|
|
{
|
|||
|
|
try
|
|||
|
|
{
|
|||
|
|
Remove-PnPFileSharingLink -FileUrl $FileUrl -Identity $FileSharingId -Force
|
|||
|
|
$LinkRemovalStatus="Success"
|
|||
|
|
}
|
|||
|
|
Catch
|
|||
|
|
{
|
|||
|
|
Write-Host $_.Exception.message -ForegroundColor Red
|
|||
|
|
$LinkRemovalStatus="Error occurred"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
elseif($ObjectType -eq "Folder")
|
|||
|
|
{
|
|||
|
|
try
|
|||
|
|
{
|
|||
|
|
Remove-PnPFolderSharingLink -Folder $FileUrl -Identity $FileSharingId -Force
|
|||
|
|
$LinkRemovalStatus="Success"
|
|||
|
|
}
|
|||
|
|
Catch
|
|||
|
|
{
|
|||
|
|
Write-Host $_.Exception.message -ForegroundColor Red
|
|||
|
|
$LinkRemovalStatus="Error occurred"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
$LinkRemovalStatus="No action performed"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
$Results = [PSCustomObject]@{
|
|||
|
|
"Site Name" = $Site
|
|||
|
|
"Library" = $List.Title
|
|||
|
|
"Object Type" =$ObjectType
|
|||
|
|
"File/Folder Name" = $FileName
|
|||
|
|
"File/Folder URL" = $FileUrl
|
|||
|
|
"Link Type" =$Scope
|
|||
|
|
"Access Type" = $Permission
|
|||
|
|
"Roles" =$RoleList
|
|||
|
|
"Users" = $DirectUsers
|
|||
|
|
"File Type" = $Item.FieldValues.File_x0020_Type
|
|||
|
|
"Link Status" = $LinkStatus
|
|||
|
|
"Link Expiry Date" = $ExpiryDate
|
|||
|
|
"Days Since/To Expiry" =$ExpiryDays
|
|||
|
|
"Friendly Expiry Time" =$FriendlyExpiryTime
|
|||
|
|
"Password Protected" =$PasswordProtected
|
|||
|
|
"Block Download" =$BlockDownload
|
|||
|
|
"Shared Link" = $SharedLink
|
|||
|
|
"Link Removal Status" = $LinkRemovalStatus
|
|||
|
|
}
|
|||
|
|
$Results | Export-CSV -path $ReportOutput -NoTypeInformation -Append -Force
|
|||
|
|
$Global:ItemCount++
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
|
|||
|
|
$TimeStamp = Get-Date -Format "yyyy-MM-dd_HH-mm-ss"
|
|||
|
|
$ReportOutput = "$PSScriptRoot\SPO_SharingLinks_Report_ $TimeStamp.csv"
|
|||
|
|
$Global:ItemCount = 0
|
|||
|
|
|
|||
|
|
If($ClientId -eq "")
|
|||
|
|
{
|
|||
|
|
$ClientId= Read-Host "ClientId is required to connect PnP PowerShell. Enter ClientId"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
If($TenantName -eq "")
|
|||
|
|
{
|
|||
|
|
$TenantName = Read-Host "Enter your tenant name (e.g., 'contoso' for 'contoso.onmicrosoft.com')"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Check for CSV input
|
|||
|
|
If($ImportCsv -ne "")
|
|||
|
|
{
|
|||
|
|
$SiteCollections = Import-Csv -Path $ImportCsv
|
|||
|
|
Foreach($Site in $SiteCollections){
|
|||
|
|
$SiteUrl = $Site.SiteUrl
|
|||
|
|
Connection-Module -Url $SiteUrl
|
|||
|
|
$Site = (Get-PnPWeb | Select Title).Title
|
|||
|
|
Get-SharedLinks
|
|||
|
|
|
|||
|
|
|
|||
|
|
Disconnect-PnPOnline -WarningAction SilentlyContinue
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Process all sites
|
|||
|
|
Else
|
|||
|
|
{
|
|||
|
|
Connection-Module -Url "https://$TenantName-admin.sharepoint.com"
|
|||
|
|
$SiteCollections = Get-PnPTenantSite | Where -Property Template -NotIn ("SRCHCEN#0", "REDIRECTSITE#0", "SPSMSITEHOST#0", "APPCATALOG#0", "POINTPUBLISHINGHUB#0", "EDISC#0", "STS#-1")
|
|||
|
|
Disconnect-PnPOnline -WarningAction SilentlyContinue
|
|||
|
|
ForEach($Site in $SiteCollections)
|
|||
|
|
{
|
|||
|
|
$SiteUrl = $Site.Url
|
|||
|
|
Connection-Module -Url $SiteUrl
|
|||
|
|
$Site = (Get-PnPWeb | Select Title).Title
|
|||
|
|
|
|||
|
|
Get-SharedLinks
|
|||
|
|
|
|||
|
|
}
|
|||
|
|
Disconnect-PnPOnline -WarningAction SilentlyContinue
|
|||
|
|
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#Write-Progress -Completed
|
|||
|
|
Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green
|
|||
|
|
Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; Write-Host " to get access to 1800+ Microsoft 365 reports. ~~" -ForegroundColor Green
|
|||
|
|
|
|||
|
|
if((Test-Path -Path $ReportOutput) -eq "True")
|
|||
|
|
{
|
|||
|
|
Write-Host `nThe output file contains $Global:ItemCount sharing links.
|
|||
|
|
Write-Host `n The Output file availble in: -NoNewline -ForegroundColor Yellow
|
|||
|
|
Write-Host $ReportOutput `n
|
|||
|
|
$Prompt = New-Object -ComObject wscript.shell
|
|||
|
|
$UserInput = $Prompt.popup("Do you want to open output file?",`
|
|||
|
|
0,"Open Output File",4)
|
|||
|
|
If ($UserInput -eq 6)
|
|||
|
|
{
|
|||
|
|
Invoke-Item "$ReportOutput"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
else{
|
|||
|
|
Write-Host "No Records Found"
|
|||
|
|
}
|