Edit

Share via


Get-SPOSiteDesignTask

Cmdlet to get a scheduled site design script.

Syntax

Default (Default)

Get-SPOSiteDesignTask
    [[-Identity] <SPOSiteDesignTaskPipeBind>]
    [[-WebUrl] <String>]
    [<CommonParameters>]

Description

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

Note

This command only retrieves a previously scheduled request.

Examples

EXAMPLE 1

Get-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome"

This example returns a scheduled site design whose ID is 501z8c32-4147-44d4-8607-26c2f67cae82 and which was applied on the site https://contoso.sharepoint.com/sites/projectawesome.

Parameters

-Identity

Applicable: SharePoint Online

The ID of the scheduled site design to apply.

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WebUrl

Applicable: SharePoint Online

The URL of the site collection where the site design will be applied.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind

Outputs

System.Object