Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 2.43 KB

File metadata and controls

100 lines (66 loc) · 2.43 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spositedesigntask
applicable SharePoint Online
title Get-SPOSiteDesignTask
schema 2.0.0
author samkabue
ms.author speedta
ms.reviewer

Get-SPOSiteDesignTask

SYNOPSIS

Cmdlet to get a scheduled site design script.

SYNTAX

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.

Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WebUrl

Applicable: SharePoint Online

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

Type: System.String
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind

OUTPUTS

System.Object

NOTES

RELATED LINKS

Add-SPOSiteDesignTask

Get-SPOSiteDesignRun

Get-SPOSiteDesignRunStatus