Get-PnPSiteScriptFromList
SYNOPSIS
Required Permissions
- SharePoint: Access to the SharePoint Tenant Administration site
Generates a Site Script from an existing list
SYNTAX
By List (Default)
Get-PnPSiteScriptFromList -Identity <ListPipeBind> [-Connection <PnPConnection>] [-Verbose]
By Url
Get-PnPSiteScriptFromList -Url <String> [-Connection <PnPConnection>] [-Verbose]
DESCRIPTION
This command allows a Site Script to be generated off of an existing list on your tenant. The script will return the JSON syntax with the definition of the list, including fields, views, content types, and some of the list settings. The script can then be used with Add-PnPSiteScript and Add-PnPListDesign to allow lists with the same configuration as the original list to be created by end users.
EXAMPLES
EXAMPLE 1
Get-PnPSiteScriptFromList -List "MyList"
Returns the generated Site Script JSON from the list "MyList" in the currently connected to site
EXAMPLE 2
Get-PnPList -Identity "MyList" | Get-PnPSiteScriptFromList | Add-PnPSiteScript -Title "MyListScript" | Add-PnPListDesign -Title "MyListDesign"
Returns the generated Site Script JSON from the list "MyList" in the currently connected to site and registers it as a new Site Script with the title "MyListScript" and uses that Site Script to register a new List Design with the title "MyListDesign"
EXAMPLE 3
Get-PnPSiteScriptFromList -Url "https://contoso.sharepoint.com/sites/teamsite/lists/MyList"
Returns the generated Site Script JSON from the list "MyList" at the provided Url
EXAMPLE 4
Get-PnPSiteScriptFromList -Url "https://contoso.sharepoint.com/sites/teamsite/Shared Documents"
Returns the generated Site Script JSON from the default document library at the provided Url
PARAMETERS
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Specifies an instance, Id or, title of the list to generate a Site Script from
Type: ListPipeBind
Parameter Sets: By List
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Url
Specifies the full URL of the list to generate a Site Script from. I.e. https://contoso.sharepoint.com/sites/teamsite/lists/MyList
Type: String
Parameter Sets: By Url
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Verbose
When provided, additional debug statements will be shown while executing the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False