Get various properties of a SharePoint site collection using different PnP Syntaxes.

 My task was to create a report detailing various properties of a SharePoint site collection. Identifying which properties corresponded to specific PowerShell syntax required additional time. 

Ultimately, I developed this script to determine which properties are available in different syntaxes such as PnPTenantSite, PnPSite, and PnPWeb in PnP.Powershell module.

This script has proven to be very useful in understanding the properties. Please adjust the input as per your requirements; I have included all site collections in the tenant. The output is exported into CSV files.

Replace your Azure App ClientID and AdminSiteUrl. When using -Interactive in Connect-PnPOnline, you will see the credentials pop-up a couple of times. I used to keep the SP admin center site logged in on the default browser with same credentials to reduce the number of interactive sessions.

# Define the parameters for the Azure AD app

$clientId = "123456-a789-b123-456c-d78901234"

$AdminSiteUrl = "https://yourtenant-admin.sharepoint.com"

# Connect to SharePoint Online using the Azure AD app credentials

Connect-PnPOnline $AdminSiteUrl -Interactive -ClientId $clientId

# Get all site collections

$siteCollections = Get-PnPTenantSite -Detailed

# Initialize arrays to store properties

$tenantSitePropertiesList = @()

$sitePropertiesList = @()

$webPropertiesList = @()

# Loop through each site collection and get detailed properties

foreach ($site in $siteCollections) {

    $siteUrl = $site.Url

   

    # Connect to each site collection

    Connect-PnPOnline -Url $siteUrl -Interactive -ClientId $clientId

   

    # Get PnPTenantSite properties

    $tenantSiteProperties = Get-PnPTenantSite -Identity $siteUrl

    $tenantSitePropertiesList += $tenantSiteProperties

   

    # Get PnPSite properties

    $siteProperties = Get-PnPSite

    $sitePropertiesList += $siteProperties

   

    # Get PnPWeb properties

    $webProperties = Get-PnPWeb

    $webPropertiesList += $webProperties

}

# Export properties to CSV files

$tenantSitePropertiesList | Export-Csv -Path "D:\PnPTenantSiteProperties.csv" -NoTypeInformation

$sitePropertiesList | Export-Csv -Path "D:\PnPSiteProperties.csv" -NoTypeInformation

$webPropertiesList | Export-Csv -Path "D:\PnPWebProperties.csv" -NoTypeInformation

# Disconnect from SharePoint Online

#Disconnect-PnPOnline

Write-Host "The detailed properties have been exported to PnPTenantSiteProperties.csv,

PnPSiteProperties.csv, and PnPWebProperties.csv."

You can also run this script on a single site collection to obtain the properties. I ran it on all site collections to cross-verify the properties.

Sharepoint PowerShell Modules

 The Microsoft.SharePoint.Client module is part of the SharePoint Online Client Components SDK, which is used to enable development with SharePoint Online. This module allows developers to interact with SharePoint Online using client-side object model (CSOM) APIs. It provides a way to perform various operations on SharePoint Online sites, such as creating and managing lists, libraries, and site collections, as well as handling permissions and workflows[1].

The SharePoint Online Client Components SDK can be downloaded from the official Microsoft Download Center[1]. However, it is recommended to use NuGet packages rather than installing CSOM assemblies to the Global Assembly Cache (GAC)[1].

Additionally, the Microsoft.Online.SharePoint.PowerShell module is another tool that can be used to manage SharePoint Online. It allows administrators to perform tasks such as updating the SharePoint Online Management Shell and managing tenant-level settings[2].

The Microsoft.SharePoint.Client and Microsoft.Online.SharePoint.PowerShell modules serve different purposes and are used in different contexts when working with SharePoint Online.

The Microsoft.SharePoint.Client module is part of the SharePoint Online Client Components SDK. It allows developers to interact with SharePoint Online using client-side object model (CSOM) APIs. This module is primarily used for development purposes, enabling operations such as creating and managing lists, libraries, and site collections, as well as handling permissions and workflows[3].

On the other hand, the Microsoft.Online.SharePoint.PowerShell module is a set of cmdlets specifically designed for SharePoint Online administration. It allows administrators to perform various management tasks, such as updating the SharePoint Online Management Shell and managing tenant-level settings[4]. This module is used within PowerShell to automate administrative tasks and manage SharePoint Online environments more efficiently[5].

In summary, the Microsoft.SharePoint.Client module is geared towards developers for building and interacting with SharePoint Online applications, while the Microsoft.Online.SharePoint.PowerShell module is intended for administrators to manage and configure SharePoint Online environments.

References

[1] Download SharePoint Online Client Components SDK from Official ...

[2] Get started with the SharePoint Online Management Shell

[3] Powershell vs Sharepoint Online Management Shell - Microsoft Community

[4] Hub Site PowerShell: SPO vs PnP | Microsoft Community Hub

[5] Powershell vs Sharepoint Online Management Shell