What it works with
Module: PnP.PowerShell
Context: PowerShell 7.4+ · SharePoint Online · PnP.PowerShell
Compatibility: PowerShell 7.4+ is required by current PnP.PowerShell releases.
POWERSHELL / SHAREPOINT
FreeIntermediateRead-onlylow
Export SharePoint hub sites and associations
Exports SharePoint hub sites and their associated sites as one topology report for administration, architecture review and migration preparation.
Generated locally in your browser · Runs in your PowerShell environment · Review before running
What this PowerShell script does
Exports SharePoint hub sites and their associated sites as one topology report for administration, architecture review and migration preparation.
Requirements
- SharePoint admin URL - Example: https://contoso-admin.sharepoint.com
- Entra app client ID - Your PnP app client ID. Leave empty only when a PnP default client ID is already configured.
- CSV output path - Use a new absolute Windows CSV path.
Environment
- Module: PnP.PowerShell
- Runtime: 7.4+
- Authentication: Interactive PnP login with your own Entra app/client ID or configured default
- Permissions: AllSites.Read · SharePoint Administrator
- Risk: Low
Review before you run The generated script is read-only, but authentication and access requirements still apply in your tenant.
OPS / WORKSPACE
Ready to generate
Configure Export SharePoint hub sites and associations in the Builder, review the generated PowerShell and run it in your own environment.
When to use this template
Lists every hub returned by the tenant administration API and its associated sites. Hubs with no associated sites remain visible instead of disappearing from the report.
Important limitations
- Associated-site titles are not fetched with an extra per-site call when the child cmdlet returns only URLs.
- The report describes hub topology, not navigation links or permissions.
- A hub-specific failure is written with Status=ERROR and causes a partial-failure exit after the CSV is saved.
PowerShell and PnP requirements
Current PnP.PowerShell releases require PowerShell 7.4 or later. Interactive authentication requires your own Entra application/client ID, or a default client ID that you have configured for PnP.PowerShell. Opselith does not connect to SharePoint or run the script on your behalf.
Generate the script
- Open the template in the PowerShell Builder.
- Enter the requested URLs, client ID (when needed) and a new CSV output path.
- Generate the script, review its permissions and commands, then run it in your own PowerShell environment.
OPS / SCRIPT DETAILS
Script details
Exports SharePoint hub sites and their associated sites as one topology report for administration, architecture review and migration preparation. Review these details before generating or running the script.
Permissions and impact
Permissions: AllSites.Read · SharePoint Administrator
Risk: Low
Execution impact: Read-only. The script reads SharePoint hub-site metadata and associations and does not change hub registration or site associations.
Parameters
- SharePoint admin URL - Example: https://contoso-admin.sharepoint.com
- Entra app client ID - Your PnP app client ID. Leave empty only when a PnP default client ID is already configured.
- CSV output path - Use a new absolute Windows CSV path.
Output
Output: CSV report with HubId, HubTitle, HubUrl, AssociatedSiteUrl, AssociationStatus, Status and Error.
This template is available in the free library and is generated locally in your browser.
Example use
Exports SharePoint hub sites and their associated sites as one topology report for administration, architecture review and migration preparation.
Enter the required values in the Builder, review the generated script and confirm the output before running it.
Before you run: Use PowerShell 7.4+ with PnP.PowerShell. Sign in to the SharePoint tenant administration site with your own Entra app/client ID (or configured PnP default) and a SharePoint Administrator account. Choose a new CSV output path.
Opselith quality checks
- Included in the current Opselith PowerShell quality suite
- Current PnP.PowerShell runtime and interactive-auth requirements documented
- Hub and child-site cmdlets verified against current PnP documentation
- Per-hub failures are isolated and reported
- Stable CSV output and no artificial pacing inside enumeration loops
Was this useful?One click. No email.