PowerShell – Get all SharePoint pages in a site collection

Alex Ø. T. Hansen

04/12/2018

PowerShell – Get all SharePoint pages in a site collection

If you need to get all pages (.aspx) within a site collection, I have created a small script. The script enumerates through a site collection (sub-sites included) and retrieves all .aspx pages.
Before executing the script there are some requirements:

You need to be administrator on the site collection.
Install the PnP PowerShell module for SharePoint (the script was tested with SharePoint Online).

There are 3 variables you need to modify on line 32 (site collection URL), 33 (SharePoint root URL), 34 (username) and 35 (password).
The script will generate a report (when finished) on the desktop of the user running the script containing the URL, author and last modified date of the page.

#requires -version 3
<#
.SYNOPSIS
  .

.DESCRIPTION
  .

.NOTES
  Version:        1.0
  Author:         Alex Ø. T. Hansen (ath@tofte-it.dk)
  Creation Date:  03-12-2018
  Purpose/Change: Initial script development
#>

#region begin boostrap
############### Bootstrap - Start ###############

#Clear the screen.
Clear-Host;

#Import module.
Import-Module SharePointPnPPowerShellOnline;

############### Bootstrap - End ###############
#endregion

#region begin input
############### Input - Start ###############

#SharePoint Online.
$SPOServiceUrl = "https://contoso.sharepoint.com/sites/somesite";
$SPOServiceRootUrl = "https://contoso.sharepoint.com";
$SPOServiceUsername = "myuser@contoso.com";
$SPOServicePassword = "<Password goes here>";

#Files.
$Files = @{
    "Report" = "C:\Users\$($env:USERNAME)\Desktop\Pages.csv";
};

############### Input - End ###############
#endregion

#region begin functions
############### Functions - Start ###############

#Creates a PS credential object.
Function Create-PSCredential
{
    [cmdletbinding()]	
		
    Param
    (
        [Parameter(Mandatory=$true, HelpMessage="Please provide a valid username, example 'Domain\Username'.")]$Username,
        [Parameter(Mandatory=$true, HelpMessage="Please provide a valid password, example 'MyPassw0rd!'.")]$Password
    )
 
    #Convert the password to a secure string.
    $SecurePassword = $Password | ConvertTo-SecureString -AsPlainText -Force;
 
    #Convert $Username and $SecurePassword to a credential object.
    $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Username,$SecurePassword;
 
    #Return the credential object.
    Return $Credential;
}

#Get all .ASPX pages.
Function Get-SPSitePages
{
    [cmdletbinding()]	
		
    Param
    (
        [Parameter(Mandatory=$true)]$Session,
        [Parameter(Mandatory=$true)]$RootURL,
        [Parameter(Mandatory=$true)][ValidateSet("Yes","No")]$Subsite
    )

    #Object array.
    $Pages = @();

    #Get all lists.
    $Lists = Get-PnPList -Connection $Session;

    #Foreach lists.
    Foreach($List in $Lists)
    {
        #Get all list items.
        $ListItems = Get-PnPListItem -Connection $Session -List $List.Title;

        #If there is any list items.
        If($ListItems)
        {
            #Foreach list item.
            Foreach($ListItem in $ListItems)
            {
                #If the site is a .ASPX site.
                If($ListItem.FieldValues.File_x0020_Type -eq "aspx")
                {
                    #Create new object.
                    $Page = New-Object -TypeName PSObject;

                    #Add data to the object.
                    Add-Member -InputObject $Page -MemberType NoteProperty -Name Url -Value ($RootURL + $ListItem.FieldValues.FileRef);
                    Add-Member -InputObject $Page -MemberType NoteProperty -Name Author -Value ($ListItem.FieldValues.Author.LookupValue);
                    Add-Member -InputObject $Page -MemberType NoteProperty -Name LastModified -Value (($ListItem.FieldValues.Modified).ToString());
                    Add-Member -InputObject $Page -MemberType NoteProperty -Name Subsite -Value ($Subsite);

                    #Add object to array.
                    $Pages += $Page;
                }
            }
        }
    }

    #Return pages.
    Return $Pages;
}

#Write to the console.
Function Write-Console
{
    [cmdletbinding()]	
		
    Param
    (
        [Parameter(Mandatory=$false)][string]$Category,
        [Parameter(Mandatory=$false)][string]$Text
    )
 
    #If the input is empty.
    If([string]::IsNullOrEmpty($Text))
    {
        $Text = " ";
    }
 
    #If category is not present.
    If([string]::IsNullOrEmpty($Category))
    {
        #Write to the console.
        Write-Output("[" + (Get-Date).ToString("dd/MM-yyyy HH:mm:ss") + "]: " + $Text + ".");
    }
    Else
    {
        #Write to the console.
        Write-Output("[" + (Get-Date).ToString("dd/MM-yyyy HH:mm:ss") + "][" + $Category + "]: " + $Text + ".");
    }
}

############### Functions - End ###############
#endregion

#region begin main
############### Main - Start ###############

#Connect to the SharePoint environment.
Write-Console -Text ("Connecting to the SharePoint site '" + $SPOServiceUrl + "'");
$PNPSession = Connect-PNPOnline -Url $SPOServiceUrl -Credentials (Create-PSCredential -Username $SPOServiceUsername -Password $SPOServicePassword) -ReturnConnection;

#Object array.
$Pages = @();

#Get all pages.
Write-Console -Text ("Getting pages (.aspx) from '" + $SPOServiceUrl + "', please wait");
$Pages += Get-SPSitePages -Session $PNPSession -Subsite No -RootURL $RootURL;

#Get all subsites.
$Subsites = Get-PnPSubWebs -Recurse -Connection $PNPSession;

#Foreach subsite.
Foreach($Subsite in $Subsites)
{
    #Connect to the SharePoint subsite.
    Write-Console -Text ("Connecting to the SharePoint subsite '" + $RootURL + $Subsite.ServerRelativeUrl + "'");
    $PNPSessionSubsite = Connect-PNPOnline -Url ($RootURL + $Subsite.ServerRelativeUrl) -Credentials (Create-PSCredential -Username $SPOServiceUsername -Password $SPOServicePassword) -ReturnConnection;

    #Get all pages.
    Write-Console -Text ("Getting pages (.aspx) from '" + ($RootURL + $Subsite.ServerRelativeUrl) + "', please wait");
    $Pages += Get-SPSitePages -Session $PNPSessionSubsite -Subsite Yes -RootURL $RootURL;
}

#Export to the .CSV file.
$Pages | Export-Csv -Path $Files.Report -Encoding UTF8 -Delimiter ";" -NoTypeInformation;

############### Main - End ###############
#endregion

#region begin finalize
############### Finalize - Start ###############

#Disconnect the PowerShell session.
Disconnect-PnPOnline -Connection $PNPSession;
Disconnect-PnPOnline -Connection $PNPSessionSubsite;

############### Finalize - End ###############
#endregion

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

#requires -version 3

.SYNOPSIS

.DESCRIPTION

.NOTES

Version: 1.0

Author: Alex Ø. T. Hansen (ath@tofte-it.dk)

Creation Date: 03-12-2018

Purpose/Change: Initial script development

#region begin boostrap

############### Bootstrap - Start ###############

#Clear the screen.

Clear-Host;

#Import module.

Import-Module SharePointPnPPowerShellOnline;

############### Bootstrap - End ###############

#endregion

#region begin input

############### Input - Start ###############

#SharePoint Online.

$SPOServiceUrl = "https://contoso.sharepoint.com/sites/somesite";

$SPOServiceRootUrl = "https://contoso.sharepoint.com";

$SPOServiceUsername = "myuser@contoso.com";

$SPOServicePassword = "<Password goes here>";

#Files.

$Files = @{

"Report" = "C:\Users\$($env:USERNAME)\Desktop\Pages.csv";

};

############### Input - End ###############

#endregion

#region begin functions

############### Functions - Start ###############

#Creates a PS credential object.

Function Create-PSCredential

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$true, HelpMessage="Please provide a valid username, example 'Domain\Username'.")]$Username,

[Parameter(Mandatory=$true, HelpMessage="Please provide a valid password, example 'MyPassw0rd!'.")]$Password

)

#Convert the password to a secure string.

$SecurePassword = $Password | ConvertTo-SecureString -AsPlainText -Force;

#Convert $Username and $SecurePassword to a credential object.

$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Username,$SecurePassword;

#Return the credential object.

Return $Credential;

}

#Get all .ASPX pages.

Function Get-SPSitePages

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$true)]$Session,

[Parameter(Mandatory=$true)]$RootURL,

[Parameter(Mandatory=$true)][ValidateSet("Yes","No")]$Subsite

)

#Object array.

$Pages = @();

#Get all lists.

$Lists = Get-PnPList -Connection $Session;

#Foreach lists.

Foreach($List in $Lists)

{

#Get all list items.

$ListItems = Get-PnPListItem -Connection $Session -List $List.Title;

#If there is any list items.

If($ListItems)

{

#Foreach list item.

Foreach($ListItem in $ListItems)

{

#If the site is a .ASPX site.

If($ListItem.FieldValues.File_x0020_Type -eq "aspx")

{

#Create new object.

$Page = New-Object -TypeName PSObject;

#Add data to the object.

Add-Member -InputObject $Page -MemberType NoteProperty -Name Url -Value ($RootURL + $ListItem.FieldValues.FileRef);

Add-Member -InputObject $Page -MemberType NoteProperty -Name Author -Value ($ListItem.FieldValues.Author.LookupValue);

Add-Member -InputObject $Page -MemberType NoteProperty -Name LastModified -Value (($ListItem.FieldValues.Modified).ToString());

Add-Member -InputObject $Page -MemberType NoteProperty -Name Subsite -Value ($Subsite);

#Add object to array.

$Pages += $Page;

}

#Return pages.

Return $Pages;

}

#Write to the console.

Function Write-Console

{

[cmdletbinding()]

Param

(

[Parameter(Mandatory=$false)][string]$Category,

[Parameter(Mandatory=$false)][string]$Text

)

#If the input is empty.

If([string]::IsNullOrEmpty($Text))

{

$Text = " ";

}

#If category is not present.

If([string]::IsNullOrEmpty($Category))

{

#Write to the console.

Write-Output("[" + (Get-Date).ToString("dd/MM-yyyy HH:mm:ss") + "]: " + $Text + ".");

}

Else

{

#Write to the console.

Write-Output("[" + (Get-Date).ToString("dd/MM-yyyy HH:mm:ss") + "][" + $Category + "]: " + $Text + ".");

}

############### Functions - End ###############

#endregion

#region begin main

############### Main - Start ###############

#Connect to the SharePoint environment.

Write-Console -Text ("Connecting to the SharePoint site '" + $SPOServiceUrl + "'");

$PNPSession = Connect-PNPOnline -Url $SPOServiceUrl -Credentials (Create-PSCredential -Username $SPOServiceUsername -Password $SPOServicePassword) -ReturnConnection;

#Object array.

$Pages = @();

#Get all pages.

Write-Console -Text ("Getting pages (.aspx) from '" + $SPOServiceUrl + "', please wait");

$Pages += Get-SPSitePages -Session $PNPSession -Subsite No -RootURL $RootURL;

#Get all subsites.

$Subsites = Get-PnPSubWebs -Recurse -Connection $PNPSession;

#Foreach subsite.

Foreach($Subsite in $Subsites)

{

#Connect to the SharePoint subsite.

Write-Console -Text ("Connecting to the SharePoint subsite '" + $RootURL + $Subsite.ServerRelativeUrl + "'");

$PNPSessionSubsite = Connect-PNPOnline -Url ($RootURL + $Subsite.ServerRelativeUrl) -Credentials (Create-PSCredential -Username $SPOServiceUsername -Password $SPOServicePassword) -ReturnConnection;

#Get all pages.

Write-Console -Text ("Getting pages (.aspx) from '" + ($RootURL + $Subsite.ServerRelativeUrl) + "', please wait");

$Pages += Get-SPSitePages -Session $PNPSessionSubsite -Subsite Yes -RootURL $RootURL;

}

#Export to the .CSV file.

$Pages | Export-Csv -Path $Files.Report -Encoding UTF8 -Delimiter ";" -NoTypeInformation;

############### Main - End ###############

#endregion

#region begin finalize

############### Finalize - Start ###############

#Disconnect the PowerShell session.

Disconnect-PnPOnline -Connection $PNPSession;

Disconnect-PnPOnline -Connection $PNPSessionSubsite;

############### Finalize - End ###############

#endregion

About Alex Ø. T. Hansen

Experienced advanced operations engineer with a demonstrated history of working in the information technology and services industry. Skilled in Windows Server, Azure, Ethical Hacking, Office 365, Exchange, Jenkins, SCCM, Octopus Deploy and PowerShell to name a few. Strong engineering professional with a big passion for knowledge.

2 Comments

Shahbaz Kazi

11/09/2024 at 11:27

Please suggest if this script work in sharepoint on premises. I want to collect the same this.
If yes, what command i need to change or add.
Please reply and suggest

1. Alex Ø. T. Hansen
  
  11/09/2024 at 11:30
  
  Not sure. I think it may need some adjustment

PowerShell – Get all SharePoint pages in a site collection

2 Comments

Leave a Reply Cancel reply