Table of Contents

Get-PnPSiteDesignTask

SYNOPSIS

Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design task and the URL for the site where the site design is scheduled to be applied.

SYNTAX

Get-PnPSiteDesignTask [-Identity <TenantSiteDesignTaskPipeBind>] [-WebUrl <String>] 
 [-Connection <PnPConnection>] 

DESCRIPTION

Allows to retrieve a scheduled site design script.

EXAMPLES

EXAMPLE 1

Get-PnPSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82

This example retrieves a site design task given the provided site design task id

EXAMPLE 2

Get-PnPSiteDesignTask

This example retrieves all site design tasks currently scheduled on the current site

EXAMPLE 3

Get-PnPSiteDesignTask -WebUrl "https://contoso.sharepoint.com/sites/project"

This example retrieves all site design tasks currently scheduled on the provided site

PARAMETERS

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

The ID of the site design task to retrieve.

Type: TenantSiteDesignTaskPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WebUrl

The URL of the site collection where the site design will be applied. If not specified the site design tasks will be returned for the site you connected to with Connect-PnPOnline.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Microsoft 365 Patterns and Practices