Skip to content

Get-SPOSiteScriptFromList.md

Latest commit

 

History

History
63 lines (46 loc) · 1.72 KB

Get-SPOSiteScriptFromList.md

File metadata and controls

63 lines (46 loc) · 1.72 KB
external help file sharepointonline.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/sharepoint-online/get-spositescriptfromlist
applicable SharePoint Online
title Get-SPOSiteScriptFromList
schema 2.0.0
author trent-green
ms.author trgreen
ms.reviewer

Get-SPOSiteScriptFromList

SYNOPSIS

Creates site script syntax from an existing SharePoint list.

SYNTAX

Get-SPOSiteScriptFromList -ListUrl <string> [<CommonParameters>]

DESCRIPTION

Uses an existing SharePoint list to output a JSON blob that can be used to create a site script for use in a site design.

EXAMPLES

Example 1

This example creates the site script output from an existing list - and writes it to a variable. This variable is then referenced to create a site script.

$extracted = Get-SPOSiteScriptFromList -ListUrl "https://contoso.sharepoint.com/sites/strategy/customer-contacts"
Add-SPOSiteScript `
    -Title "Contoso Customer Tracker"
    -Description "This creates a customer contact list"
    -Content $extracted

PARAMETERS

-ListUrl

The url of the list to be referenced for the JSON output.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
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.