Edit

Share via

Get-SPOSiteDesignRun

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

Retrieves a list of site designs applied to a specified site collection.

Syntax

Get-SPOSiteDesignRun
   [-WebUrl] <String>
   [[-SiteDesignId] <SPOSiteDesignPipeBind>]
   [<CommonParameters>]

Description

Retrieves a list of site designs applied to a specified site collection. The WebUrl is required to know which site collection to query. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.

Examples

------------ Example 1 --------------------

This example would return a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design.

PS C:\> Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook"

Id: | sean530z-55a3-4804-8b0a-80578626d6ef
SiteDesignId: | sean530b-4133-444e-9e31-fb0c07f69d3a
WebId: | 4f8509cd-7972-44d0-a14a-3c8ad69ee50f
SiteId: | d5d19d7c-sean-4625-9461-281bfc8a9ece
SiteDesignVersion: | 3
SiteDesignTitle: | Contoso Project Playbook

Parameters

-SiteDesignId

The ID of a specific site design. Use this optional parameter if you wish to only return details on a specific site design run.

Type:SPOSiteDesignPipeBind
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WebUrl

The Url of the site collection.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind

Outputs

System.Object