Merge pull request #2 from 12Knocksinna/Development

Create SPOSitesRetention.ps1

SPOSitesRetention.ps1

@@ -0,0 +1,68 @@
+# A script to display details of the retention policies applying to SharePoint and OneDrive for Business sites in an Office 365 tenant.
+# Uses the Security and Compliance Center PowerShell module
+
+$Report = @()
+$RetentionPolicies = (Get-RetentionCompliancePolicy -ExcludeTeamsPolicy -DistributionDetail | ? {$_.SharePointLocation -ne $Null})
+# Now exclude all the retention policies that publish labels
+$Policies = @()
+ForEach ($P in $RetentionPolicies) {
+      $Rule = Get-RetentionComplianceRule -Policy $P.Name 
+      If ([string]::IsNullOrWhiteSpace($Rule.RetentionDuration) -and [string]::IsNullOrWhiteSpace($Rule.ApplyComplianceTag)) {
+        Write-Host "Policy" $P.Name "publishes retention labels to workloads - excluded from this report" }
+      Else  { 
+       $Policies += $P }
+}  
+# Now we have a cleansed set of retention policies that apply to SharePoint   
+ForEach ($P in $Policies) {
+        $Duration = $Null
+        Write-Host "Processing retention policy" $P.Name
+        $Rule = Get-RetentionComplianceRule -Policy $P.Name 
+        $Settings = "Simple"
+        $Duration = $Rule.RetentionDuration
+        # Check whether a rule is for advanced settings - either a KQL query or sensitive data types
+        If (-not [string]::IsNullOrWhiteSpace($Rule.ContentMatchQuery) -and -not [string]::IsNullOrWhiteSpace($Rule.ContentMatchQuery)) {
+              $Settings = "Advanced/KQL" }
+        Elseif (-not [string]::IsNullOrWhiteSpace($Rule.ContentContainsSensitiveInformation) -and -not [string]::IsNullOrWhiteSpace($Rule.ContentContainsSensitiveInformation)) {
+             $Settings = "Advanced/Sensitive Data" }
+        # Handle retention policy using advanced settings (keyword search or sensitive data type)
+        If ($Rule.RetentionDuration -eq $Null -and $Rule.ApplyComplianceTag -ne $Null) {
+           $Duration = (Get-ComplianceTag -Identity $Rule.ApplyComplianceTag | Select -Expandproperty RetentionDuration) }
+        $RetentionAction = $Rule.RetentionComplianceAction
+        If ([string]::IsNullOrEmpty($RetentionAction)) {
+           $RetentionAction = "Retain" }
+        If ($P.SharePointLocation.Name -eq "All") {
+              $ReportLine = [PSCustomObject][Ordered]@{
+              PolicyName        = $P.Name
+              SiteName          = "All SharePoint Sites"
+              SiteURL           = "All SharePoint Sites"
+              RetentionTime     = $Rule.RetentionDurationDisplayHint
+              RetentionDuration = $Duration
+              RetentionAction   = $RetentionAction 
+              Settings           = $Settings}
+            $Report += $ReportLine } 
+            If ($P.SharePointLocationException -ne $Null) {
+               $Locations = ($P | Select -ExpandProperty SharePointLocationException)
+               ForEach ($L in $Locations) {
+                  $Exception = "*Exclude* " + $L.DisplayName
+                  $ReportLine = [PSCustomObject][Ordered]@{
+                    PolicyName = $P.Name
+                    SiteName   = $Exception
+                    SiteURL    = $L.Name }
+               $Report += $ReportLine }
+        }
+        ElseIf ($P.SharePointLocation.Name -ne "All") {
+           $Locations = ($P | Select -ExpandProperty SharePointLocation)
+           ForEach ($L in $Locations) {
+               $ReportLine = [PSCustomObject][Ordered]@{
+                  PolicyName        = $P.Name
+                  SiteName          = $L.DisplayName
+                  SiteURL           = $L.Name 
+                  RetentionTime     = $Rule.RetentionDurationDisplayHint
+                  RetentionDuration = $Duration
+                  RetentionAction   = $RetentionAction
+                  Settings          = $Settings}
+               $Report += $ReportLine  }                    
+          }
+}
+$Report | Sort SiteName| Format-Table PolicyName, SiteName, RetentionDuration, RetentionAction, Settings -AutoSize
+